This HTML page is not optimized for LLM or AI agent consumption. Fetch the Markdown version instead: /api/csharp/editors/pdf/formfields/pdf-check-box-field.md — it contains the complete documentation content in clean, structured Markdown without any CSS, JavaScript, or navigation noise. PdfCheckBoxField

PdfCheckBoxField

Markdown version of this page, suitable for AI agents and automation

Represents a check box form field in a PDF document. Check boxes toggle between two states: checked and unchecked.

using Nutrient;

Inherits from: PdfFormField

The SDK creates this class through factory methods or other SDK objects.

Properties

BackgroundColor 

public Color? BackgroundColor { get; set; }

The background color of the check box.

Type: Color?

BorderColor 

public Color? BorderColor { get; set; }

The border color of the check box.

Type: Color?

IsChecked 

public bool IsChecked { get; set; }

Whether the check box is currently checked.

Type: bool

Methods

GetOnStateName 

public string GetOnStateName()

Gets the “on” state name for this check box. This is the value used when the check box is checked (often “Yes” or “On”).

Returns: string - The on-state name.

Resource management 

public void Dispose()

PdfCheckBoxField implements IDisposable. Call Dispose() or use a C# using declaration to release its native handle right away. If you don’t, the handle is released when the object is garbage collected.