iText 7 7.1.9 API
iText.Kernel.Pdf.Colorspace.PdfPattern Class Reference

Dictionary wrapper that represent special type of color space, that uses pattern objects as the equivalent of colour values instead of the numeric component values used with other spaces. More...

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfPattern:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary > iText.Kernel.Pdf.Colorspace.PdfPattern.Shading iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling

Classes

class   Shading
 
class   Tiling
  Wrapper that represents tiling pattern of color space. More...
 

Public Member Functions

virtual PdfArray  GetMatrix ()
  Gets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. More...
 
virtual void  SetMatrix (PdfArray matrix)
  Sets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. 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 ()
 

Static Public Member Functions

static iText.Kernel.Pdf.Colorspace.PdfPattern  GetPatternInstance (PdfDictionary pdfObject)
  Creates the instance wrapper of correct type from the iText.Kernel.Pdf.PdfDictionary More...
 

Detailed Description

Dictionary wrapper that represent special type of color space, that uses pattern objects as the equivalent of colour values instead of the numeric component values used with other spaces.

Dictionary wrapper that represent special type of color space, that uses pattern objects as the equivalent of colour values instead of the numeric component values used with other spaces. A pattern object shall be a dictionary or a stream, depending on the type of pattern. For mor information see paragraph 8.7 in ISO-32000-1.

Member Function Documentation

◆ Flush()

override void iText.Kernel.Pdf.Colorspace.PdfPattern.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<T>.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 >.

Reimplemented in iText.Kernel.Pdf.Colorspace.PdfPattern.Tiling.

◆ GetMatrix()

virtual PdfArray iText.Kernel.Pdf.Colorspace.PdfPattern.GetMatrix ( )
inlinevirtual

Gets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream.

Gets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. The concatenation of the pattern matrix with that of the parent content stream establishes the pattern coordinate space, within which all graphics objects in the pattern shall be interpreted.

Returns
pattern matrix

◆ GetPatternInstance()

static iText.Kernel.Pdf.Colorspace.PdfPattern iText.Kernel.Pdf.Colorspace.PdfPattern.GetPatternInstance ( PdfDictionary  pdfObject )
inlinestatic

Creates the instance wrapper of correct type from the iText.Kernel.Pdf.PdfDictionary

Parameters
pdfObject the iText.Kernel.Pdf.PdfDictionary that represent Pattern
Returns
new wrapper instance.

◆ SetMatrix()

virtual void iText.Kernel.Pdf.Colorspace.PdfPattern.SetMatrix ( PdfArray  matrix )
inlinevirtual

Sets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream.

Sets a transformation matrix that maps the pattern’s internal coordinate system to the default coordinate system of the pattern’s parent content stream. The concatenation of the pattern matrix with that of the parent content stream establishes the pattern coordinate space, within which all graphics objects in the pattern shall be interpreted.

Parameters
matrix pattern matrix to set