RadioButtonField Class
Class representing radio button field.
Inheritance Hierarchy

Namespace: Aspose.Pdf.Forms
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.7
Syntax
public sealed class RadioButtonField : ChoiceField

The RadioButtonField type exposes the following members.

Constructors
  NameDescription
Public methodRadioButtonField(Document)
Constructor for RadioButtonField.
Public methodRadioButtonField(Page)
Constructor for RadiouttonField
Properties
  NameDescription
Public propertyActions
Gets the annotation actions.
(Inherited from WidgetAnnotation.)
Public propertyActiveState
Gets or sets current annotation appearance state.
(Inherited from Annotation.)
Public propertyAlignment Obsolete.
Annotation alignment. This property is obsolete. Use HorizontalAligment instead.
(Inherited from Annotation.)
Public propertyAlternateName
Gets or sets alternate name of the field (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). Alternate name is used as field tooltip in Adobe Acrobat.
(Inherited from Field.)
Public propertyAnnotationIndex
Gets or sets index of this anotation on the page.
(Inherited from Field.)
Public propertyAnnotationType
Gets type of annotation.
(Inherited from WidgetAnnotation.)
Public propertyAppearance
Gets appearance dictionary of the annotation.
(Inherited from Annotation.)
Public propertyBorder
Gets or sets annotation border characteristics. Border
(Inherited from Annotation.)
Public propertyCharacteristics
Gets annotation characteristics.
(Inherited from Annotation.)
Public propertyColor
Gets or sets annotation color.
(Inherited from Annotation.)
Public propertyCommitImmediately
Gets or sets commit on selection change flag.
(Inherited from ChoiceField.)
Public propertyContents
Gets or sets annotation text.
(Inherited from Annotation.)
Public propertyCount
Gets or sets number of subfields in this field. (For example number of items in radio button field).
(Inherited from Field.)
Public propertyDefaultAppearance
Gets or sets default appearance of the field.
(Inherited from WidgetAnnotation.)
Public propertyExportable
Gets or sets exportable flag of the field.
(Inherited from WidgetAnnotation.)
Public propertyFlags
Flags of the annotation.
(Inherited from Annotation.)
Public propertyFullName
Gets full qualified name of the annotation.
(Inherited from Annotation.)
Public propertyHeight
Gets or sets height of the annotation.
(Inherited from Annotation.)
Public propertyHighlighting
Annotation highlighting mode.
(Inherited from WidgetAnnotation.)
Public propertyHorizontalAlignment Obsolete.
Gets or sets text alignment for annotation.
(Inherited from Annotation.)
Public propertyHyperlink
Gets or sets the fragment hyperlink(for pdf generator).
(Inherited from BaseParagraph.)
Public propertyIsFirstParagraphInColumn
Gets or sets a bool value that indicates whether this paragraph will be at next column. Default is false.(for pdf generation)
(Inherited from BaseParagraph.)
Public propertyIsGroup
Gets or sets boolean value which indicates is this field non-terminal field i.e. group of fields.
(Inherited from Field.)
Public propertyIsInLineParagraph
Gets or sets a paragraph is inline. Default is false.(for pdf generation)
(Inherited from BaseParagraph.)
Public propertyIsInNewPage
Gets or sets a bool value that force this paragraph generates at new page. Default is false.(for pdf generation)
(Inherited from BaseParagraph.)
Public propertyIsKeptWithNext
Gets or sets a bool value that indicates whether current paragraph remains in the same page along with next paragraph. Default is false.(for pdf generation)
(Inherited from BaseParagraph.)
Public propertyIsSharedField
Property for Generator support. Used when field is added to header or footer. If true, this field will created once and it's appearance will be visible on all pages of the document. If false, separated field will be created for every document page.
(Inherited from Field.)
Public propertyIsSynchronized
Returns true if dictionary is synchronized.
(Inherited from Field.)
Public propertyItemInt32
Gets subfield contained in this field by index.
(Inherited from Field.)
Public propertyItemString
Gets subfield contained in this field by name of the subfield.
(Inherited from Field.)
Public propertyMappingName
Gets or sets mapping name of the field that shall be used when exporting interactive form field data from the document.
(Inherited from Field.)
Public propertyMargin
Gets or sets a outer margin for paragraph (for pdf generation)
(Inherited from BaseParagraph.)
Public propertyModified
Gets or sets date and time when annotation was recently modified.
(Inherited from Annotation.)
Public propertyMultiSelect
Gets or sets multiselection flag.
(Inherited from ChoiceField.)
Public propertyName
Gets or sets annotation name on the page.
(Inherited from Annotation.)
Public propertyOnActivated
An action which shall be performed when the annotation is activated.
(Inherited from WidgetAnnotation.)
Public propertyOptions
Gets collection of options of the radio button.
(Overrides ChoiceFieldOptions.)
Public propertyPageIndex
Gets index of page which contains this RadioButton field.
(Overrides FieldPageIndex.)
Public propertyParent
Gets annotation parent.
(Inherited from WidgetAnnotation.)
Public propertyPartialName
Gets or sets partial name of the field.
(Inherited from Field.)
Public propertyReadOnly
Gets or sets read only status of the field.
(Inherited from WidgetAnnotation.)
Public propertyRect
Gets or sets the field rectangle.
(Inherited from Field.)
Public propertyRequired
Gets or sets required status of the field.
(Inherited from WidgetAnnotation.)
Public propertySelected
Gets or sets index of selected item. Numbering of items is started from 1.
(Overrides ChoiceFieldSelected.)
Public propertySelectedItems
Gets or sets array of selected items. For multiselect list array contains more then one item. For single selection list it contains single item.
(Inherited from ChoiceField.)
Public propertyStates
Gets appearance dictionary of annotation.
(Inherited from Annotation.)
Public propertyStyle
Style of field box.
Public propertySyncRoot
Synchronization object.
(Inherited from Field.)
Public propertyTabOrder
Gets or sets tab order of the field.
(Inherited from Field.)
Public propertyTextHorizontalAlignment
Gets or sets text alignment for annotation.
(Inherited from Annotation.)
Public propertyValue
Gets or sets value of field.
(Overrides ChoiceFieldValue.)
Public propertyVerticalAlignment
Gets or sets a vertical alignment of paragraph
(Inherited from BaseParagraph.)
Public propertyWidth
Gets or sets width of the annotation.
(Inherited from Annotation.)
Public propertyZIndex
Gets or sets a int value that indicates the Z-order of the graph. A graph with larger ZIndex will be placed over the graph with smaller ZIndex. ZIndex can be negative. Graph with negative ZIndex will be placed behind the text in the page.
(Inherited from BaseParagraph.)
Methods
  NameDescription
Public methodAccept
Accepts visitor.
(Inherited from WidgetAnnotation.)
Public methodAdd
Adds new option field to RadioButton field
Public methodAddOption(String)
Add option to radion button.
(Overrides ChoiceFieldAddOption(String).)
Public methodAddOption(String, String)
Adds new option with specified export value and name.
(Inherited from ChoiceField.)
Public methodAddOption(String, Rectangle)
Add to radio button option with specifed rectangle.
Public methodClone
Clones this instance. Virtual method. Always return null.
(Inherited from BaseParagraph.)
Public methodCopyTo
Copies subfields of this field into array starting from specified index.
(Inherited from Field.)
Public methodDeleteOption
Deletes option by its name.
(Inherited from ChoiceField.)
Public methodEquals (Inherited from Object.)
Public methodFlatten
Removes this field and place its value directly on the page.
(Inherited from Field.)
Public methodGetEnumerator
Returns enumerator of contained fields.
(Inherited from Field.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetRectangle
Returns rectangle of annotation taking into consideration page rotation.
(Inherited from Annotation.)
Public methodGetType (Inherited from Object.)
Public methodRecalculate
Recaculates all calculated fields on the form.
(Inherited from Field.)
Public methodSetPosition
Move all subitems of radio button to specified positins on the page.
(Overrides FieldSetPosition(Point).)
Public methodToString (Inherited from Object.)
See Also