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

Public Member Functions

  PdfCollectionItem (PdfCollectionSchema schema)
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionItem  AddItem (String key, String value)
  Sets the value of the collection item. More...
 
virtual void  AddItem (String key, PdfDate date)
  Sets the date value of the collection item. More...
 
virtual void  AddItem (String key, PdfNumber number)
  Sets the number value of the collection item. More...
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionItem  SetPrefix (String key, String prefix)
  Adds a prefix for the Collection item. 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...
 

Member Function Documentation

◆ AddItem() [1/3]

virtual void iText.Kernel.Pdf.Collection.PdfCollectionItem.AddItem ( String  key,
PdfDate  date 
)
inlinevirtual

Sets the date value of the collection item.

Parameters
key is a key with which the specified date value is to be associated
date is a PDF date value to be associated with the specified key

◆ AddItem() [2/3]

virtual void iText.Kernel.Pdf.Collection.PdfCollectionItem.AddItem ( String  key,
PdfNumber  number 
)
inlinevirtual

Sets the number value of the collection item.

Parameters
key is a key with which the specified number value is to be associated
number is a PDF number value to be associated with the specified key

◆ AddItem() [3/3]

virtual iText.Kernel.Pdf.Collection.PdfCollectionItem iText.Kernel.Pdf.Collection.PdfCollectionItem.AddItem ( String  key,
String  value 
)
inlinevirtual

Sets the value of the collection item.

Parameters
key is a key with which the specified value is to be associated
value is a value to be associated with the specified key
Returns
this instance to support fluent interface

◆ IsWrappedObjectMustBeIndirect()

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

◆ SetPrefix()

virtual iText.Kernel.Pdf.Collection.PdfCollectionItem iText.Kernel.Pdf.Collection.PdfCollectionItem.SetPrefix ( String  key,
String  prefix 
)
inlinevirtual

Adds a prefix for the Collection item.

Adds a prefix for the Collection item. You can only use this method after you have set the value of the item.

Parameters
key is a key identifying the Collection item
prefix is a prefix to be added
Returns
this instance to support fluent interface