PdfAcroFormFacade.GetCheckBoxFormField(String) Method

Gets a specific check box form field’s properties.

Namespace : DevExpress.Pdf

Assembly : DevExpress.Pdf.v25.2.Core.dll

NuGet Package : DevExpress.Pdf.Core

Declaration

• C#
• VB.NET

public PdfCheckBoxFormFieldFacade GetCheckBoxFormField(
    string fullName
)

Public Function GetCheckBoxFormField(
    fullName As String
) As PdfCheckBoxFormFieldFacade

Parameters

A form field’s name.

|

Returns

An object that contains the form field’s properties.

|

Remarks

The PdfCheckBoxFormFieldFacade object contains form field and widget properties without access to the form field’s inner structure. Use the Widgets property to get the form field widget annotation settings.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetCheckBoxFormField(String) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

• C#
• VB.NET

pdf-document-api-get-checked-appearance-name-for-check-box/CS/GetCheckboxCheckedValue/Program.cs#L19

// Obtain the check box form field:
PdfCheckBoxFormFieldFacade genderField = acroForm.GetCheckBoxFormField("Female");

pdf-document-api-fill-interactive-form-fields/CS/PdfFormFilling/PdfFormFilling.cs#L71

PdfCheckBoxFormFieldFacade checkField = acroForm.GetCheckBoxFormField("Check");
checkField.IsChecked = true;

pdf-document-api-get-checked-appearance-name-for-check-box/VB/GetCheckboxCheckedValue/Program.vb#L14

' Obtain the check box form field:
Dim genderField As PdfCheckBoxFormFieldFacade = acroForm.GetCheckBoxFormField("Female")
' Specify a checked value for the Female form field:

pdf-document-api-fill-interactive-form-fields/VB/PdfFormFilling/PdfFormFilling.vb#L65

Dim checkField As PdfCheckBoxFormFieldFacade = acroForm.GetCheckBoxFormField("Check")
checkField.IsChecked = True

See Also

PdfAcroFormFacade Class

PdfAcroFormFacade Members

DevExpress.Pdf Namespace