GrapeCity.Documents.Pdf.Annotations.Appearance

Class Appearance

Namespace

GrapeCity.Documents.Pdf.Annotations

Assembly

GcDocs.Pdf.dll

Represents the appearance of an annotation in normal, rollover and down states.

In the simplest case the appearance can be defined by a single FormXObject specified by the Default property.

In more complex cases it can be defined as a subdictionary specified by the this[string] property. For example, an annotation representing an interactive check box might have two appearance states named On and Off.

See PDF specification for details.

public class Appearance

Inheritance

object

Appearance

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

Annotation

Gets the AnnotationBase object owning this object.

public AnnotationBase Annotation { get; }

Property Value

AnnotationBase

Default

Gets or sets the FormXObject that is used when the widget has separate states.

public FormXObject Default { get; set; }

Property Value

FormXObject

this[string]

Gets or sets the FormXObject object for a specified state.

public FormXObject this[string state] { get; set; }

Parameters

state string

The state of the annotation.

Property Value

FormXObject

The FormXObject associated with the specified state.

Methods

Clear()

Clears all defined appearances.

public void Clear()

GetOnState()

Gets the name of the appearance stream that is used to show RadioButtonField or CheckBoxField in the checked state.

public string GetOnState()

Returns

string

The name of the checked appearance stream.

GetStates()

Gets the names of the appearance streams specified for the AnnotationBase.

public string[] GetStates()

Returns

string[]

A string array containing the appearance streams' names.