PdfTextMarkupAppearance Class

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

Represents an appearance settings for a PdfTextMarkupAnnotation.

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

Properties

Color

Gets or sets the color.

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

The color.

Exceptions
System.ArgumentException

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

IsUnderlineSquiggly

Gets or sets the value indicating whether the underline style is squiggly or straight.

public bool? IsUnderlineSquiggly { get; set; }
Public Property IsUnderlineSquiggly As Boolean?
Property Value
System.Nullable<System.Boolean>

true if the underline style is squiggly or false if the underline style is straight; otherwise, null if the PdfTextMarkupAnnotation is not an underline.

Exceptions
System.ArgumentException

Value is not null and the PdfTextMarkupAnnotation is not an underline.

Opacity

Gets or sets the opacity.

Default value: 1.0.

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

The opacity.

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