iText 8.0.5 API
iText.Svg.Xobject.SvgImageXObject Class Reference

A wrapper for Form XObject for SVG images. More...

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

Public Member Functions

  SvgImageXObject (Rectangle bBox, ISvgProcessorResult result, ResourceResolver resourceResolver)
  Creates a new instance of Form XObject for the SVG image. More...
 
virtual ISvgProcessorResult  GetResult ()
  Returns processor result containing the SVG information. More...
 
virtual ResourceResolver  GetResourceResolver ()
  Returns resource resolver for the SVG image. More...
 
virtual void  Generate (PdfDocument document)
  Processes xObject before first image generation to avoid drawing it twice or more. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.Xobject.PdfFormXObject
  PdfFormXObject (Rectangle bBox)
  Creates a new instance of Form XObject. More...
 
  PdfFormXObject (PdfStream pdfStream)
  Create PdfFormXObject instance by iText.Kernel.Pdf.PdfStream. More...
 
  PdfFormXObject (PdfPage page)
  Creates form XObject from page content. More...
 
  PdfFormXObject (WmfImageData image, PdfDocument pdfDocument)
  Creates a form XObject from iText.Kernel.Pdf.Canvas.Wmf.WmfImageData. More...
 
virtual PdfResources  GetResources ()
  Gets iText.Kernel.Pdf.PdfResources of the Form XObject. More...
 
virtual PdfArray  GetBBox ()
  Gets Form XObject's BBox, iText.Kernel.Pdf.PdfName.BBox key. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetBBox (PdfArray bBox)
  Sets Form XObject's BBox, iText.Kernel.Pdf.PdfName.BBox key. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetGroup (PdfTransparencyGroup transparency)
  Sets a group attributes dictionary indicating that the contents of the form XObject shall be treated as a group and specifying the attributes of that group. More...
 
override float  GetWidth ()
  Gets width based on XObject's BBox. More...
 
override float  GetHeight ()
  Gets height based on XObject's BBox. 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...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetProcessColorModel (PdfName model)
  Sets process color model for trap network appearance, iText.Kernel.Pdf.PdfName.PCM key. More...
 
virtual PdfName  GetProcessColorModel ()
  Gets process color model of trap network appearance, iText.Kernel.Pdf.PdfName.PCM key. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetSeparationColorNames (PdfArray colorNames)
  Sets separation color names for the trap network appearance, iText.Kernel.Pdf.PdfName.SeparationColorNames key. More...
 
virtual PdfArray  GetSeparationColorNames ()
  Gets separation color names of trap network appearance, iText.Kernel.Pdf.PdfName.SeparationColorNames key. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetTrapRegions (PdfArray regions)
  Sets an array of TrapRegion objects defining the page’s trapping zones and the associated trapping parameters, as described in Adobe Technical Note #5620, Portable Job Ticket Format. More...
 
virtual PdfArray  GetTrapRegions ()
  Gets an array of TrapRegion objects defining the page’s trapping zones and the associated trapping parameters, as described in Adobe Technical Note #5620, Portable Job Ticket Format. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetTrapStyles (PdfString trapStyles)
  Sets a human-readable text string that described this trap network to the user. More...
 
virtual PdfString  GetTrapStyles ()
  Gets a human-readable text string that described this trap network to the user. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  SetMarkStyle (PdfString markStyle)
  Sets a text string representing the printer’s mark in human-readable form. More...
 
virtual PdfString  GetMarkStyle ()
  Gets a text string representing the printer’s mark in human-readable form. More...
 
virtual iText.Kernel.Pdf.Xobject.PdfFormXObject  Put (PdfName key, PdfObject value)
  Puts the value into Image XObject dictionary and associates it with the specified key. More...
 
- Public Member Functions inherited from iText.Kernel.Pdf.Xobject.PdfXObject
virtual void  SetLayer (IPdfOCG layer)
  Sets the layer this XObject belongs to. 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 bool  IsFlushed ()
 

Additional Inherited Members

- Static Public Member Functions inherited from iText.Kernel.Pdf.Xobject.PdfFormXObject
static Rectangle  CalculateBBoxMultipliedByMatrix (iText.Kernel.Pdf.Xobject.PdfFormXObject form)
  Calculates the coordinates of the xObject BBox multiplied by the Matrix field. More...
 
- Static Public Member Functions inherited from iText.Kernel.Pdf.Xobject.PdfXObject
static iText.Kernel.Pdf.Xobject.PdfXObject  MakeXObject (PdfStream stream)
  Create PdfFormXObject or PdfImageXObject by iText.Kernel.Pdf.PdfStream. More...
 
static Rectangle  CalculateProportionallyFitRectangleWithWidth (iText.Kernel.Pdf.Xobject.PdfXObject xObject, float x, float y, float width)
  Calculates a rectangle with the specified coordinates and width, and the height is calculated in such a way that the original proportions of the xObject do not change. More...
 
static Rectangle  CalculateProportionallyFitRectangleWithHeight (iText.Kernel.Pdf.Xobject.PdfXObject xObject, float x, float y, float height)
  Calculates a rectangle with the specified coordinates and height, and the width is calculated in such a way that the original proportions of the xObject do not change. More...
 
- Package Functions inherited from iText.Kernel.Pdf.Xobject.PdfXObject
  PdfXObject (PdfStream pdfObject)
 
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< PdfStream >
  PdfObjectWrapper (T pdfObject)
 
virtual void  SetPdfObject (T pdfObject)
 
virtual void  SetForbidRelease ()
 
virtual void  UnsetForbidRelease ()
 
virtual void  EnsureUnderlyingObjectHasIndirectReference ()
 
- Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfStream >
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...
 
- Package Attributes inherited from iText.Kernel.Pdf.Xobject.PdfFormXObject
PdfResources  resources = null
 

Detailed Description

A wrapper for Form XObject for SVG images.

Constructor & Destructor Documentation

◆ SvgImageXObject()

iText.Svg.Xobject.SvgImageXObject.SvgImageXObject ( Rectangle  bBox,
ISvgProcessorResult  result,
ResourceResolver  resourceResolver 
)
inline

Creates a new instance of Form XObject for the SVG image.

Parameters
bBox the form XObject’s bounding box.
result processor result containing the SVG information.
resourceResolver

iText.StyledXmlParser.Resolver.Resource.ResourceResolver for the SVG image.

Member Function Documentation

◆ Generate()

virtual void iText.Svg.Xobject.SvgImageXObject.Generate ( PdfDocument  document )
inlinevirtual

Processes xObject before first image generation to avoid drawing it twice or more.

Processes xObject before first image generation to avoid drawing it twice or more. It allows to reuse the same Form XObject multiple times.

Parameters
document pdf that shall contain the SVG image.

◆ GetResourceResolver()

virtual ResourceResolver iText.Svg.Xobject.SvgImageXObject.GetResourceResolver ( )
inlinevirtual

Returns resource resolver for the SVG image.

Returns

iText.StyledXmlParser.Resolver.Resource.ResourceResolver instance

◆ GetResult()

virtual ISvgProcessorResult iText.Svg.Xobject.SvgImageXObject.GetResult ( )
inlinevirtual

Returns processor result containing the SVG information.

Returns
{ISvgProcessorResult} processor result.