[]
        
(Showing Draft Content)

GrapeCity.Documents.Pdf.AcroForms.RadioButtonField

RadioButtonField Class

Represents group of radio buttons.

Namespace: GrapeCity.Documents.Pdf.AcroForms
Assembly: DS.Documents.Pdf.dll
Syntax
public class RadioButtonField : Field, IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef
Public Class RadioButtonField
    Inherits Field
    Implements IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef

Constructors

Name Description
RadioButtonField()

Initializes a new instance of the RadioButtonField class.

Properties

Name Description
DefaultValue

Gets or sets the default value of RadioButtonField. Default value can be specified as index of the widget in Widgets list, as string containing name of the widget.

Opt

Gets or sets an array of strings containing one entry for each widget annotation, defining export values for its constituent radio buttons. See the PDF spec for details.

RadiosInUnison

Gets or sets a value indicating whether a group of radio buttons within a radio button field that use the same value for the on state will turn on and off in unison; that is if one is checked, they are all checked. If clear, the buttons are mutually exclusive (the same behavior as HTML radio buttons).

Value

Gets or sets the value of RadioButtonField. Value can be specified as index of the widget in Widgets list, as string containing name of the widget.

Methods

Name Description
AddItem(Page, RectangleF, CheckStyle, BorderStyle)

Creates a new WidgetAnnotation and adds it to the Widgets collection.

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 "Radio Button Choice" option in the Radio Button field properties.

Note that if the Opt property is specified, then it is used in the Acrobat interface.
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 this name is specified as "Radio Button Choice" option in the Radio Button field properties.

Note that if the Opt property is specified, then it is used in the Acrobat interface.
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 "Radio Button Choice" option in the Radio Button field properties.

Note that if the Opt property is specified, then it is used in the Acrobat interface.
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 "Radio Button Choice" option in the Radio Button field properties.

Note that if the Opt property is specified, then it is used in the Acrobat interface.

Extension Methods