Class PdfCollectionSort

Namespace

iText.Kernel.Pdf.Collection

Assembly

itext.kernel.dll

public class PdfCollectionSort : PdfObjectWrapper<PdfDictionary>

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfCollectionSort

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

PdfCollectionSort(string)

Constructs a PDF Collection Sort Dictionary.

public PdfCollectionSort(string key)

Parameters

key string

the key of the field that will be used to sort entries

PdfCollectionSort(string[])

Constructs a PDF Collection Sort Dictionary.

public PdfCollectionSort(string[] keys)

Parameters

keys string[]

the keys of the fields that will be used to sort entries

PdfCollectionSort(PdfDictionary)

public PdfCollectionSort(PdfDictionary pdfObject)

Parameters

pdfObject PdfDictionary

Methods

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool

SetSortOrder(bool)

Defines the sort order of the field (ascending or descending).

public virtual PdfCollectionSort SetSortOrder(bool ascending)

Parameters

ascending bool

true is the default, use false for descending order

Returns

PdfCollectionSort

this instance to support fluent interface

SetSortOrder(bool[])

Defines the sort order of the field (ascending or descending).

public virtual PdfCollectionSort SetSortOrder(bool[] ascending)

Parameters

ascending bool[]

an array with every element corresponding with a name of a field.

Returns

PdfCollectionSort

this instance to support fluent interface