| Name | Description | |
|---|---|---|
 | CheckBoxField Constructor | Initializes a new instance of the CheckBoxField class. |
The following tables list the members exposed by CheckBoxField.
| Name | Description | |
|---|---|---|
| CheckBoxField Constructor | Initializes a new instance of the CheckBoxField class. |
| Name | Description | |
|---|---|---|
 | AcroForm | Gets the AcroForm that owns this object. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| ActualJustification | Gets the actual justification to be used when displaying the field’s text. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| AlternateName | Gets or sets an alternate field name to be used in place of the actual field name wherever the field must be identified in the user interface (such as in error or status messages referring to the field). This text is also useful when extracting the document’s contents in support of accessibility to users with disabilities or for other purposes. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| CalculationIndex | Gets or sets an index that is used to determine the field's calculation order. Fields with lower indices are calculated before fields with higher indices.
If several fields have the same CalculationIndex, the calculation order is determined by the order of fields in the collection. Field.TriggerEvents.RecalculateValue can be used to specify JavaScript that is used to calculate the field's value. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Checked | Gets or sets the value of this CheckBoxField as a Boolean value. See ValueObj for details. |
| Children | Gets the list of child fields. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| 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. |
| Doc | Gets the GrapeCity.Documents.Pdf.GcPdfDocument owning this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Events | Gets the Field.TriggerEvents object defining events of this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Export | Gets or sets a value indicating whether the field must not be exported by a GrapeCity.Documents.Pdf.Actions.ActionSubmitForm action. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| GcProps | Gets the GrapeCity.Documents.Pdf.Spec.PdfDict object that can be used to associate arbitrary data with this field.
Note that for text values, in most cases the GrapeCity.Documents.Pdf.Spec.PdfString type should be used rather than System.String. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| HasGcProps | Gets a value indicating whether the Field.GcProps is not empty (i.e. whether this filed has any associated custom properties). (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Justification | Gets or sets the justification to be used in displaying the field’s text.
Note that this field is used only if GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation.Justification is not specified. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| MappingName | Gets or sets the mapping name to be used when exporting interactive form field data from the document. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Name | Gets or sets the field's name. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| ObjID | Gets the PDF object ID. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| 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. |
| Owner | Gets the FieldCollection containing this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Parent | Gets the parent field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| PdfDefaultValue | Gets or sets the default field's value. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| PdfDict | Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfDict. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfDictWrapper) |
| PdfObject | Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapper<IPdfDict>) |
| PdfValue | Gets or sets the field's value. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| ReadOnly | Gets or sets a value indicating whether the user may not change the value of the field. Any associated widget annotations will not interact with the user; that is, they will not respond to mouse clicks or change their appearance in response to mouse motions. This flag is useful for fields whose values are computed or imported from a database. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Required | Gets or sets a value indicating whether the field must have a value at the time it is exported by a GrapeCity.Documents.Pdf.Actions.ActionSubmitForm action. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| UserData | Gets or sets arbitrary data associated with the current field.
Note that this data is runtime only and is not persisted in the PDF. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| 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 GrapeCity.Documents.Pdf.Annotations.WidgetAnnotation defining view properties of the CheckBoxField. |
| Widgets | Gets the list of widget annotations associated with this field. (Inherited from GrapeCity.Documents.Pdf.AcroForms.Field) |
| Name | Description | |
|---|---|---|
 | GetCheckedAppearanceStreamName | 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. |
| GetPdfStream | Gets the System.IO.Stream object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| GetPdfStreamData | Gets the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| GetPdfStreamInfo | Gets the GrapeCity.Documents.Pdf.Spec.PdfStreamInfo object containing the data of GrapeCity.Documents.Pdf.Spec.PdfStreamObjectBase owned by this wrapper. Note! The stream should be disposed after usage. (Inherited from GrapeCity.Documents.Pdf.Wrappers.PdfWrapperBase) |
| HasRadioButtonBehavior | Checks whether this CheckBoxField actually behaves as a RadioButtonField. This situation takes place if the checkbox field owns more than one GrapeCity.Documents.Pdf.Annotations.WidgetAnnotations, and the widgets' appearance streams used to show checked state have different names. |
| SetCheckedAppearanceStreamName | 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 | 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. |