iText.Kernel.Pdf.Collection.PdfCollectionSort Class Reference
Inheritance diagram for iText.Kernel.Pdf.Collection.PdfCollectionSort:
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 () |
Package Functions |
|
| override bool | IsWrappedObjectMustBeIndirect () |
| Defines if the object behind this wrapper must be an indirect object in the resultant document. More... |
|
| Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary > |
|
| PdfObjectWrapper (T pdfObject) | |
| virtual void | SetPdfObject (T pdfObject) |
| virtual void | SetForbidRelease () |
| virtual void | UnsetForbidRelease () |
| virtual void | EnsureUnderlyingObjectHasIndirectReference () |
Additional Inherited Members |
|
| Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary > |
|
| static void | MarkObjectAsIndirect (PdfObject pdfObject) |
| static void | EnsureObjectIsAddedToDocument (PdfObject @object) |
Some wrappers use object's indirect reference to obtain the PdfDocument to which the object belongs to. More... |
|
Constructor & Destructor Documentation
◆ PdfCollectionSort() [1/2]
|
inline |
Constructs a PDF Collection Sort Dictionary.
- Parameters
-
key the key of the field that will be used to sort entries
◆ PdfCollectionSort() [2/2]
|
inline |
Constructs a PDF Collection Sort Dictionary.
- Parameters
-
keys the keys of the fields that will be used to sort entries
Member Function Documentation
◆ IsWrappedObjectMustBeIndirect()
|
inlinepackagevirtual |
Defines if the object behind this wrapper must be an indirect object in the resultant document.
Defines if the object behind this wrapper must be an indirect object in the resultant document.
If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.
Return value of this method shouldn't depend on any logic, it should return always true or false.
- Returns
- true if in the resultant document the object behind the wrapper must be indirect, otherwise false.
Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.
◆ SetSortOrder() [1/2]
|
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]
|
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
