This a wrapper around a rendition dictionary. More...

Inheritance diagram for iText.Kernel.Pdf.Action.PdfRendition:

Public Member Functions
	PdfRendition (PdfDictionary pdfObject)
	Creates a new wrapper around an existing iText.Kernel.Pdf.PdfDictionary More...

	PdfRendition (String file, PdfFileSpec fs, String mimeType)
	Creates a new wrapper around a newly created media rendition dictionary object. More...

override void	Flush ()
	To manually flush a `PdfObject` behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. 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 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...

Detailed Description

This a wrapper around a rendition dictionary.

This a wrapper around a rendition dictionary. See ISO 32000-1 sections 13.2.3.2, 13.2.3.3.

Constructor & Destructor Documentation

◆ PdfRendition() [1/2]

iText.Kernel.Pdf.Action.PdfRendition.PdfRendition ( PdfDictionary pdfObject )

inline

Creates a new wrapper around an existing iText.Kernel.Pdf.PdfDictionary

Parameters

pdfObject a rendition object to create a wrapper for

◆ PdfRendition() [2/2]

iText.Kernel.Pdf.Action.PdfRendition.PdfRendition	(	String	file,
		PdfFileSpec	fs,
		String	mimeType
	)

inline

Creates a new wrapper around a newly created media rendition dictionary object.

Parameters

file	a text string specifying the name of the file to display
fs	a file specification that specifies the actual media data
mimeType	an ASCII string identifying the type of data

Member Function Documentation

◆ Flush()

override void iText.Kernel.Pdf.Action.PdfRendition.Flush ( )

inlinevirtual

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference.

To manually flush a PdfObject behind this wrapper, you have to ensure that this object is added to the document, i.e. it has an indirect reference. Basically this means that before flushing you need to explicitly call iText.Kernel.Pdf.PdfObjectWrapper.MakeIndirect(iText.Kernel.Pdf.PdfDocument). For example: wrapperInstance.makeIndirect(document).flush(); Note that not every wrapper require this, only those that have such warning in documentation.

Reimplemented from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Action.PdfRendition.IsWrappedObjectMustBeIndirect ( )

inlinepackagevirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.

Public Member Functions

Package Functions