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:

Classes
class	Shading
	Shading pattern provides a smooth transition between colors across an area to be painted, independent of the resolution of any particular output device and without specifying the number of steps in the color transition. More...
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...

Package Functions
	PdfPattern (PdfDictionary pdfObject)
	Wraps the passed iText.Kernel.Pdf.PdfDictionary. More...
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

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.

Constructor & Destructor Documentation

PdfPattern()

iText.Kernel.Pdf.Colorspace.PdfPattern.PdfPattern ( PdfDictionary  pdfObject )

inlinepackage

Wraps the passed iText.Kernel.Pdf.PdfDictionary.

Parameters

pdfObject

the iText.Kernel.Pdf.PdfDictionary that represent Pattern

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.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.

IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Colorspace.PdfPattern.IsWrappedObjectMustBeIndirect ( )

inlinepackagevirtual

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

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

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns

true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

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

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