The abstract PdfShading class that represents the Shading Dictionary PDF object. More...

Inheritance diagram for iText.Kernel.Pdf.Colorspace.PdfShading:

Classes
class	Axial
	The class that extends PdfShading class and is in charge of Shading Dictionary with axial type, that define a colour blend that varies along a linear axis between two endpoints and extends indefinitely perpendicular to that axis. More...

class	CoonsPatchMesh
	The class that extends PdfShading class and is in charge of Shading Dictionary with Coons Patch mesh type. More...

class	FreeFormGouraudShadedTriangleMesh
	The class that extends PdfShading class and is in charge of Shading Dictionary with free-form Gouraud-shaded triangle mesh type. More...

class	FunctionBased
	The class that extends PdfShading class and is in charge of Shading Dictionary with function-based type, that defines color at every point in the domain by a specified mathematical function. More...

class	LatticeFormGouraudShadedTriangleMesh
	The class that extends PdfShading class and is in charge of Shading Dictionary with lattice-form Gouraud-shaded triangle mesh type. More...

class	Radial
	The class that extends PdfShading class and is in charge of Shading Dictionary with radial type, that define a colour blend that varies between two circles. More...

class	TensorProductPatchMesh
	The class that extends PdfShading class and is in charge of Shading Dictionary with Tensor-Product Patch mesh type. More...

Public Member Functions
virtual int	GetShadingType ()
	Gets the shading type. More...

virtual PdfObject	GetColorSpace ()
	Gets the color space in which colour values shall be expressed. More...

virtual PdfObject	GetFunction ()
	Gets the function PdfObject that represents color transitions across the shading geometry. More...

virtual void	SetFunction (IPdfFunction function)
	Sets the function that represents color transitions across the shading geometry as one object. More...

virtual void	SetFunction (IPdfFunction[] functions)
	Sets the function object that represents color transitions across the shading geometry as an array of functions. 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 PdfShading	MakeShading (PdfDictionary shadingDictionary)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary with corresponding type. More...

Package Functions
	PdfShading (PdfDictionary pdfObject)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary. More...

	PdfShading (PdfDictionary pdfObject, int type, PdfColorSpace colorSpace)
	Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary , using provided type and colorspace. 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

The abstract PdfShading class that represents the Shading Dictionary PDF object.

Constructor & Destructor Documentation

◆ PdfShading() [1/2]

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

inlinepackage

Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary.

Parameters

pdfObject

iText.Kernel.Pdf.PdfDictionary from which the PdfShading object will be created.

◆ PdfShading() [2/2]

iText.Kernel.Pdf.Colorspace.PdfShading.PdfShading	(	PdfDictionary	pdfObject,
		int	type,
		PdfColorSpace	colorSpace
	)

inlinepackage

Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary , using provided type and colorspace.

Parameters

pdfObject

iText.Kernel.Pdf.PdfDictionary from which the PdfShading object will be created.

Parameters

type	type with which this PdfShading object will be created.
colorSpace

PdfColorSpace with which this PdfShading object will be created.

Member Function Documentation

◆ Flush()

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

◆ GetColorSpace()

virtual PdfObject iText.Kernel.Pdf.Colorspace.PdfShading.GetColorSpace ( )

inlinevirtual

Gets the color space in which colour values shall be expressed.

Returns

iText.Kernel.Pdf.PdfObject Color space

◆ GetFunction()

virtual PdfObject iText.Kernel.Pdf.Colorspace.PdfShading.GetFunction ( )

inlinevirtual

Gets the function PdfObject that represents color transitions across the shading geometry.

Returns

iText.Kernel.Pdf.PdfObject Function

◆ GetShadingType()

virtual int iText.Kernel.Pdf.Colorspace.PdfShading.GetShadingType ( )

inlinevirtual

Gets the shading type.

Returns: int value of iText.Kernel.Pdf.PdfName.ShadingType.

◆ IsWrappedObjectMustBeIndirect()

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

inlinepackagevirtual

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

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

◆ MakeShading()

static PdfShading iText.Kernel.Pdf.Colorspace.PdfShading.MakeShading ( PdfDictionary shadingDictionary )

inlinestatic

Creates the PdfShading object from the existing iText.Kernel.Pdf.PdfDictionary with corresponding type.

Parameters

shadingDictionary

iText.Kernel.Pdf.PdfDictionary from which the PdfShading object will be created.

Returns: Created PdfShading object.

◆ SetFunction() [1/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.SetFunction ( IPdfFunction function )

inlinevirtual

Sets the function that represents color transitions across the shading geometry as one object.

Parameters

function The iText.Kernel.Pdf.Function.IPdfFunction to set.

◆ SetFunction() [2/2]

virtual void iText.Kernel.Pdf.Colorspace.PdfShading.SetFunction ( IPdfFunction[] functions )

inlinevirtual

Sets the function object that represents color transitions across the shading geometry as an array of functions.

Parameters

functions The array of iText.Kernel.Pdf.Function.IPdfFunction to be set.

Classes

Public Member Functions

Static Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PdfShading() [1/2]

◆ PdfShading() [2/2]

Member Function Documentation

◆ Flush()

◆ GetColorSpace()

◆ GetFunction()

◆ GetShadingType()

◆ IsWrappedObjectMustBeIndirect()

◆ MakeShading()

◆ SetFunction() [1/2]

◆ SetFunction() [2/2]