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

Public Member Functions

  PdfCollection (PdfDictionary pdfObject)
 
  PdfCollection ()
  Constructs a PDF Collection. More...
 
virtual iText.Kernel.Pdf.Collection.PdfCollection  SetSchema (PdfCollectionSchema schema)
  Sets the Collection schema dictionary. More...
 
virtual PdfCollectionSchema  GetSchema ()
 
virtual iText.Kernel.Pdf.Collection.PdfCollection  SetInitialDocument (String documentName)
  Identifies the document that will be initially presented in the user interface. More...
 
virtual PdfString  GetInitialDocument ()
 
virtual iText.Kernel.Pdf.Collection.PdfCollection  SetView (int viewType)
  Sets the initial view. More...
 
virtual PdfNumber  GetView ()
 
virtual bool  IsViewDetails ()
 
virtual bool  IsViewTile ()
 
virtual bool  IsViewHidden ()
 
virtual iText.Kernel.Pdf.Collection.PdfCollection  SetSort (PdfCollectionSort sort)
  Sets the Collection sort dictionary. More...
 
virtual PdfCollectionSort  GetSort ()
 
- 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  DETAILS = 0
  A type of initial view More...
 
const int  TILE = 1
  A type of initial view More...
 
const int  HIDDEN = 2
  A type of initial view More...
 

Constructor & Destructor Documentation

◆ PdfCollection()

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

Constructs a PDF Collection.

Member Function Documentation

◆ SetInitialDocument()

virtual iText.Kernel.Pdf.Collection.PdfCollection iText.Kernel.Pdf.Collection.PdfCollection.SetInitialDocument ( String  documentName )
inlinevirtual

Identifies the document that will be initially presented in the user interface.

Parameters
documentName a string that identifies an entry in the EmbeddedFiles name tree

◆ SetSchema()

virtual iText.Kernel.Pdf.Collection.PdfCollection iText.Kernel.Pdf.Collection.PdfCollection.SetSchema ( PdfCollectionSchema  schema )
inlinevirtual

Sets the Collection schema dictionary.

Parameters
schema an overview of the collection fields

◆ SetSort()

virtual iText.Kernel.Pdf.Collection.PdfCollection iText.Kernel.Pdf.Collection.PdfCollection.SetSort ( PdfCollectionSort  sort )
inlinevirtual

Sets the Collection sort dictionary.

Parameters
sort

◆ SetView()

virtual iText.Kernel.Pdf.Collection.PdfCollection iText.Kernel.Pdf.Collection.PdfCollection.SetView ( int  viewType )
inlinevirtual

Sets the initial view.

Parameters
viewType

Member Data Documentation

◆ DETAILS

const int iText.Kernel.Pdf.Collection.PdfCollection.DETAILS = 0
static

A type of initial view

◆ HIDDEN

const int iText.Kernel.Pdf.Collection.PdfCollection.HIDDEN = 2
static

A type of initial view

◆ TILE

const int iText.Kernel.Pdf.Collection.PdfCollection.TILE = 1
static

A type of initial view