Apitron.PDF.Kit library for .NET
SystemObject
Apitron.PDF.Kit.FixedLayout.ResourcesResource
Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
Apitron.PDF.Kit.Interactive.FormsField
Apitron.PDF.Kit.Interactive.FormsTerminalField
Apitron.PDF.Kit.Interactive.FormsChoiceField
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Top
Top
Top
This class represents a choice field.
Inheritance Hierarchy
Apitron.PDF.Kit.FixedLayout.ResourcesResource
Apitron.PDF.Kit.FixedLayout.ResourcesUndefinedResource
Apitron.PDF.Kit.Interactive.FormsField
Apitron.PDF.Kit.Interactive.FormsTerminalField
Apitron.PDF.Kit.Interactive.FormsChoiceField
Namespace: Apitron.PDF.Kit.Interactive.Forms
Assembly: Apitron.PDF.Kit (in Apitron.PDF.Kit.dll) Version: 2.0.37.0 (2.0.37.0)
Syntax
The ChoiceField type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
  | ChoiceField(String, String, DictionaryString, String, ChoiceFieldType) |
Initializes a new instance of the Object class.
|
| ChoiceField(String, String, IEnumerableOption, ChoiceFieldType) |
Initializes a new instance of the Object class.
|
| ChoiceField(String, String, String, ChoiceFieldType) |
Initializes a new instance of the ChoiceField class.
|
Properties
| Name | Description | |
|---|---|---|
 | AdditionalActions |
Gets the additional actions.
(Inherited from Field.) |
| AlternateFieldName |
Gets or sets an alternate field name that shall be used in place of the actual field name wherever the field shall 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 Field.) |
| BorderColor |
Gets or sets the color of the border.
The color is an array of numbers that shall be in the range 0.0 to 1.0 specifying the colour of
the widget annotation’s border. The number of array elements determines the colour space in which
the colour shall bedefined:
0 No colour; transparent
1 DeviceGray
3 DeviceRGB
4 DeviceCMYK
(Inherited from Field.) |
| BorderStyle |
Gets or sets the border style.
(Inherited from Field.) |
| CanBeExported |
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.) |
| ChoiceFieldType |
Gets the type of the choice field.
|
| DefaultStyle |
Gets or sets the default style.
(Inherited from Field.) |
| FieldName |
Gets or sets the partial field name
(Inherited from Field.) |
| FieldNames |
Gets the underlying field's names.
(Inherited from Field.) |
| Flags |
Gets or sets a set of flags specifying various characteristics of the field.
(Inherited from Field.) |
| FontResourceID |
Gets or sets the font resource ID.
(Inherited from Field.) |
| FontSize |
Gets or sets the size of the font.
(Inherited from Field.) |
| IsEditable |
Gets or sets a value indicating whether the combo box shall include an editable text box as well as a drop-down list.
|
| IsMultiSelect |
Gets or sets a value indicating whether more than one of the field’s option items may be selected simultaneously.
|
| IsReadOnly |
Gets or sets a value indicating whether this instance is read only.
(Inherited from Field.) |
| Item |
Gets the underlying Field with the specified field name.
(Inherited from Field.) |
| MappingName |
Gets or sets the mapping name that shall be used when exporting interactive form field data from the document.
(Inherited from Field.) |
| Options |
Gets the options. This dictionary represents the option’s export value and the text that shall be displayed as the name of the option.
|
| QuaddingJustification |
Gets or sets the quadding justification.
(Inherited from Field.) |
| ResourceType |
Gets the resource type.
(Inherited from Resource.) |
| RichTextString |
Gets or sets the rich text string.
(Inherited from Field.) |
| SelectedItem |
Gets the selected name.
|
| SelectedItems |
Gets the selected names.
|
| SelectedName |
Gets the selected name.
|
| SelectedNames |
Gets the selected names.
|
| SelectionColor |
Gets or sets the color of the selection.
The color is an array of numbers that shall be in the range 0.0 to 1.0 specifying the colour of
the widget annotation’s border. The number of array elements determines the colour space in which
the colour shall bedefined:
0 No colour; transparent
1 DeviceGray
3 DeviceRGB
4 DeviceCMYK
|
| Sort |
Gets or sets a value indicating whether this ChoiceField should be sorted.
|
| TextColor |
Gets or sets the color of the text.
(Inherited from Field.) |
| TopIndex |
Gets or sets for scrollable list boxes, the zero based top index.
|
| ViewColor |
Gets or sets the color of the view.
The color is an array of numbers that shall be in the range 0.0 to 1.0 specifying the colour of
the widget annotation’s border. The number of array elements determines the colour space in which
the colour shall bedefined:
0 No colour; transparent
1 DeviceGray
3 DeviceRGB
4 DeviceCMYK
(Inherited from Field.) |
| Views |
Gets or sets the children.
(Inherited from TerminalField.) |
Methods
| Name | Description | |
|---|---|---|
| DeselectName |
Deselects an option with the specified name.
|
| Flatten |
Flattens this instance and removes from fields collection.
(Inherited from TerminalField.) |
| SelectName |
Selects an option with the specified option name.
|
See Also