PdfSquareCircleAppearance Class

Namespace:
GemBox.Pdf.Annotations
Assembly:
GemBox.Pdf.dll

Represents an appearance settings for a PdfSquareCircleAnnotation.

public sealed class PdfSquareCircleAppearance : PdfAppearance
Public NotInheritable Class PdfSquareCircleAppearance
    Inherits PdfAppearance
Inheritance:
System.Object
PdfSquareCircleAppearance

Properties

FillColor

Gets or sets the fill color of the square or circle.

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

The fill color of the square or circle.

Exceptions
System.ArgumentException

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

See Also

Opacity

Gets or sets the opacity of the square or circle.

Default value: 1.0.

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

The opacity of the square or circle.

StrokeColor

Gets or sets the color of the square or circle to be stroked.

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

The color of the square or circle to be stroked.

Exceptions
System.ArgumentException

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

See Also

StrokeDashPattern

Gets or sets the dash pattern of the square or circle to be stroked.

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

The dash pattern of the square or circle to be stroked.

See Also

StrokeStyle

Gets or sets the style of the square or circle to be stroked.

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

The style of the square or circle to be stroked.

Exceptions
System.NotSupportedException

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

See Also

StrokeWidth

Gets or sets the thickness of the square or circle to be stroked.

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

The thickness of the square or circle to be stroked.

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

Inherited Properties

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)

See Also