Class PdfCollection

Namespace

iText.Kernel.Pdf.Collection

Assembly

itext.kernel.dll

public class PdfCollection : PdfObjectWrapper<PdfDictionary>

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfCollection

Inherited Members

PdfObjectWrapper<PdfDictionary>.GetPdfObject()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.Flush()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfCollection()

Constructs a PDF Collection.

public PdfCollection()

PdfCollection(PdfDictionary)

public PdfCollection(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

Fields

DETAILS

A type of initial view

public const int DETAILS = 0

Field Value

int

HIDDEN

A type of initial view

public const int HIDDEN = 2

Field Value

int

TILE

A type of initial view

public const int TILE = 1

Field Value

int

Methods

GetInitialDocument()

Retrieves the document that will be initially presented in the user interface.

public virtual PdfString GetInitialDocument()

Returns

PdfString

a pdf string that identifies an entry in the EmbeddedFiles name tree

GetSchema()

Gets the Collection schema dictionary.

public virtual PdfCollectionSchema GetSchema()

Returns

PdfCollectionSchema

the Collection schema dictionary

GetSort()

Getter for the Collection sort dictionary.

public virtual PdfCollectionSort GetSort()

Returns

PdfCollectionSort

the Collection sort

IsViewDetails()

Check if view is in details mode.

public virtual bool IsViewDetails()

Returns

bool

true if view is in details mode and false otherwise

IsViewHidden()

Check if view is hidden.

public virtual bool IsViewHidden()

Returns

bool

true if view is hidden and false otherwise

IsViewTile()

Check if view is in tile mode.

public virtual bool IsViewTile()

Returns

bool

true if view is in tile mode and false otherwise

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool

SetInitialDocument(string)

Identifies the document that will be initially presented in the user interface.

public virtual PdfCollection SetInitialDocument(string documentName)

Parameters

documentName string

a string that identifies an entry in the EmbeddedFiles name tree

Returns

PdfCollection

this instance to support fluent interface

SetSchema(PdfCollectionSchema)

Sets the Collection schema dictionary.

public virtual PdfCollection SetSchema(PdfCollectionSchema schema)

Parameters

schema PdfCollectionSchema

an overview of the collection fields

Returns

PdfCollection

this instance to support fluent interface

SetSort(PdfCollectionSort)

Sets the Collection sort dictionary.

public virtual PdfCollection SetSort(PdfCollectionSort sort)

Parameters

sort PdfCollectionSort

is the Collection sort dictionary

Returns

PdfCollection

this instance to support fluent interface

SetView(int)

Sets the initial view.

public virtual PdfCollection SetView(int viewType)

Parameters

viewType int

is a type of view

Returns

PdfCollection

this instance to support fluent interface