Class AppearanceStream

Namespace

UglyToad.PdfPig.Annotations

Assembly

UglyToad.PdfPig.dll

Appearance stream (PDF Reference 8.4.4) that describes what an annotation looks like. Each stream is a Form XObject. The appearance stream is either stateless (in which case IsStateless is true) or stateful, in which case IsStateless is false and the states can be retrieved via GetStates. The states can then be used to retrieve the state-specific appearances using Get(string).

public class AppearanceStream

Inheritance

object

AppearanceStream

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

GetStates

Get list of states. If this is a stateless appearance stream, an empty collection is returned.

public ICollection<string> GetStates { get; }

Property Value

ICollection<string>

IsStateless

Indicates if this appearance stream is stateless, or whether you can get appearances by state.

public bool IsStateless { get; }

Property Value

bool

Methods

Get(string)

Get appearance stream for particular state

public StreamToken Get(string state)

Parameters

state string

Returns

StreamToken

Exceptions

Exception

ArgumentOutOfRangeException