iText.Kernel.Pdf.Collection.PdfCollection Class Reference

Inheritance diagram for iText.Kernel.Pdf.Collection.PdfCollection:

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 ()
	Gets the Collection schema dictionary. More...
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 ()
	Retrieves the document that will be initially presented in the user interface. More...
virtual iText.Kernel.Pdf.Collection.PdfCollection	SetView (int viewType)
	Sets the initial view. More...
virtual bool	IsViewDetails ()
	Check if view is in details mode. More...
virtual bool	IsViewTile ()
	Check if view is in tile mode. More...
virtual bool	IsViewHidden ()
	Check if view is hidden. More...
virtual iText.Kernel.Pdf.Collection.PdfCollection	SetSort (PdfCollectionSort sort)
	Sets the Collection sort dictionary. More...
virtual PdfCollectionSort	GetSort ()
	Getter for the Collection sort dictionary. 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 ()

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

GetInitialDocument()

virtual PdfString iText.Kernel.Pdf.Collection.PdfCollection.GetInitialDocument ( )

inlinevirtual

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

Returns

a pdf string that identifies an entry in the EmbeddedFiles name tree

GetSchema()

virtual PdfCollectionSchema iText.Kernel.Pdf.Collection.PdfCollection.GetSchema ( )

inlinevirtual

Gets the Collection schema dictionary.

Returns

the Collection schema dictionary

GetSort()

virtual PdfCollectionSort iText.Kernel.Pdf.Collection.PdfCollection.GetSort ( )

inlinevirtual

Getter for the Collection sort dictionary.

Returns

the Collection sort

IsViewDetails()

virtual bool iText.Kernel.Pdf.Collection.PdfCollection.IsViewDetails ( )

inlinevirtual

Check if view is in details mode.

Returns

true if view is in details mode and false otherwise

IsViewHidden()

virtual bool iText.Kernel.Pdf.Collection.PdfCollection.IsViewHidden ( )

inlinevirtual

Check if view is hidden.

Returns

true if view is hidden and false otherwise

IsViewTile()

virtual bool iText.Kernel.Pdf.Collection.PdfCollection.IsViewTile ( )

inlinevirtual

Check if view is in tile mode.

Returns

true if view is in tile mode and false otherwise

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

Returns

this instance to support fluent interface

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

Returns

this instance to support fluent interface

SetSort()

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

inlinevirtual

Sets the Collection sort dictionary.

Parameters

sort	is the Collection sort dictionary

Returns

this instance to support fluent interface

SetView()

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

inlinevirtual

Sets the initial view.

Parameters

viewType

is a type of view

Returns

this instance to support fluent interface

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