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

Public Member Functions

  PdfCollectionSchema (PdfDictionary pdfObject)
 
  PdfCollectionSchema ()
  Creates a Collection Schema dictionary. More...
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionSchema  AddField (String name, PdfCollectionField field)
  Adds a Collection field to the Schema. More...
 
virtual PdfCollectionField  GetField (String name)
  Retrieves a Collection field from the Schema. 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

◆ PdfCollectionSchema()

iText.Kernel.Pdf.Collection.PdfCollectionSchema.PdfCollectionSchema ( )
inline

Creates a Collection Schema dictionary.

Member Function Documentation

◆ AddField()

virtual iText.Kernel.Pdf.Collection.PdfCollectionSchema iText.Kernel.Pdf.Collection.PdfCollectionSchema.AddField ( String  name,
PdfCollectionField  field 
)
inlinevirtual

Adds a Collection field to the Schema.

Parameters
name the name of the collection field
field a Collection Field
Returns
this instance to support fluent interface

◆ GetField()

virtual PdfCollectionField iText.Kernel.Pdf.Collection.PdfCollectionSchema.GetField ( String  name )
inlinevirtual

Retrieves a Collection field from the Schema.

Parameters
name is the name of the collection field
Returns
a Collection field

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Collection.PdfCollectionSchema.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 >.