GrapeCity.Documents.Pdf.AcroForms.CheckBoxField

CheckBoxField Class

Represents CheckBox AcroForm field.

CheckBoxField

public class CheckBoxField : Field, IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef

Public Class CheckBoxField
    Inherits Field
    Implements IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef

Name	Description
CheckBoxField()	Initializes a new instance of the CheckBoxField class.

Name	Description
Checked	Gets or sets the value of this CheckBoxField as a Boolean value. See ValueObj for details.
DefaultChecked	Gets or sets the default value of this CheckBoxField as a Boolean value. See ValueObj for details.
DefaultValue	Gets or sets the default value of this CheckBoxField.
DefaultValueObj	Gets or sets the default value of this CheckBoxField. See ValueObj for details.
Opt	Gets or sets an array of strings containing one entry for each widget annotation. defining export values for its constituent check boxes. See the PDF spec for details.
Value	Gets or sets the value of this CheckBoxField.
ValueObj	Gets or sets the object value of this checkbox field. Gets false if none of the associated widgets is checked. Otherwise gets true if all widgets use the same name for the checked appearance stream, or the name of the appearance stream that is used to display the checked state. When set, if a Boolean value is specified, it is assigned as is to the checked state. If the assigned value is not a Boolean, it is converted to string and is interpreted as the name of the widget's appearance stream used to show the widget's checked state. If no such stream exists, the checkbox will show as unchecked.
Widget	Gets the WidgetAnnotation defining view properties of the CheckBoxField.

Name	Description
GetCheckedAppearanceStreamName(WidgetAnnotation)	Gets the name of a widget annotation's appearance stream that is used to display the widget in checked state. In Acrobat this name is specified as "Export Value" option in the Check Box field properties.
GetCheckedAppearanceStreamNames()	Gets the names of appearance streams of the widget annotations associated with this field that are used to display the widgets in checked state. In Acrobat these names are specified as "Export Value" option in the Check Box field properties.
HasRadioButtonBehavior()	Checks whether this CheckBoxField actually behaves as a RadioButtonField. This situation takes place if the checkbox field owns more than one WidgetAnnotations, and the widgets' appearance streams used to show checked state have different names.
SetCheckedAppearanceStreamName(WidgetAnnotation, string)	Sets the name of a widget annotation's appearance stream that will be used to display the widget in checked state. In Acrobat this name is specified as "Export Value" option in the Check Box field properties.
SetCheckedAppearanceStreamNames(string)	Sets the name of an appearance stream that will be used by the widget annotations associated with this field to display the widgets in checked state. In Acrobat this name is specified as "Export Value" option in the Check Box field properties.