Skip to main content
All docs
V26.1
  • CheckBoxField Members

    A checkbox form field that allows users to select or clear an option in a PDF document.

    Constructors

    Name Description
    CheckBoxField(String) Initializes a new instance of the CheckBoxField class with specified settings.

    Properties

    Name Description
    Actions Gets or sets actions associated with the form field. Inherited from FormField.
    AlternateName Gets or sets an alternate name of the form field. Inherited from FormField.
    Checked Gets or sets a value that indicates whether the checkbox is selected.
    Name Gets or sets the name of the form field. Inherited from FormField.
    OnStateValue Gets or sets the string value that defines the “On” state of the checkbox. For example, “Yes”, “On”, “True”, and so on.
    ReadOnly Gets or sets a value that indicates whether the form field is read-only. Inherited from FormField.
    Required Gets or sets a value that indicates whether the form field is required. Inherited from FormField.
    ShouldGeneratePressedAppearance Specifies whether to generate a down appearance that appears in a checkbox when the mouse button is pressed within the checkbox area.
    Value Gets or sets the state of the check box field as a string value.

    Methods

    Name Description
    Clone() Creates a copy of the FormField object. Inherited from FormField.
    Clone(DocumentCloneContext) Creates a copy of the FormField object. Inherited from FormField.
    Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
    Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
    GetHashCode() Serves as the default hash function. Inherited from Object.
    GetType() Gets the Type of the current instance. Inherited from Object.
    MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
    ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
    ToString() Returns a string that represents the current object. Inherited from Object.
    See Also