iText 8.0.2 API
iText.Kernel.Pdf.Canvas.CanvasGraphicsState Class Reference

This class is designed for internal usage. More...

Inheritance diagram for iText.Kernel.Pdf.Canvas.CanvasGraphicsState:
iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState

Public Member Functions

  CanvasGraphicsState (iText.Kernel.Pdf.Canvas.CanvasGraphicsState source)
  Copy constructor. More...
 
virtual void  UpdateFromExtGState (PdfDictionary extGState)
  Updates this object with the values from a dictionary. More...
 
virtual Matrix  GetCtm ()
 
Returns
current transformation matrix.

 
virtual void  UpdateCtm (float a, float b, float c, float d, float e, float f)
  Updates current transformation matrix. More...
 
virtual void  UpdateCtm (Matrix newCtm)
  Updates current transformation matrix. More...
 
virtual Color  GetFillColor ()
  Gets the current fill color. More...
 
virtual void  SetFillColor (Color fillColor)
  Sets the current fill color. More...
 
virtual Color  GetStrokeColor ()
  Gets the current stroke color. More...
 
virtual void  SetStrokeColor (Color strokeColor)
  Sets the current stroke color. More...
 
virtual float  GetLineWidth ()
  Gets the current line width. More...
 
virtual void  SetLineWidth (float lineWidth)
  Sets the current line width. More...
 
virtual int  GetLineCapStyle ()
  Gets the current line cap style, see ISO-320001, 8.4.3.3 Line Cap Style. More...
 
virtual void  SetLineCapStyle (int lineCapStyle)
  Sets the current line cap style, see ISO-320001, 8.4.3.3 Line Cap Style. More...
 
virtual int  GetLineJoinStyle ()
  Gets the current line join style, see ISO-320001, 8.4.3.4 Line Join Style. More...
 
virtual void  SetLineJoinStyle (int lineJoinStyle)
  Sets the current line join style, see ISO-320001, 8.4.3.4 Line Join Style. More...
 
virtual float  GetMiterLimit ()
  Gets the current miter limit, see ISO-320001, 8.4.3.5 Miter Limit. More...
 
virtual void  SetMiterLimit (float miterLimit)
  Sets the current miter limit, see ISO-320001, 8.4.3.5 Miter Limit. More...
 
virtual PdfArray  GetDashPattern ()
  Gets line dash pattern value, D key, see ISO-320001, 8.4.3.6 Line Dash Pattern, iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern(iText.Kernel.Pdf.PdfArray). More...
 
virtual void  SetDashPattern (PdfArray dashPattern)
  Sets line dash pattern value, D key, see ISO-320001, 8.4.3.6 Line Dash Pattern, iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern(iText.Kernel.Pdf.PdfArray). More...
 
virtual PdfName  GetRenderingIntent ()
  Gets the rendering intent, see iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent(). More...
 
virtual void  SetRenderingIntent (PdfName renderingIntent)
  Sets the rendering intent, see iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent(). More...
 
virtual float  GetFontSize ()
  Gets the font size. More...
 
virtual void  SetFontSize (float fontSize)
  Sets the font size. More...
 
virtual PdfFont  GetFont ()
  Gets the current iText.Kernel.Font.PdfFont. More...
 
virtual void  SetFont (PdfFont font)
  Sets the current iText.Kernel.Font.PdfFont. More...
 
virtual int  GetTextRenderingMode ()
  Gets the current Text Rendering Mode, see ISO-320001, 9.3.6 Text Rendering Mode, PdfCanvas.SetTextRenderingMode(int). More...
 
virtual void  SetTextRenderingMode (int textRenderingMode)
  Sets the current Text Rendering Mode, see ISO-320001, 9.3.6 Text Rendering Mode, PdfCanvas.SetTextRenderingMode(int). More...
 
virtual float  GetTextRise ()
  Get the current Text Rise, see ISO-320001, 9.3.7 Text Rise, PdfCanvas.SetTextRise(float). More...
 
virtual void  SetTextRise (float textRise)
  Set the current Text Rise, see ISO-320001, 9.3.7 Text Rise PdfCanvas.SetTextRise(float). More...
 
virtual float  GetFlatnessTolerance ()
  Gets the current Flatness Tolerance, see ISO-320001, 10.6.2 Flatness Tolerance, PdfCanvas.SetFlatnessTolerance(float). More...
 
virtual void  SetFlatnessTolerance (float flatnessTolerance)
  Sets the current Flatness Tolerance, see ISO-320001, 10.6.2 Flatness Tolerance, PdfCanvas.SetFlatnessTolerance(float). More...
 
virtual void  SetWordSpacing (float wordSpacing)
  Sets the Word Spacing, see ISO-320001, 9.3.3 Word Spacing, PdfCanvas.SetWordSpacing(float). More...
 
virtual float  GetWordSpacing ()
  Gets the current Word Spacing, see ISO-320001, 9.3.3 Word Spacing, PdfCanvas.SetWordSpacing(float) More...
 
virtual void  SetCharSpacing (float characterSpacing)
  Sets the Character Spacing, see ISO-320001, 9.3.2 Character Spacing, PdfCanvas.SetCharacterSpacing(float) More...
 
virtual float  GetCharSpacing ()
  Gets the current Character Spacing, see ISO-320001, 9.3.2 Character Spacing, PdfCanvas.SetCharacterSpacing(float). More...
 
virtual float  GetLeading ()
  Gets the current Leading, see ISO-320001, 9.3.5 Leading, PdfCanvas.SetLeading(float). More...
 
virtual void  SetLeading (float leading)
  Sets the Leading, see ISO-320001, 9.3.5 Leading, PdfCanvas.SetLeading(float). More...
 
virtual float  GetHorizontalScaling ()
  Gets the current Horizontal Scaling percentage, see ISO-320001, 9.3.4 Horizontal Scaling. More...
 
virtual void  SetHorizontalScaling (float scale)
  Sets the Horizontal Scaling percentage for text, see ISO-320001, 9.3.4 Horizontal Scaling, PdfCanvas.SetHorizontalScaling(float). More...
 
virtual bool  GetStrokeOverprint ()
  Get the Stroke Overprint flag, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOverprintFlag(). More...
 
virtual bool  GetFillOverprint ()
  Get the Fill Overprint flag, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOverprintFlag(). More...
 
virtual int  GetOverprintMode ()
  Get the Overprint Mode, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetOverprintMode(). More...
 
virtual PdfObject  GetBlackGenerationFunction ()
  Gets the current Black-generation function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction(). More...
 
virtual PdfObject  GetBlackGenerationFunction2 ()
  Gets the current overruling Black-generation function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction2(). More...
 
virtual PdfObject  GetUnderColorRemovalFunction ()
  Gets the current Undercolor-removal function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction(). More...
 
virtual PdfObject  GetUnderColorRemovalFunction2 ()
  Gets the current overruling Undercolor-removal function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction2(). More...
 
virtual PdfObject  GetTransferFunction ()
  Gets the current Transfer function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction(). More...
 
virtual PdfObject  GetTransferFunction2 ()
  Gets the current overruling transer function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction2(). More...
 
virtual PdfObject  GetHalftone ()
  Gets the current halftone , see ISO32000-1, 10.5 Halftones and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetHalftone(). More...
 
virtual ? float  GetSmoothnessTolerance ()
  Gets the current Smoothness Tolerance, see ISO32000-1, 10.6.3 Smoothness Tolerance and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSmothnessTolerance(). More...
 
virtual bool  GetAutomaticStrokeAdjustment ()
  Gets the current Apply Automatic Stroke Adjustment flag, see ISO 32000-1, 10.6.5 Automatic Stroke Adjustment, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAutomaticStrokeAdjustmentFlag(). More...
 
virtual PdfObject  GetBlendMode ()
  Gets the current Blend Mode, see ISO 32000-1, 11.3.5 Blend Mode and 11.6.3 Specifying Blending Colour Space and Blend Mode, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlendMode(). More...
 
virtual PdfObject  GetSoftMask ()
  Gets the current Soft Mask, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity, 11.6.4.3 Mask Shape and Opacity and 11.6.5.2 Soft-Mask Dictionaries, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSoftMask(). More...
 
virtual float  GetStrokeOpacity ()
  Gets the current Stroke Opacity value, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.4 Constant Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOpacity(). More...
 
virtual float  GetFillOpacity ()
  Gets the current Fill Opacity value, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.4 Constant Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOpacity(). More...
 
virtual bool  GetAlphaIsShape ()
  Gets the current Alpha is shape flag, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.3 Mask Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAlphaSourceFlag() More...
 
virtual bool  GetTextKnockout ()
  Gets the current Text Knockout flag, see ISO 32000-1, 9.3.8 Text Knockout, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTextKnockoutFlag(). More...
 
virtual PdfObject  GetHTP ()
  Gets the current Halftone Phase, see Portable Document Format Reference Manual Version 1.2, 7.12 Extended graphics states and PostScript Language Reference Manual, Second Edition, 7.3.3, Halftone Phase. More...
 
virtual void  UpdateFromExtGState (PdfExtGState extGState)
  Updates current graphic state with values from extended graphic state dictionary. More...
 

Detailed Description

This class is designed for internal usage.

This class is designed for internal usage.
Use PdfExtGState class and PdfCanvas::setExtGState() method for setting extended graphics properties.

Constructor & Destructor Documentation

◆ CanvasGraphicsState()

iText.Kernel.Pdf.Canvas.CanvasGraphicsState.CanvasGraphicsState ( iText.Kernel.Pdf.Canvas.CanvasGraphicsState  source )
inline

Copy constructor.

Parameters
source the Graphics State to copy from

Member Function Documentation

◆ GetAlphaIsShape()

virtual bool iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetAlphaIsShape ( )
inlinevirtual

Gets the current Alpha is shape flag, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.3 Mask Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAlphaSourceFlag()

Returns
The current alpha is shape flag.

◆ GetAutomaticStrokeAdjustment()

virtual bool iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetAutomaticStrokeAdjustment ( )
inlinevirtual

Gets the current Apply Automatic Stroke Adjustment flag, see ISO 32000-1, 10.6.5 Automatic Stroke Adjustment, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAutomaticStrokeAdjustmentFlag().

Returns
The current automatic stroke adjustment flag.

◆ GetBlackGenerationFunction()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetBlackGenerationFunction ( )
inlinevirtual

Gets the current Black-generation function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction().

Returns
the current black-generation function.

◆ GetBlackGenerationFunction2()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetBlackGenerationFunction2 ( )
inlinevirtual

Gets the current overruling Black-generation function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction2().

Returns
the current overruling black-generation function.

◆ GetBlendMode()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetBlendMode ( )
inlinevirtual

Gets the current Blend Mode, see ISO 32000-1, 11.3.5 Blend Mode and 11.6.3 Specifying Blending Colour Space and Blend Mode, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlendMode().

Returns
The current blend mode.

◆ GetCharSpacing()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetCharSpacing ( )
inlinevirtual

Gets the current Character Spacing, see ISO-320001, 9.3.2 Character Spacing, PdfCanvas.SetCharacterSpacing(float).

Returns
The current character spacing value.

◆ GetDashPattern()

virtual PdfArray iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetDashPattern ( )
inlinevirtual

Gets line dash pattern value, D key, see ISO-320001, 8.4.3.6 Line Dash Pattern, iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern(iText.Kernel.Pdf.PdfArray).

Returns
a PdfArray , that represents line dash pattern.

◆ GetFillColor()

virtual Color iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetFillColor ( )
inlinevirtual

Gets the current fill color.

Returns
The canvas graphics state fill color

◆ GetFillOpacity()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetFillOpacity ( )
inlinevirtual

Gets the current Fill Opacity value, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.4 Constant Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOpacity().

Returns
the current fill opacity value.

◆ GetFillOverprint()

virtual bool iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetFillOverprint ( )
inlinevirtual

Get the Fill Overprint flag, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOverprintFlag().

Returns
The current stroke overprint flag.

◆ GetFlatnessTolerance()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetFlatnessTolerance ( )
inlinevirtual

Gets the current Flatness Tolerance, see ISO-320001, 10.6.2 Flatness Tolerance, PdfCanvas.SetFlatnessTolerance(float).

Returns
The current flatness tolerance.

◆ GetFont()

virtual PdfFont iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetFont ( )
inlinevirtual

Gets the current iText.Kernel.Font.PdfFont.

Returns
The current iText.Kernel.Font.PdfFont.

◆ GetFontSize()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetFontSize ( )
inlinevirtual

Gets the font size.

Returns
The current font size.

◆ GetHalftone()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetHalftone ( )
inlinevirtual

Gets the current halftone , see ISO32000-1, 10.5 Halftones and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetHalftone().

Returns
the current halftone.

◆ GetHorizontalScaling()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetHorizontalScaling ( )
inlinevirtual

Gets the current Horizontal Scaling percentage, see ISO-320001, 9.3.4 Horizontal Scaling.

Gets the current Horizontal Scaling percentage, see ISO-320001, 9.3.4 Horizontal Scaling. PdfCanvas.SetHorizontalScaling(float).

Returns
The current horizontal scaling factor.

◆ GetHTP()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetHTP ( )
inlinevirtual

Gets the current Halftone Phase, see Portable Document Format Reference Manual Version 1.2, 7.12 Extended graphics states and PostScript Language Reference Manual, Second Edition, 7.3.3, Halftone Phase.

Returns
the current halftone phase.

◆ GetLeading()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetLeading ( )
inlinevirtual

Gets the current Leading, see ISO-320001, 9.3.5 Leading, PdfCanvas.SetLeading(float).

Returns
The current leading value.

◆ GetLineCapStyle()

virtual int iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetLineCapStyle ( )
inlinevirtual

Gets the current line cap style, see ISO-320001, 8.4.3.3 Line Cap Style.

Returns
The current cap style.
See also
PdfCanvas.SetLineCapStyle(int)

for more info.

◆ GetLineJoinStyle()

virtual int iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetLineJoinStyle ( )
inlinevirtual

Gets the current line join style, see ISO-320001, 8.4.3.4 Line Join Style.

Returns
The current line join style.
See also
PdfCanvas.SetLineJoinStyle(int)

for more info.

◆ GetLineWidth()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetLineWidth ( )
inlinevirtual

Gets the current line width.

Returns
The canvas graphics state line width.

◆ GetMiterLimit()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetMiterLimit ( )
inlinevirtual

Gets the current miter limit, see ISO-320001, 8.4.3.5 Miter Limit.

Returns
The current miter limit.
See also
PdfCanvas.SetMiterLimit(float)

for more info.

◆ GetOverprintMode()

virtual int iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetOverprintMode ( )
inlinevirtual

Get the Overprint Mode, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetOverprintMode().

Returns
The current overprint mode.

◆ GetRenderingIntent()

virtual PdfName iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetRenderingIntent ( )
inlinevirtual

Gets the rendering intent, see iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent().

Returns
the rendering intent name.

◆ GetSmoothnessTolerance()

virtual ? float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetSmoothnessTolerance ( )
inlinevirtual

Gets the current Smoothness Tolerance, see ISO32000-1, 10.6.3 Smoothness Tolerance and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSmothnessTolerance().

Returns
the current smoothness tolerance function.

◆ GetSoftMask()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetSoftMask ( )
inlinevirtual

Gets the current Soft Mask, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity, 11.6.4.3 Mask Shape and Opacity and 11.6.5.2 Soft-Mask Dictionaries, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSoftMask().

Returns
The current soft mask.

◆ GetStrokeColor()

virtual Color iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetStrokeColor ( )
inlinevirtual

Gets the current stroke color.

Returns
The canvas graphics state stroke color

◆ GetStrokeOpacity()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetStrokeOpacity ( )
inlinevirtual

Gets the current Stroke Opacity value, see ISO 32000-1, 11.3.7.2 Source Shape and Opacity and 11.6.4.4 Constant Shape and Opacity, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOpacity().

Returns
the current stroke opacity value.

◆ GetStrokeOverprint()

virtual bool iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetStrokeOverprint ( )
inlinevirtual

Get the Stroke Overprint flag, see ISO 32000-1, 8.6.7 Overprint Control and 11.7.4.5 Summary of Overprinting Behaviour, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOverprintFlag().

Returns
The current stroke overprint flag.

◆ GetTextKnockout()

virtual bool iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetTextKnockout ( )
inlinevirtual

Gets the current Text Knockout flag, see ISO 32000-1, 9.3.8 Text Knockout, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTextKnockoutFlag().

Returns
The current text knockout flag.

◆ GetTextRenderingMode()

virtual int iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetTextRenderingMode ( )
inlinevirtual

Gets the current Text Rendering Mode, see ISO-320001, 9.3.6 Text Rendering Mode, PdfCanvas.SetTextRenderingMode(int).

Returns
The current text rendering mode.

◆ GetTextRise()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetTextRise ( )
inlinevirtual

Get the current Text Rise, see ISO-320001, 9.3.7 Text Rise, PdfCanvas.SetTextRise(float).

Returns
The current text rise.

◆ GetTransferFunction()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetTransferFunction ( )
inlinevirtual

Gets the current Transfer function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction().

Returns
the current transfer function.

◆ GetTransferFunction2()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetTransferFunction2 ( )
inlinevirtual

Gets the current overruling transer function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction2().

Returns
the current overruling transer function.

◆ GetUnderColorRemovalFunction()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetUnderColorRemovalFunction ( )
inlinevirtual

Gets the current Undercolor-removal function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction().

Returns
the current black-generation function.

◆ GetUnderColorRemovalFunction2()

virtual PdfObject iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetUnderColorRemovalFunction2 ( )
inlinevirtual

Gets the current overruling Undercolor-removal function, see ISO32000-1, 11.7.5.3 Rendering Intent and Colour Conversions and Table 58 – Entries in a Graphics State Parameter Dictionary, iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction2().

Returns
the current undercolor-removal function.

◆ GetWordSpacing()

virtual float iText.Kernel.Pdf.Canvas.CanvasGraphicsState.GetWordSpacing ( )
inlinevirtual

Gets the current Word Spacing, see ISO-320001, 9.3.3 Word Spacing, PdfCanvas.SetWordSpacing(float)

Returns
The current word spacing

◆ SetCharSpacing()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetCharSpacing ( float  characterSpacing )
inlinevirtual

Sets the Character Spacing, see ISO-320001, 9.3.2 Character Spacing, PdfCanvas.SetCharacterSpacing(float)

Parameters
characterSpacing The new character spacing value.

◆ SetDashPattern()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetDashPattern ( PdfArray  dashPattern )
inlinevirtual

Sets line dash pattern value, D key, see ISO-320001, 8.4.3.6 Line Dash Pattern, iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern(iText.Kernel.Pdf.PdfArray).

Parameters
dashPattern a PdfArray , that represents line dash pattern.

◆ SetFillColor()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetFillColor ( Color  fillColor )
inlinevirtual

Sets the current fill color.

Parameters
fillColor The new fill color.

◆ SetFlatnessTolerance()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetFlatnessTolerance ( float  flatnessTolerance )
inlinevirtual

Sets the current Flatness Tolerance, see ISO-320001, 10.6.2 Flatness Tolerance, PdfCanvas.SetFlatnessTolerance(float).

Parameters
flatnessTolerance The new flatness tolerance value.

◆ SetFont()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetFont ( PdfFont  font )
inlinevirtual

Sets the current iText.Kernel.Font.PdfFont.

Parameters
font The new iText.Kernel.Font.PdfFont.

◆ SetFontSize()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetFontSize ( float  fontSize )
inlinevirtual

Sets the font size.

Parameters
fontSize The new font size.

◆ SetHorizontalScaling()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetHorizontalScaling ( float  scale )
inlinevirtual

Sets the Horizontal Scaling percentage for text, see ISO-320001, 9.3.4 Horizontal Scaling, PdfCanvas.SetHorizontalScaling(float).

Parameters
scale The new horizontal scaling factor.

◆ SetLeading()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetLeading ( float  leading )
inlinevirtual

Sets the Leading, see ISO-320001, 9.3.5 Leading, PdfCanvas.SetLeading(float).

Parameters
leading The new leading value.

◆ SetLineCapStyle()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetLineCapStyle ( int  lineCapStyle )
inlinevirtual

Sets the current line cap style, see ISO-320001, 8.4.3.3 Line Cap Style.

Parameters
lineCapStyle The new cap style value.
See also
PdfCanvas.SetLineCapStyle(int)

for more info.

◆ SetLineJoinStyle()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetLineJoinStyle ( int  lineJoinStyle )
inlinevirtual

Sets the current line join style, see ISO-320001, 8.4.3.4 Line Join Style.

Parameters
lineJoinStyle The new line join style value.
See also
PdfCanvas.SetLineJoinStyle(int)

for more info.

◆ SetLineWidth()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetLineWidth ( float  lineWidth )
inlinevirtual

Sets the current line width.

Parameters
lineWidth The new line width.

◆ SetMiterLimit()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetMiterLimit ( float  miterLimit )
inlinevirtual

Sets the current miter limit, see ISO-320001, 8.4.3.5 Miter Limit.

Parameters
miterLimit The new miter limit value.
See also
PdfCanvas.SetMiterLimit(float)

for more info.

◆ SetRenderingIntent()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetRenderingIntent ( PdfName  renderingIntent )
inlinevirtual

Sets the rendering intent, see iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent().

Parameters
renderingIntent the rendering intent name.

◆ SetStrokeColor()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetStrokeColor ( Color  strokeColor )
inlinevirtual

Sets the current stroke color.

Parameters
strokeColor The new stroke color.

◆ SetTextRenderingMode()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetTextRenderingMode ( int  textRenderingMode )
inlinevirtual

Sets the current Text Rendering Mode, see ISO-320001, 9.3.6 Text Rendering Mode, PdfCanvas.SetTextRenderingMode(int).

Parameters
textRenderingMode The new text rendering mode.

◆ SetTextRise()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetTextRise ( float  textRise )
inlinevirtual

Set the current Text Rise, see ISO-320001, 9.3.7 Text Rise PdfCanvas.SetTextRise(float).

Parameters
textRise The new text rise value.

◆ SetWordSpacing()

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.SetWordSpacing ( float  wordSpacing )
inlinevirtual

Sets the Word Spacing, see ISO-320001, 9.3.3 Word Spacing, PdfCanvas.SetWordSpacing(float).

Parameters
wordSpacing The new word spacing value.

◆ UpdateCtm() [1/2]

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.UpdateCtm ( float  a,
float  b,
float  c,
float  d,
float  e,
float  f 
)
inlinevirtual

Updates current transformation matrix.

Updates current transformation matrix. The third column will always be [0 0 1]

Parameters
a element at (1,1) of the transformation matrix
b element at (1,2) of the transformation matrix
c element at (2,1) of the transformation matrix
d element at (2,2) of the transformation matrix
e element at (3,1) of the transformation matrix
f element at (3,2) of the transformation matrix

◆ UpdateCtm() [2/2]

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.UpdateCtm ( Matrix  newCtm )
inlinevirtual

Updates current transformation matrix.

Parameters
newCtm new current transformation matrix.

Reimplemented in iText.Kernel.Pdf.Canvas.Parser.ParserGraphicsState.

◆ UpdateFromExtGState() [1/2]

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.UpdateFromExtGState ( PdfDictionary  extGState )
inlinevirtual

Updates this object with the values from a dictionary.

Parameters
extGState the dictionary containing source parameters

◆ UpdateFromExtGState() [2/2]

virtual void iText.Kernel.Pdf.Canvas.CanvasGraphicsState.UpdateFromExtGState ( PdfExtGState  extGState )
inlinevirtual

Updates current graphic state with values from extended graphic state dictionary.

Parameters
extGState the wrapper around the extended graphic state dictionary