[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.AcroForms.RadioButtonField

Class RadioButtonField

Namespace
GrapeCity.Documents.Pdf.AcroForms
Assembly
GcDocs.Pdf.dll

Represents group of radio buttons.

public class RadioButtonField : Field, IPdfDict, IOwnedObject, ActionHide.ILinkedObject, ActionFieldsBase.IFieldDef
Inheritance
object
RadioButtonField
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

RadioButtonField()

Initializes a new instance of the RadioButtonField class.

public RadioButtonField()

Properties

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.

public object DefaultValue { get; set; }

Property Value

object

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.

public string[] Opt { get; set; }

Property Value

string[]

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).

public bool RadiosInUnison { get; set; }

Property Value

bool

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.

public object Value { get; set; }

Property Value

object

Methods

AddItem(Page, RectangleF, CheckStyle, BorderStyle)

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

public WidgetAnnotation AddItem(Page page, RectangleF bounds, CheckStyle checkStyle = CheckStyle.Circle, BorderStyle borderStyle = BorderStyle.Solid)

Parameters

page Page

The page on which the new WidgetAnnotation will be placed.

bounds System.Drawing.RectangleF

The bounds of the new WidgetAnnotation on page.

checkStyle CheckStyle

The check mark style.

borderStyle BorderStyle

The border style.

Returns

WidgetAnnotation

Returns the created WidgetAnnotation object.

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. 
public string GetCheckedAppearanceStreamName(WidgetAnnotation wa)

Parameters

wa WidgetAnnotation

One of WidgetAnnotations associated with this field.

Returns

string

The name of the widget annotation's appearance stream that is used to display the widget in checked state.

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. 
public string[] GetCheckedAppearanceStreamNames()

Returns

string[]

The names of the widget annotations' appearance streams that are used to display the widgets in checked state.

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. 
public void SetCheckedAppearanceStreamName(WidgetAnnotation wa, string name)

Parameters

wa WidgetAnnotation

One of WidgetAnnotations associated with this field.

name string

The name of the appearance stream to use for checked state.

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. 
public void SetCheckedAppearanceStreamNames(string name)

Parameters

name string

The name of the appearance stream to use for checked state.