ChoiceField Class

Apitron PDF Kit help
Apitron.PDF.Kit library for .NET
This class represents a choice field.
Inheritance Hierarchy

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

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

public class ChoiceField : TerminalField

The ChoiceField type exposes the following members.

Constructors

  NameDescription
Public methodCode exampleChoiceField(String, String, DictionaryString, String, ChoiceFieldType)
Initializes a new instance of the Object class.
Public methodCode exampleChoiceField(String, String, IEnumerableOption, ChoiceFieldType)
Initializes a new instance of the Object class.
Public methodCode exampleChoiceField(String, String, String, ChoiceFieldType)
Initializes a new instance of the ChoiceField class.
Top
Properties

  NameDescription
Public propertyAdditionalActions
Gets the additional actions.
(Inherited from Field.)
Public propertyAlternateFieldName
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.)
Public propertyBorderColor
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.)
Public propertyBorderStyle
Gets or sets the border style.
(Inherited from Field.)
Public propertyCanBeExported
Gets a value indicating whether this instance can be exported.
(Inherited from Resource.)
Public propertyChoiceFieldType
Gets the type of the choice field.
Public propertyDefaultStyle
Gets or sets the default style.
(Inherited from Field.)
Public propertyFieldName
Gets or sets the partial field name
(Inherited from Field.)
Public propertyFieldNames
Gets the underlying field's names.
(Inherited from Field.)
Public propertyFlags
Gets or sets a set of flags specifying various characteristics of the field.
(Inherited from Field.)
Public propertyFontResourceID
Gets or sets the font resource ID.
(Inherited from Field.)
Public propertyFontSize
Gets or sets the size of the font.
(Inherited from Field.)
Public propertyIsEditable
Gets or sets a value indicating whether the combo box shall include an editable text box as well as a drop-down list.
Public propertyIsMultiSelect
Gets or sets a value indicating whether more than one of the field’s option items may be selected simultaneously.
Public propertyIsReadOnly
Gets or sets a value indicating whether this instance is read only.
(Inherited from Field.)
Public propertyItem
Gets the underlying Field with the specified field name.
(Inherited from Field.)
Public propertyMappingName
Gets or sets the mapping name that shall be used when exporting interactive form field data from the document.
(Inherited from Field.)
Public propertyOptions
Gets the options. This dictionary represents the option’s export value and the text that shall be displayed as the name of the option.
Public propertyQuaddingJustification
Gets or sets the quadding justification.
(Inherited from Field.)
Public propertyResourceType
Gets the resource type.
(Inherited from Resource.)
Public propertyRichTextString
Gets or sets the rich text string.
(Inherited from Field.)
Public propertySelectedItem
Gets the selected name.
Public propertySelectedItems
Gets the selected names.
Public propertySelectedName
Gets the selected name.
Public propertySelectedNames
Gets the selected names.
Public propertySelectionColor
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
Public propertySort
Gets or sets a value indicating whether this ChoiceField should be sorted.
Public propertyTextColor
Gets or sets the color of the text.
(Inherited from Field.)
Public propertyTopIndex
Gets or sets for scrollable list boxes, the zero based top index.
Public propertyViewColor
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.)
Public propertyViews
Gets or sets the children.
(Inherited from TerminalField.)
Top
Methods

  NameDescription
Public methodDeselectName
Deselects an option with the specified name.
Public methodFlatten
Flattens this instance and removes from fields collection.
(Inherited from TerminalField.)
Public methodSelectName
Selects an option with the specified option name.
Top
See Also

Reference