iText 7 7.1.8 API
|
Public Member Functions |
|
abstract byte | GetObjectType () |
Gets object type. More... |
|
void | Flush () |
Flushes the object to the document. More... |
|
void | Flush (bool canBeInObjStm) |
Flushes the object to the document. More... |
|
virtual PdfIndirectReference | GetIndirectReference () |
Gets the indirect reference associated with the object. More... |
|
virtual bool | IsIndirect () |
Checks if object is indirect. More... |
|
virtual PdfObject | MakeIndirect (PdfDocument document, PdfIndirectReference reference) |
Marks object to be saved as indirect. More... |
|
virtual PdfObject | MakeIndirect (PdfDocument document) |
Marks object to be saved as indirect. More... |
|
virtual bool | IsFlushed () |
Indicates is the object has been flushed or not. More... |
|
virtual bool | IsModified () |
Indicates is the object has been set as modified or not. More... |
|
virtual PdfObject | Clone () |
Creates clone of the object which belongs to the same document as original object. More... |
|
virtual PdfObject | CopyTo (PdfDocument document) |
Copies object to a specified document. More... |
|
virtual PdfObject | CopyTo (PdfDocument document, bool allowDuplicating) |
Copies object to a specified document. More... |
|
virtual PdfObject | SetModified () |
Sets the 'modified' flag to the indirect object, the flag denotes that the object was modified since the document opening. More... |
|
virtual bool | IsReleaseForbidden () |
Checks if it's forbidden to release this PdfObject instance. Some objects are vital for the living period of PdfDocument or may be prevented from releasing by high-level entities dealing with the objects. Also it's not possible to release the objects that have been modified. More... |
|
virtual void | Release () |
virtual bool | IsNull () |
Checks if this More... |
|
virtual bool | IsBoolean () |
Checks if this More... |
|
virtual bool | IsNumber () |
Checks if this More... |
|
virtual bool | IsString () |
Checks if this More... |
|
virtual bool | IsName () |
Checks if this More... |
|
virtual bool | IsArray () |
Checks if this More... |
|
virtual bool | IsDictionary () |
Checks if this More... |
|
virtual bool | IsStream () |
Checks if this More... |
|
virtual bool | IsIndirectReference () |
Checks if this More... |
|
virtual bool | IsLiteral () |
Checks if this More... |
|
|
inlinevirtual |
Creates clone of the object which belongs to the same document as original object.
Creates clone of the object which belongs to the same document as original object. New object shall not be used in other documents.
|
inlinevirtual |
Copies object to a specified document.
Copies object to a specified document.
NOTE: Works only for objects that are read from document opened in reading mode, otherwise an exception is thrown.
document | document to copy object to. |
|
inlinevirtual |
Copies object to a specified document.
Copies object to a specified document.
NOTE: Works only for objects that are read from document opened in reading mode, otherwise an exception is thrown.
document | document to copy object to. |
allowDuplicating | indicates if to allow copy objects which already have been copied. If object is associated with any indirect reference and allowDuplicating is false then already existing reference will be returned instead of copying object. If allowDuplicating is true then object will be copied and new indirect reference will be assigned. |
|
inline |
Flushes the object to the document.
|
inline |
Flushes the object to the document.
canBeInObjStm | indicates whether object can be placed into object stream. |
|
inlinevirtual |
Gets the indirect reference associated with the object.
Gets the indirect reference associated with the object. The indirect reference is used when flushing object to the document.
|
pure virtual |
Gets object type.
Implemented in iText.Kernel.Pdf.PdfName, iText.Kernel.Pdf.PdfDictionary, iText.Kernel.Pdf.PdfArray, iText.Kernel.Pdf.PdfStream, iText.Kernel.Pdf.PdfIndirectReference, iText.Kernel.Pdf.PdfString, iText.Kernel.Pdf.PdfBoolean, iText.Kernel.Pdf.PdfNumber, iText.Kernel.Pdf.PdfLiteral, and iText.Kernel.Pdf.PdfNull.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Indicates is the object has been flushed or not.
|
inlinevirtual |
Checks if object is indirect.
Checks if object is indirect.
Note: Return value true
doesn't necessarily mean that indirect reference of this object is not null at the moment. Object could be marked as indirect and be transformed to indirect on flushing.
E.g. all PdfStreams are transformed to indirect objects when they are written, but they don't always have indirect references at any given moment.
true
if object is indirect or is to be indirect in the resultant document.
|
inlinevirtual |
Checks if this
PdfObject
is of the type PdfIndirectReference
.
false
|
inlinevirtual |
Checks if this
PdfObject
is of the type PdfLiteral
.
false
|
inlinevirtual |
Indicates is the object has been set as modified or not.
Indicates is the object has been set as modified or not. Useful for incremental updates (e.g. appendMode).
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Checks if it's forbidden to release this PdfObject instance. Some objects are vital for the living period of PdfDocument or may be prevented from releasing by high-level entities dealing with the objects. Also it's not possible to release the objects that have been modified.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Marks object to be saved as indirect.
document | a document the indirect reference will belong to. |
|
inlinevirtual |
Marks object to be saved as indirect.
document | a document the indirect reference will belong to. |
Reimplemented in iText.Kernel.Pdf.PdfPrimitiveObject.
|
inlinevirtual |
Sets the 'modified' flag to the indirect object, the flag denotes that the object was modified since the document opening.
Sets the 'modified' flag to the indirect object, the flag denotes that the object was modified since the document opening.
This flag is meaningful only if the PdfDocument is opened in append mode (see StampingProperties.UseAppendMode() ).
In append mode the whole document is preserved as is, and only changes to the document are appended to the end of the document file. Because of this, only modified objects need to be flushed and are allowed to be flushed (i.e. to be written).