iText 7 7.1.9 API
iText.Kernel.Pdf.Xobject.PdfXObject Class Reference

An abstract wrapper for supported types of XObject. More...

Inheritance diagram for iText.Kernel.Pdf.Xobject.PdfXObject:
iText.Kernel.Pdf.PdfObjectWrapper< PdfStream > iText.Kernel.Pdf.Xobject.PdfFormXObject iText.Kernel.Pdf.Xobject.PdfImageXObject

Public Member Functions

virtual void  SetLayer (IPdfOCG layer)
  Sets the layer this XObject belongs to. More...
 
virtual float  GetWidth ()
  Gets width of XObject. More...
 
virtual float  GetHeight ()
  Gets height of XObject. More...
 
virtual void  AddAssociatedFile (PdfFileSpec fs)
  Adds file associated with PDF XObject and identifies the relationship between them. More...
 
virtual PdfArray  GetAssociatedFiles (bool create)
  Returns files associated with XObject. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfStream >
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 Member Functions

static iText.Kernel.Pdf.Xobject.PdfXObject  MakeXObject (PdfStream stream)
  Create PdfFormXObject or PdfImageXObject by iText.Kernel.Pdf.PdfStream. More...
 

Detailed Description

An abstract wrapper for supported types of XObject.

See also
PdfFormXObject, PdfImageXObject

Member Function Documentation

◆ AddAssociatedFile()

virtual void iText.Kernel.Pdf.Xobject.PdfXObject.AddAssociatedFile ( PdfFileSpec  fs )
inlinevirtual

Adds file associated with PDF XObject and identifies the relationship between them.

Adds file associated with PDF XObject and identifies the relationship between them. Associated files may be used in Pdf/A-3 and Pdf 2.0 documents. The method adds file to array value of the AF key in the XObject dictionary.

For associated files their associated file specification dictionaries shall include the AFRelationship key

Parameters
fs file specification dictionary of associated file

◆ GetAssociatedFiles()

virtual PdfArray iText.Kernel.Pdf.Xobject.PdfXObject.GetAssociatedFiles ( bool  create )
inlinevirtual

Returns files associated with XObject.

Returns
associated files array.

◆ GetHeight()

virtual float iText.Kernel.Pdf.Xobject.PdfXObject.GetHeight ( )
inlinevirtual

Gets height of XObject.

Returns
float value.

Reimplemented in iText.Kernel.Pdf.Xobject.PdfFormXObject, and iText.Kernel.Pdf.Xobject.PdfImageXObject.

◆ GetWidth()

virtual float iText.Kernel.Pdf.Xobject.PdfXObject.GetWidth ( )
inlinevirtual

Gets width of XObject.

Returns
float value.

Reimplemented in iText.Kernel.Pdf.Xobject.PdfFormXObject, and iText.Kernel.Pdf.Xobject.PdfImageXObject.

◆ MakeXObject()

static iText.Kernel.Pdf.Xobject.PdfXObject iText.Kernel.Pdf.Xobject.PdfXObject.MakeXObject ( PdfStream  stream )
inlinestatic

Create PdfFormXObject or PdfImageXObject by iText.Kernel.Pdf.PdfStream.

Parameters
stream

iText.Kernel.Pdf.PdfStream with either iText.Kernel.Pdf.PdfName.Form or iText.Kernel.Pdf.PdfName.Image

iText.Kernel.Pdf.PdfName.Subtype

Returns
either PdfFormXObject or PdfImageXObject.

◆ SetLayer()

virtual void iText.Kernel.Pdf.Xobject.PdfXObject.SetLayer ( IPdfOCG  layer )
inlinevirtual

Sets the layer this XObject belongs to.

Parameters
layer the layer this XObject belongs to.