Class PdfShading.Axial

Namespace

iText.Kernel.Pdf.Colorspace

Assembly

itext.kernel.dll

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.

public class PdfShading.Axial : PdfShading

Inheritance

object

PdfObjectWrapper<PdfDictionary>

PdfShading

PdfShading.Axial

Inherited Members

PdfShading.MakeShading(PdfDictionary)

PdfShading.GetShadingType()

PdfShading.GetColorSpace()

PdfShading.GetFunction()

PdfShading.SetFunction(IPdfFunction)

PdfShading.SetFunction(IPdfFunction[])

PdfShading.Flush()

PdfShading.IsWrappedObjectMustBeIndirect()

PdfObjectWrapper<PdfDictionary>.GetPdfObject()

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfDictionary>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfDictionary>.SetModified()

PdfObjectWrapper<PdfDictionary>.IsFlushed()

PdfObjectWrapper<PdfDictionary>.SetPdfObject(PdfDictionary)

PdfObjectWrapper<PdfDictionary>.SetForbidRelease()

PdfObjectWrapper<PdfDictionary>.UnsetForbidRelease()

PdfObjectWrapper<PdfDictionary>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfDictionary>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfDictionary>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Axial(PdfColorSpace, float, float, float[], float, float, float[])

Creates the new instance of the class.

public Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

x0 float

the start coordinate of X axis expressed in the shading's target coordinate space.

y0 float

the start coordinate of Y axis expressed in the shading's target coordinate space.

color0 float[]

the float[] that represents the color in the start point.

x1 float

the end coordinate of X axis expressed in the shading's target coordinate space.

y1 float

the end coordinate of Y axis expressed in the shading's target coordinate space.

color1 float[]

the float[] that represents the color in the end point.

Axial(PdfColorSpace, float, float, float[], float, float, float[], bool[])

Creates the new instance of the class.

public Axial(PdfColorSpace cs, float x0, float y0, float[] color0, float x1, float y1, float[] color1, bool[] extend)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

x0 float

the start coordinate of X axis expressed in the shading's target coordinate space.

y0 float

the start coordinate of Y axis expressed in the shading's target coordinate space.

color0 float[]

the float[] that represents the color in the start point.

x1 float

the end coordinate of X axis expressed in the shading's target coordinate space.

y1 float

the end coordinate of Y axis expressed in the shading's target coordinate space.

color1 float[]

the float[] that represents the color in the end point.

extend bool[]

the array of two booleans that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

Axial(PdfColorSpace, PdfArray, IPdfFunction)

Creates the new instance of the class.

public Axial(PdfColorSpace cs, PdfArray coords, IPdfFunction function)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

coords PdfArray

the PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

function IPdfFunction

the IPdfFunction object, that is used to calculate color transitions.

Axial(PdfColorSpace, PdfArray, PdfArray, IPdfFunction)

Creates the new instance of the class.

public Axial(PdfColorSpace cs, PdfArray coords, PdfArray domain, IPdfFunction function)

Parameters

cs PdfColorSpace

the PdfColorSpace object in which colour values shall be expressed. The special Pattern space isn't excepted.

coords PdfArray

the PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

domain PdfArray

the PdfArray of two numbers [t0 t1] specifying the limiting values of a parametric variable t which is considered to vary linearly between these two values and becomes the input argument to the colour function.

function IPdfFunction

the IPdfFunction object, that is used to calculate color transitions.

Axial(PdfDictionary)

Creates the new instance of the class from the existing PdfDictionary.

protected Axial(PdfDictionary pdfDictionary)

Parameters

pdfDictionary PdfDictionary

from which this PdfShading.Axial will be created

Methods

GetCoords()

Gets the Coords object - a PdfArray of four numbers [x0 y0 x1 y1] that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

public virtual PdfArray GetCoords()

Returns

PdfArray

the PdfArray Coords object.

GetDomain()

Gets the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

public virtual PdfArray GetDomain()

Returns

PdfArray

the PdfArray of Domain object ([0.0 1.0] by default)

GetExtend()

Gets the PdfArray of two boolean that specified whether to extend the shading beyond the starting and ending points of the axis, respectively.

public virtual PdfArray GetExtend()

Returns

PdfArray

the PdfArray of Extended object ([false false] by default)

SetCoords(float, float, float, float)

Sets the Choords object with the four params expressed in the shading's target coordinate space.

public virtual void SetCoords(float x0, float y0, float x1, float y1)

Parameters

x0 float

the start coordinate of X axis to be set.

y0 float

the start coordinate of Y axis to be set.

x1 float

the end coordinate of X axis to be set.

y1 float

the end coordinate of Y axis to be set.

SetCoords(PdfArray)

Sets the Choords object with the PdfArray of four numbers [x0 y0 x1 y1], that specified the starting and the endings coordinates of thew axis, expressed in the shading's target coordinate space.

public virtual void SetCoords(PdfArray coords)

Parameters

coords PdfArray

the Chords PdfArray to be set.

SetDomain(float, float)

Sets the Domain with the array of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

public virtual void SetDomain(float t0, float t1)

Parameters

t0 float

first limit of variable t

t1 float

second limit of variable t

SetDomain(PdfArray)

Sets the Domain with the PdfArray of two float [t0, t1] that represent the limiting values of a parametric variable t, that becomes an input of color function(s).

public virtual void SetDomain(PdfArray domain)

Parameters

domain PdfArray

the PdfArray that represents domain

SetExtend(bool, bool)

Sets the Extend object with the two boolean value.

public virtual void SetExtend(bool extendStart, bool extendEnd)

Parameters

extendStart bool

if true will extend shading beyond the starting point of Coords

extendEnd bool

if true will extend shading beyond the ending point of Coords

SetExtend(PdfArray)

Sets the Extend object with the PdfArray of two boolean.

public virtual void SetExtend(PdfArray extend)

Parameters

extend PdfArray

the PdfArray representing Extend object

Remarks

Sets the Extend object with the PdfArray of two boolean. If first is true shading will extend beyond the starting point of Coords. If second is true shading will extend beyond the ending point of Coords.