Class PdfActionOcgState

Namespace

iText.Kernel.Pdf.Action

Assembly

itext.kernel.dll

This is a helper class for optional content states use in Set-OCG-State actions.

public class PdfActionOcgState

Inheritance

object

PdfActionOcgState

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This is a helper class for optional content states use in Set-OCG-State actions. See .

Constructors

PdfActionOcgState(PdfName, IList<PdfDictionary>)

Constructs an optional content state object.

public PdfActionOcgState(PdfName state, IList<PdfDictionary> ocgs)

Parameters

state PdfName

a PdfName describing the state. Shall be one of the following: OFF , ON , Toggle

ocgs IList<PdfDictionary>

a list of the OCG dictionaries

Methods

GetObjectList()

Gets a list of PdfObject that is describing this particular optional content group states.

public virtual IList<PdfObject> GetObjectList()

Returns

IList<PdfObject>

a list of PdfObject for construction of a PdfArray

GetOcgs()

Gets a list of optional content groups that shall have the state changed

public virtual IList<PdfDictionary> GetOcgs()

Returns

IList<PdfDictionary>

the list of optional content groups

GetState()

Gets the state the optional content groups should be switched to

public virtual PdfName GetState()

Returns

PdfName

the state, one of the following: OFF , ON , Toggle