iText 8.0.5 API
iText.Kernel.Pdf.Action.PdfMediaClipData Class Reference

This class is a wrapper of media clip data dictionary that defines the data for a media object that can be played. More...

Inheritance diagram for iText.Kernel.Pdf.Action.PdfMediaClipData:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Member Functions

  PdfMediaClipData (PdfDictionary pdfObject)
  Constructs a new PdfMediaClipData wrapper using an existing dictionary. More...
 
  PdfMediaClipData (String file, PdfFileSpec fs, String mimeType)
  Constructs a new PdfMediaClipData wrapper around a newly created dictionary. 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 class is a wrapper of media clip data dictionary that defines the data for a media object that can be played.

Constructor & Destructor Documentation

◆ PdfMediaClipData() [1/2]

iText.Kernel.Pdf.Action.PdfMediaClipData.PdfMediaClipData ( PdfDictionary  pdfObject )
inline

Constructs a new PdfMediaClipData wrapper using an existing dictionary.

Parameters
pdfObject the dictionary to construct the wrapper from

◆ PdfMediaClipData() [2/2]

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

Constructs a new PdfMediaClipData wrapper around a newly created dictionary.

Parameters
file the name of the file to create a media clip for
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.PdfMediaClipData.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.PdfMediaClipData.IsWrappedObjectMustBeIndirect ( )
inlinepackagevirtual

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

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