PdfToggleButtonAppearance Class

Namespace:
GemBox.Pdf.Forms
Assembly:
GemBox.Pdf.dll

Represents an appearance settings for a toggle button fields PdfCheckBoxField and PdfRadioButtonField.

public sealed class PdfToggleButtonAppearance : PdfFieldAppearance
Public NotInheritable Class PdfToggleButtonAppearance
    Inherits PdfFieldAppearance
Inheritance:
System.Object
PdfToggleButtonAppearance

Properties

BackgroundColor

Gets or sets the background color of the toggle button appearance.

public PdfColor? BackgroundColor { get; set; }
Public Property BackgroundColor As PdfColor?
Property Value
System.Nullable<PdfColor>

The background color of the toggle button appearance.

Exceptions
System.ArgumentException

The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).

See Also

BorderColor

Gets or sets the border color of the toggle button appearance.

public PdfColor? BorderColor { get; set; }
Public Property BorderColor As PdfColor?
Property Value
System.Nullable<PdfColor>

The border color of the toggle button appearance.

Exceptions
System.ArgumentException

The value's Space is not device color space (DeviceGray, DeviceRGB, or DeviceCMYK).

See Also

BorderDashPattern

Gets or sets the border dash pattern of the toggle button appearance.

public PdfLineDashPattern BorderDashPattern { get; set; }
Public Property BorderDashPattern As PdfLineDashPattern
Property Value
PdfLineDashPattern

The border dash pattern of the toggle button appearance.

See Also

BorderStyle

Gets or sets the border style of the toggle button appearance.

public PdfBorderStyle BorderStyle { get; set; }
Public Property BorderStyle As PdfBorderStyle
Property Value
PdfBorderStyle

The border style of the toggle button appearance.

Exceptions
System.NotSupportedException

Value Unknown of enumeration PdfBorderStyle is not supported in the requested operation.

See Also

BorderWidth

Gets or sets the border thickness of the toggle button appearance.

public double BorderWidth { get; set; }
Public Property BorderWidth As Double
Property Value
System.Double

The border thickness of the toggle button appearance.

Exceptions
System.ArgumentOutOfRangeException

Value is less than 0.

System.ArgumentException

Value is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

See Also

FontColor

Gets or sets the font color of the toggle button appearance text.

public PdfColor FontColor { get; set; }
Public Property FontColor As PdfColor
Property Value
PdfColor

The font color of the toggle button appearance text.

FontSize

Gets or sets the font size of the toggle button appearance text.

A zero value for size means that the font shall be auto-sized: its size shall be computed as a function of the size of the annotation rectangle.

public double FontSize { get; set; }
Public Property FontSize As Double
Property Value
System.Double

The font size of the toggle button appearance text.

Exceptions
System.ArgumentException

Value is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

System.ArgumentOutOfRangeException

Value is less than 0.

Style

Gets or sets the style of the toggle button appearance.

The usual values are:

public string Style { get; set; }
Public Property Style As String
Property Value
System.String

The style of the toggle button appearance.

Exceptions
System.ArgumentNullException

Value is null.

Inherited Properties

Orientation

(Optional) The number of degrees by which the widget annotation shall be rotated counterclockwise relative to the page.

The value shall be a multiple of 90.

Default value: 0.

(Inherited from PdfFieldAppearance)

State

(Required if the appearance dictionary AP contains one or more subdictionaries; PDF 1.2) The annotation's appearance state, which selects the applicable appearance stream from an appearance subdictionary (see Section 12.5.5, "Appearance Streams").

(Inherited from PdfAppearance)

Inherited Methods

BeginInit()

Begins initialization of the PdfAppearance.

Call EndInit() to end the initialization and update the appearance.

If BeginInit() is called on a PdfAppearance that is already being initialized, the second and subsequent calls are ignored.

(Inherited from PdfAppearance)

EndInit()

Ends initialization of the PdfAppearance by updating the changed appearance.

This method will be ignored if called on a PdfAppearance that is not being initialized.

(Inherited from PdfAppearance)

Get()

Gets the appearance form for the Normal appearance trigger and the current appearance State.

(Inherited from PdfAppearance)

Get(PdfAppearanceTrigger)

Gets a collection of appearance states and the associated appearance forms for the specified appearance trigger.

(Inherited from PdfAppearance)

Get(PdfAppearanceTrigger, PdfAppearanceState)

Gets the appearance form for the specified appearance trigger and appearance state.

(Inherited from PdfAppearance)

Refresh()

Forces an update of the appearance.

(Inherited from PdfAppearance)

Set(PdfAppearanceTrigger, System.Collections.Generic.ICollection<System.Collections.Generic.KeyValuePair<PdfAppearanceState, PdfForm>>)

Sets a collection of appearance states and the associated appearance forms for the specified appearance trigger.

(Inherited from PdfAppearance)

Set(PdfAppearanceTrigger, PdfAppearanceState, PdfForm)

Sets the appearance form for the specified appearance trigger and appearance state.

(Inherited from PdfAppearance)

Set(PdfForm)

Sets the appearance form for the Normal appearance trigger and the current appearance State.

(Inherited from PdfAppearance)