iText 7 7.1.8 API
iText.Kernel.Pdf.Collection.PdfCollectionField Class Reference
Inheritance diagram for iText.Kernel.Pdf.Collection.PdfCollectionField:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Member Functions

  PdfCollectionField (String name, int subType)
  Creates a PdfCollectionField. More...
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionField  SetOrder (int order)
  The relative order of the field name. More...
 
virtual PdfNumber  GetOrder ()
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionField  SetVisibility (bool visible)
  Sets the initial visibility of the field. More...
 
virtual PdfBoolean  GetVisibility ()
 
virtual iText.Kernel.Pdf.Collection.PdfCollectionField  SetEditable (bool editable)
  Indication if the field value should be editable in the viewer. More...
 
virtual PdfBoolean  GetEditable ()
 
virtual PdfObject  GetValue (String value)
 
- 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 ()
 

Static Public Attributes

const int  TEXT = 0
  A possible type of collection field. More...
 
const int  DATE = 1
  A possible type of collection field. More...
 
const int  NUMBER = 2
  A possible type of collection field. More...
 
const int  FILENAME = 3
  A possible type of collection field. More...
 
const int  DESC = 4
  A possible type of collection field. More...
 
const int  MODDATE = 5
  A possible type of collection field. More...
 
const int  CREATIONDATE = 6
  A possible type of collection field. More...
 
const int  SIZE = 7
  A possible type of collection field. More...
 

Constructor & Destructor Documentation

◆ PdfCollectionField()

iText.Kernel.Pdf.Collection.PdfCollectionField.PdfCollectionField ( String  name,
int  subType 
)
inline

Creates a PdfCollectionField.

Parameters
name the field name
subType the field subtype

Member Function Documentation

◆ SetEditable()

virtual iText.Kernel.Pdf.Collection.PdfCollectionField iText.Kernel.Pdf.Collection.PdfCollectionField.SetEditable ( bool  editable )
inlinevirtual

Indication if the field value should be editable in the viewer.

Parameters
editable

◆ SetOrder()

virtual iText.Kernel.Pdf.Collection.PdfCollectionField iText.Kernel.Pdf.Collection.PdfCollectionField.SetOrder ( int  order )
inlinevirtual

The relative order of the field name.

The relative order of the field name. Fields are sorted in ascending order.

Parameters
order a number indicating the order of the field

◆ SetVisibility()

virtual iText.Kernel.Pdf.Collection.PdfCollectionField iText.Kernel.Pdf.Collection.PdfCollectionField.SetVisibility ( bool  visible )
inlinevirtual

Sets the initial visibility of the field.

Parameters
visible

Member Data Documentation

◆ CREATIONDATE

const int iText.Kernel.Pdf.Collection.PdfCollectionField.CREATIONDATE = 6
static

A possible type of collection field.

◆ DATE

const int iText.Kernel.Pdf.Collection.PdfCollectionField.DATE = 1
static

A possible type of collection field.

◆ DESC

const int iText.Kernel.Pdf.Collection.PdfCollectionField.DESC = 4
static

A possible type of collection field.

◆ FILENAME

const int iText.Kernel.Pdf.Collection.PdfCollectionField.FILENAME = 3
static

A possible type of collection field.

◆ MODDATE

const int iText.Kernel.Pdf.Collection.PdfCollectionField.MODDATE = 5
static

A possible type of collection field.

◆ NUMBER

const int iText.Kernel.Pdf.Collection.PdfCollectionField.NUMBER = 2
static

A possible type of collection field.

◆ SIZE

const int iText.Kernel.Pdf.Collection.PdfCollectionField.SIZE = 7
static

A possible type of collection field.

◆ TEXT

const int iText.Kernel.Pdf.Collection.PdfCollectionField.TEXT = 0
static

A possible type of collection field.