iText 8.0.2 API
iText.Kernel.Pdf.Collection.PdfCollectionSort Class Reference
Inheritance diagram for iText.Kernel.Pdf.Collection.PdfCollectionSort:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Member Functions

  PdfCollectionSort (PdfDictionary pdfObject)
 
  PdfCollectionSort (String key)
  Constructs a PDF Collection Sort Dictionary. More...
 
  PdfCollectionSort (String[] keys)
  Constructs a PDF Collection Sort Dictionary. More...
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionSort  SetSortOrder (bool ascending)
  Defines the sort order of the field (ascending or descending). More...
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionSort  SetSortOrder (bool[] ascending)
  Defines the sort order of the field (ascending or descending). More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >
virtual T  GetPdfObject ()
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document, PdfIndirectReference reference)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  MakeIndirect (PdfDocument document)
  Marks object behind wrapper to be saved as indirect. More...
 
virtual iText.Kernel.Pdf.PdfObjectWrapper< T >  SetModified ()
 
virtual void  Flush ()
 
virtual bool  IsFlushed ()
 

Constructor & Destructor Documentation

◆ PdfCollectionSort() [1/2]

iText.Kernel.Pdf.Collection.PdfCollectionSort.PdfCollectionSort ( String  key )
inline

Constructs a PDF Collection Sort Dictionary.

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

◆ PdfCollectionSort() [2/2]

iText.Kernel.Pdf.Collection.PdfCollectionSort.PdfCollectionSort ( String[]  keys )
inline

Constructs a PDF Collection Sort Dictionary.

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

Member Function Documentation

◆ SetSortOrder() [1/2]

virtual iText.Kernel.Pdf.Collection.PdfCollectionSort iText.Kernel.Pdf.Collection.PdfCollectionSort.SetSortOrder ( bool  ascending )
inlinevirtual

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

Parameters
ascending true is the default, use false for descending order
Returns
this instance to support fluent interface

◆ SetSortOrder() [2/2]

virtual iText.Kernel.Pdf.Collection.PdfCollectionSort iText.Kernel.Pdf.Collection.PdfCollectionSort.SetSortOrder ( bool[]  ascending )
inlinevirtual

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

Parameters
ascending an array with every element corresponding with a name of a field.
Returns
this instance to support fluent interface