iText 8.0.2 API
|
The root of a document’s object hierarchy. More...
Public Member Functions |
|
virtual PdfOCProperties | GetOCProperties (bool createIfNotExists) |
Use this method to get the Optional Content Properties Dictionary. More... |
|
virtual PdfDocument | GetDocument () |
Get PdfDocument with indirect reference associated with the object. More... |
|
override void | Flush () |
PdfCatalog will be flushed in PdfDocument.close(). More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetOpenAction (PdfDestination destination) |
A value specifying a destination that shall be displayed when the document is opened. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetOpenAction (PdfAction action) |
A value specifying an action that shall be performed when the document is opened. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetAdditionalAction (PdfName key, PdfAction action) |
The actions that shall be taken in response to various trigger events affecting the document as a whole. More... |
|
virtual PdfName | GetPageMode () |
Get page mode of the document. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetPageMode (PdfName pageMode) |
This method sets a page mode of the document. More... |
|
virtual PdfName | GetPageLayout () |
Get page layout of the document. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetPageLayout (PdfName pageLayout) |
This method sets a page layout of the document More... |
|
virtual PdfViewerPreferences | GetViewerPreferences () |
Get viewer preferences of the document. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetViewerPreferences (PdfViewerPreferences preferences) |
This method sets the document viewer preferences, specifying the way the document shall be displayed on the screen More... |
|
virtual PdfNameTree | GetNameTree (PdfName treeType) |
This method gets Names tree from the catalog. More... |
|
virtual bool | NameTreeContainsKey (PdfName treeType) |
This method checks Names tree for specified tree type. More... |
|
virtual PdfNumTree | GetPageLabelsTree (bool createIfNotExists) |
This method returns the NumberTree of Page Labels More... |
|
virtual PdfString | GetLang () |
Get natural language. More... |
|
virtual void | SetLang (PdfString lang) |
An entry specifying the natural language, and optionally locale. More... |
|
virtual void | AddDeveloperExtension (PdfDeveloperExtension extension) |
Add an extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document. More... |
|
virtual PdfCollection | GetCollection () |
Gets collection dictionary that a conforming reader shall use to enhance the presentation of file attachments stored in the PDF document. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | SetCollection (PdfCollection collection) |
Sets collection dictionary that a conforming reader shall use to enhance the presentation of file attachments stored in the PDF document. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | Put (PdfName key, PdfObject value) |
Add key and value to PdfCatalog dictionary. More... |
|
virtual iText.Kernel.Pdf.PdfCatalog | Remove (PdfName key) |
Remove key from catalog dictionary. 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 bool | IsFlushed () |
The root of a document’s object hierarchy.
|
inlinevirtual |
Add an extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document.
Add an extensions dictionary containing developer prefix identification and version numbers for developer extensions that occur in this document. See ISO 32000-1, Table 28 – Entries in the catalog dictionary.
extension | enables developers to identify their own extension relative to a base version of PDF |
|
inlinevirtual |
PdfCatalog will be flushed in PdfDocument.close().
PdfCatalog will be flushed in PdfDocument.close(). User mustn't flush PdfCatalog!
Reimplemented from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.
|
inlinevirtual |
Gets collection dictionary that a conforming reader shall use to enhance the presentation of file attachments stored in the PDF document.
iText.Kernel.Pdf.Collection.PdfCollection wrapper of collection dictionary.
|
inlinevirtual |
Get PdfDocument with indirect reference associated with the object.
|
inlinevirtual |
Get natural language.
|
inlinevirtual |
This method gets Names tree from the catalog.
treeType | type of the tree (Dests, AP, EmbeddedFiles etc). |
|
inlinevirtual |
Use this method to get the Optional Content Properties Dictionary.
Use this method to get the Optional Content Properties Dictionary. Note that if you call this method, then the PdfDictionary with OCProperties will be generated from iText.Kernel.Pdf.Layer.PdfOCProperties object right before closing the PdfDocument , so if you want to make low-level changes in Pdf structures themselves ( PdfArray , PdfDictionary , etc), then you should address directly those objects, e.g.: PdfCatalog pdfCatalog = pdfDoc.getCatalog(); PdfDictionary ocProps = pdfCatalog.getAsDictionary(PdfName.OCProperties); // manipulate with ocProps.
Also note that this method is implicitly called when creating a new PdfLayer instance, so you should either use hi-level logic of operating with layers, or manipulate low-level Pdf objects by yourself.
createIfNotExists | true to create new /OCProperties entry in catalog if not exists, false to return null if /OCProperties entry in catalog is not present. |
|
inlinevirtual |
This method returns the NumberTree of Page Labels
createIfNotExists | defines whether the NumberTree of Page Labels should be created if it didn't exist before |
|
inlinevirtual |
Get page layout of the document.
|
inlinevirtual |
Get page mode of the document.
|
inlinevirtual |
Get viewer preferences of the document.
|
inlinevirtual |
This method checks Names tree for specified tree type.
treeType | type of tree which existence should be checked |
|
inlinevirtual |
Add key and value to PdfCatalog dictionary.
key | the dictionary key corresponding with the PDF object |
value | the value of key |
|
inlinevirtual |
Remove key from catalog dictionary.
key | the dictionary key corresponding with the PDF object |
|
inlinevirtual |
The actions that shall be taken in response to various trigger events affecting the document as a whole.
The actions that shall be taken in response to various trigger events affecting the document as a whole. See ISO 32000-1, Table 28 – Entries in the catalog dictionary.
key | the key of which the associated value needs to be returned |
action | instance of iText.Kernel.Pdf.Action.PdfAction. |
|
inlinevirtual |
Sets collection dictionary that a conforming reader shall use to enhance the presentation of file attachments stored in the PDF document.
collection |
PdfCatalog instance with applied collection dictionary
|
inlinevirtual |
|
inlinevirtual |
A value specifying an action that shall be performed when the document is opened.
A value specifying an action that shall be performed when the document is opened. See ISO 32000-1, Table 28 – Entries in the catalog dictionary.
action | instance of iText.Kernel.Pdf.Action.PdfAction. |
|
inlinevirtual |
A value specifying a destination that shall be displayed when the document is opened.
A value specifying a destination that shall be displayed when the document is opened. See ISO 32000-1, Table 28 – Entries in the catalog dictionary.
destination | instance of iText.Kernel.Pdf.Navigation.PdfDestination. |
|
inlinevirtual |
This method sets a page layout of the document
pageLayout | page layout of the document |
PdfCatalog instance with applied page layout
|
inlinevirtual |
This method sets a page mode of the document.
This method sets a page mode of the document.
Valid values are: PdfName.UseNone
, PdfName.UseOutlines
, PdfName.UseThumbs
, PdfName.FullScreen
, PdfName.UseOC
, PdfName.UseAttachments
.
pageMode | page mode. |
|
inlinevirtual |
This method sets the document viewer preferences, specifying the way the document shall be displayed on the screen
preferences | document's viewer preferences |
PdfCatalog instance with applied viewer preferences