iText 7 7.1.9 API
iText.Kernel.Pdf.Extgstate.PdfExtGState Class Reference

Graphics state parameter dictionary wrapper. More...

Inheritance diagram for iText.Kernel.Pdf.Extgstate.PdfExtGState:
iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >

Public Member Functions

  PdfExtGState (PdfDictionary pdfObject)
  Create instance of graphics state parameter dictionary wrapper by existed iText.Kernel.Pdf.PdfDictionary object More...
 
  PdfExtGState ()
  Create default instance of graphics state parameter dictionary More...
 
virtual ? float  GetLineWidth ()
  Gets line width value, LW key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetLineWidth (float lineWidth)
  Sets line width value, LW key. More...
 
virtual ? int  GetLineCapStyle ()
  Gets line gap style value, LC key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetLineCapStyle (int lineCapStyle)
  Sets line gap style value, LC key. More...
 
virtual ? int  GetLineJoinStyle ()
  Gets line join style value, LJ key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetLineJoinStyle (int lineJoinStyle)
  Sets line join style value, LJ key. More...
 
virtual ? float  GetMiterLimit ()
  Gets miter limit value, ML key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetMiterLimit (float miterLimit)
  Sets miter limit value, ML key. More...
 
virtual PdfArray  GetDashPattern ()
  Gets line dash pattern value, D key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetDashPattern (PdfArray dashPattern)
  Sets line dash pattern value, D key. More...
 
virtual PdfName  GetRenderingIntent ()
  Gets rendering intent value, RI key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetRenderingIntent (PdfName renderingIntent)
  Sets rendering intent value, RI key. More...
 
virtual ? bool  GetStrokeOverprintFlag ()
  Get overprint flag value for stroking operations, OP key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetStrokeOverPrintFlag (bool strokeOverPrintFlag)
  Set overprint flag value for stroking operations, OP key. More...
 
virtual ? bool  GetFillOverprintFlag ()
  Get overprint flag value for non-stroking operations, op key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetFillOverPrintFlag (bool fillOverprintFlag)
  Set overprint flag value for non-stroking operations, op key. More...
 
virtual ? int  GetOverprintMode ()
  Get overprint control mode, OPM key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetOverprintMode (int overprintMode)
  Set overprint control mode, OPM key. More...
 
virtual PdfArray  GetFont ()
  Gets font and size, Font key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetFont (PdfArray font)
  Sets font and size, Font key. More...
 
virtual PdfObject  GetBlackGenerationFunction ()
  Gets the black-generation function value, BG. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetBlackGenerationFunction (PdfObject blackGenerationFunction)
  Sets the black-generation function value, BG. More...
 
virtual PdfObject  GetBlackGenerationFunction2 ()
  Gets the black-generation function value or Default , BG2 key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetBlackGenerationFunction2 (PdfObject blackGenerationFunction2)
  Sets the black-generation function value or Default , BG2 key. More...
 
virtual PdfObject  GetUndercolorRemovalFunction ()
  Gets the undercolor-removal function, UCR key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetUndercolorRemovalFunction (PdfObject undercolorRemovalFunction)
  Sets the undercolor-removal function, UCR key. More...
 
virtual PdfObject  GetUndercolorRemovalFunction2 ()
  Gets the undercolor-removal function value or Default , UCR2 key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetUndercolorRemovalFunction2 (PdfObject undercolorRemovalFunction2)
  Sets the undercolor-removal function value or Default , UCR2 key. More...
 
virtual PdfObject  GetTransferFunction ()
  Gets the transfer function value, TR key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetTransferFunction (PdfObject transferFunction)
  Sets the transfer function value, TR key. More...
 
virtual PdfObject  GetTransferFunction2 ()
  Gets the transfer function value or Default , TR2 key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetTransferFunction2 (PdfObject transferFunction2)
  Sets the transfer function value or Default , TR2 key. More...
 
virtual PdfObject  GetHalftone ()
  Gets the halftone dictionary, stream or Default , HT key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetHalftone (PdfObject halftone)
  Sets the halftone or Default , HT key. More...
 
virtual ? float  GetFlatnessTolerance ()
  Gets the flatness tolerance value, FL key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetFlatnessTolerance (float flatnessTolerance)
  Sets the flatness tolerance value, FL key. More...
 
virtual ? float  GetSmothnessTolerance ()
  Gets the smoothness tolerance value, SM key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetSmoothnessTolerance (float smoothnessTolerance)
  Sets the smoothness tolerance value, SM key. More...
 
virtual ? bool  GetAutomaticStrokeAdjustmentFlag ()
  Gets value of an automatic stroke adjustment flag, SA key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetAutomaticStrokeAdjustmentFlag (bool strokeAdjustment)
  Sets value of an automatic stroke adjustment flag, SA key. More...
 
virtual PdfObject  GetBlendMode ()
  Gets the current blend mode for the transparent imaging model, BM key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetBlendMode (PdfObject blendMode)
  Sets the current blend mode for the transparent imaging model, BM key. More...
 
virtual PdfObject  GetSoftMask ()
  Gets the current soft mask, SMask key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetSoftMask (PdfObject sMask)
  Sets the current soft mask, SMask key. More...
 
virtual ? float  GetStrokeOpacity ()
  Gets the current alpha constant, specifying the constant shape or constant opacity value for stroking operations in the transparent imaging model, CA key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetStrokeOpacity (float strokingAlphaConstant)
  Sets the current alpha constant, specifying the constant shape or constant opacity value for stroking operations in the transparent imaging model, CA key. More...
 
virtual ? float  GetFillOpacity ()
  Gets the current alpha constant, specifying the constant shape or constant opacity value for non-stroking operations in the transparent imaging model, ca key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetFillOpacity (float fillingAlphaConstant)
  Sets the current alpha constant, specifying the constant shape or constant opacity value for non-stroking operations in the transparent imaging model, ca key. More...
 
virtual ? bool  GetAlphaSourceFlag ()
  Gets the alpha source flag ("alpha is shape"), specifying whether the current soft mask and alpha constant shall be interpreted as shape values ( true ) or opacity values ( false ), AIS key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetAlphaSourceFlag (bool alphaSourceFlag)
  Sets the alpha source flag ("alpha is shape"), specifying whether the current soft mask and alpha constant shall be interpreted as shape values ( true ) or opacity values ( false ), AIS key. More...
 
virtual ? bool  GetTextKnockoutFlag ()
  Gets the text knockout flag, which determine the behaviour of overlapping glyphs within a text object in the transparent imaging model, TK key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetTextKnockoutFlag (bool textKnockoutFlag)
  Sets the text knockout flag, which determine the behaviour of overlapping glyphs within a text object in the transparent imaging model, TK key. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetUseBlackPointCompensation (bool useBlackPointCompensation)
  PDF 2.0. More...
 
virtual ? bool  IsBlackPointCompensationUsed ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  SetHalftoneOrigin (float x, float y)
  PDF 2.0. More...
 
virtual float[]  GetHalftoneOrigin ()
  PDF 2.0. More...
 
virtual iText.Kernel.Pdf.Extgstate.PdfExtGState  Put (PdfName key, PdfObject value)
  Puts the value into Graphics state parameter dictionary and associates it with the specified key. 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 Attributes

static PdfName  BM_NORMAL = PdfName.Normal
  Standard separable blend mode. More...
 
static PdfName  BM_MULTIPLY = PdfName.Multiply
  Standard separable blend mode. More...
 
static PdfName  BM_SCREEN = PdfName.Screen
  Standard separable blend mode. More...
 
static PdfName  BM_OVERLAY = PdfName.Overlay
  Standard separable blend mode. More...
 
static PdfName  BM_DARKEN = PdfName.Darken
  Standard separable blend mode. More...
 
static PdfName  BM_LIGHTEN = PdfName.Lighten
  Standard separable blend mode. More...
 
static PdfName  BM_COLOR_DODGE = PdfName.ColorDodge
  Standard separable blend mode. More...
 
static PdfName  BM_COLOR_BURN = PdfName.ColorBurn
  Standard separable blend mode. More...
 
static PdfName  BM_HARD_LIGHT = PdfName.HardLight
  Standard separable blend mode. More...
 
static PdfName  BM_SOFT_LIGHT = PdfName.SoftLight
  Standard separable blend mode. More...
 
static PdfName  BM_DIFFERENCE = PdfName.Difference
  Standard separable blend mode. More...
 
static PdfName  BM_EXCLUSION = PdfName.Exclusion
  Standard separable blend mode. More...
 
static PdfName  BM_HUE = PdfName.Hue
  Standard nonseparable blend mode. More...
 
static PdfName  BM_SATURATION = PdfName.Saturation
  Standard nonseparable blend mode. More...
 
static PdfName  BM_COLOR = PdfName.Color
  Standard nonseparable blend mode. More...
 
static PdfName  BM_LUMINOSITY = PdfName.Luminosity
  Standard nonseparable blend mode. More...
 

Detailed Description

Graphics state parameter dictionary wrapper.

Graphics state parameter dictionary wrapper. See ISO-320001, 8.4.5 Graphics State Parameter Dictionaries.

Constructor & Destructor Documentation

◆ PdfExtGState() [1/2]

iText.Kernel.Pdf.Extgstate.PdfExtGState.PdfExtGState ( PdfDictionary  pdfObject )
inline

Create instance of graphics state parameter dictionary wrapper by existed iText.Kernel.Pdf.PdfDictionary object

Parameters
pdfObject instance of graphics state parameter dictionary

◆ PdfExtGState() [2/2]

iText.Kernel.Pdf.Extgstate.PdfExtGState.PdfExtGState ( )
inline

Create default instance of graphics state parameter dictionary

Member Function Documentation

◆ Flush()

override void iText.Kernel.Pdf.Extgstate.PdfExtGState.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 >.

◆ GetAlphaSourceFlag()

virtual ? bool iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAlphaSourceFlag ( )
inlinevirtual

Gets the alpha source flag ("alpha is shape"), specifying whether the current soft mask and alpha constant shall be interpreted as shape values ( true ) or opacity values ( false ), AIS key.

Returns
a boolean value if exist, otherwise null.

◆ GetAutomaticStrokeAdjustmentFlag()

virtual ? bool iText.Kernel.Pdf.Extgstate.PdfExtGState.GetAutomaticStrokeAdjustmentFlag ( )
inlinevirtual

Gets value of an automatic stroke adjustment flag, SA key.

Returns
a boolean value if exist, otherwise null.

◆ GetBlackGenerationFunction()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction ( )
inlinevirtual

Gets the black-generation function value, BG.

Returns
a iText.Kernel.Pdf.PdfObject , should be iText.Kernel.Pdf.Function.PdfFunction.

◆ GetBlackGenerationFunction2()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlackGenerationFunction2 ( )
inlinevirtual

Gets the black-generation function value or Default , BG2 key.

Returns
a iText.Kernel.Pdf.PdfObject value, should be either iText.Kernel.Pdf.Function.PdfFunction or iText.Kernel.Pdf.PdfName.

◆ GetBlendMode()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetBlendMode ( )
inlinevirtual

Gets the current blend mode for the transparent imaging model, BM key.

Returns
a iText.Kernel.Pdf.PdfObject , should be either iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfArray . array is deprecated in PDF 2.0.

◆ GetDashPattern()

virtual PdfArray iText.Kernel.Pdf.Extgstate.PdfExtGState.GetDashPattern ( )
inlinevirtual

Gets line dash pattern value, D key.

Returns
a PdfArray , that represents line dash pattern.

◆ GetFillOpacity()

virtual ? float iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOpacity ( )
inlinevirtual

Gets the current alpha constant, specifying the constant shape or constant opacity value for non-stroking operations in the transparent imaging model, ca key.

Returns
a float value if exist, otherwise null.

◆ GetFillOverprintFlag()

virtual ? bool iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFillOverprintFlag ( )
inlinevirtual

Get overprint flag value for non-stroking operations, op key.

Returns
a boolean value if exist, otherwise null.

◆ GetFlatnessTolerance()

virtual ? float iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFlatnessTolerance ( )
inlinevirtual

Gets the flatness tolerance value, FL key.

Returns
a float value if exist, otherwise null.

◆ GetFont()

virtual PdfArray iText.Kernel.Pdf.Extgstate.PdfExtGState.GetFont ( )
inlinevirtual

Gets font and size, Font key.

Returns
a iText.Kernel.Pdf.PdfArray of the form [font size] , where font shall be an indirect reference to a font dictionary and size shall be a number expressed in text space units.

◆ GetHalftone()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetHalftone ( )
inlinevirtual

Gets the halftone dictionary, stream or Default , HT key.

Returns
a iText.Kernel.Pdf.PdfObject , should be either iText.Kernel.Pdf.PdfDictionary , iText.Kernel.Pdf.PdfStream or iText.Kernel.Pdf.PdfName.

◆ GetHalftoneOrigin()

virtual float [] iText.Kernel.Pdf.Extgstate.PdfExtGState.GetHalftoneOrigin ( )
inlinevirtual

PDF 2.0.

PDF 2.0. Gets halftone origin

Returns
an array of two values specifying X and Y values of the halftone origin in the current coordinate system, respectively, or null if halftone origin is not specified

◆ GetLineCapStyle()

virtual ? int iText.Kernel.Pdf.Extgstate.PdfExtGState.GetLineCapStyle ( )
inlinevirtual

Gets line gap style value, LC key.

Returns
0 - butt cap, 1 - round cap, 2 - projecting square cap.

◆ GetLineJoinStyle()

virtual ? int iText.Kernel.Pdf.Extgstate.PdfExtGState.GetLineJoinStyle ( )
inlinevirtual

Gets line join style value, LJ key.

Returns
0 - miter join (see also miter limit), 1 - round join, 2 - bevel join.

◆ GetLineWidth()

virtual ? float iText.Kernel.Pdf.Extgstate.PdfExtGState.GetLineWidth ( )
inlinevirtual

Gets line width value, LW key.

Returns
a float value if exist, otherwise null.

◆ GetMiterLimit()

virtual ? float iText.Kernel.Pdf.Extgstate.PdfExtGState.GetMiterLimit ( )
inlinevirtual

Gets miter limit value, ML key.

Gets miter limit value, ML key . See also line join style.

Returns
a float value if exist, otherwise null.

◆ GetOverprintMode()

virtual ? int iText.Kernel.Pdf.Extgstate.PdfExtGState.GetOverprintMode ( )
inlinevirtual

Get overprint control mode, OPM key.

Returns
an int value if exist, otherwise null.

◆ GetRenderingIntent()

virtual PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.GetRenderingIntent ( )
inlinevirtual

Gets rendering intent value, RI key.

Gets rendering intent value, RI key. Valid values are: AbsoluteColorimetric , RelativeColorimetric , Saturation , Perceptual.

Returns
a PdfName instance.

◆ GetSmothnessTolerance()

virtual ? float iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSmothnessTolerance ( )
inlinevirtual

Gets the smoothness tolerance value, SM key.

Returns
a float value if exist, otherwise null.

◆ GetSoftMask()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetSoftMask ( )
inlinevirtual

Gets the current soft mask, SMask key.

Returns
a iText.Kernel.Pdf.PdfObject , should be either iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfDictionary.

◆ GetStrokeOpacity()

virtual ? float iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOpacity ( )
inlinevirtual

Gets the current alpha constant, specifying the constant shape or constant opacity value for stroking operations in the transparent imaging model, CA key.

Returns
a float value if exist, otherwise null.

◆ GetStrokeOverprintFlag()

virtual ? bool iText.Kernel.Pdf.Extgstate.PdfExtGState.GetStrokeOverprintFlag ( )
inlinevirtual

Get overprint flag value for stroking operations, OP key.

Returns
a boolean value if exist, otherwise null.

◆ GetTextKnockoutFlag()

virtual ? bool iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTextKnockoutFlag ( )
inlinevirtual

Gets the text knockout flag, which determine the behaviour of overlapping glyphs within a text object in the transparent imaging model, TK key.

Returns
a boolean value if exist, otherwise null.

◆ GetTransferFunction()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction ( )
inlinevirtual

Gets the transfer function value, TR key.

Returns
a iText.Kernel.Pdf.PdfObject , should be either iText.Kernel.Pdf.Function.PdfFunction , iText.Kernel.Pdf.PdfArray or iText.Kernel.Pdf.PdfName.

◆ GetTransferFunction2()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetTransferFunction2 ( )
inlinevirtual

Gets the transfer function value or Default , TR2 key.

Returns
a iText.Kernel.Pdf.PdfObject , should be either iText.Kernel.Pdf.Function.PdfFunction , iText.Kernel.Pdf.PdfArray or iText.Kernel.Pdf.PdfName.

◆ GetUndercolorRemovalFunction()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction ( )
inlinevirtual

Gets the undercolor-removal function, UCR key.

Returns
a iText.Kernel.Pdf.PdfObject , should be iText.Kernel.Pdf.Function.PdfFunction.

◆ GetUndercolorRemovalFunction2()

virtual PdfObject iText.Kernel.Pdf.Extgstate.PdfExtGState.GetUndercolorRemovalFunction2 ( )
inlinevirtual

Gets the undercolor-removal function value or Default , UCR2 key.

Returns
a iText.Kernel.Pdf.PdfObject value, should be either iText.Kernel.Pdf.Function.PdfFunction or iText.Kernel.Pdf.PdfName.

◆ IsBlackPointCompensationUsed()

virtual ? bool iText.Kernel.Pdf.Extgstate.PdfExtGState.IsBlackPointCompensationUsed ( )
inlinevirtual

PDF 2.0.

PDF 2.0. Checks whether the black point compensation is performed while doing CIE-based colour conversions.

Returns
true if black point compensation is used, false if it is not used, or null is the value is set to Default, or not set at all

◆ Put()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.Put ( PdfName  key,
PdfObject  value 
)
inlinevirtual

Puts the value into Graphics state parameter dictionary and associates it with the specified key.

Puts the value into Graphics state parameter dictionary and associates it with the specified key. If the key is already present, it will override the old value with the specified one.

Parameters
key key to insert or to override
value the value to associate with the specified key
Returns
object itself.

◆ SetAlphaSourceFlag()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetAlphaSourceFlag ( bool  alphaSourceFlag )
inlinevirtual

Sets the alpha source flag ("alpha is shape"), specifying whether the current soft mask and alpha constant shall be interpreted as shape values ( true ) or opacity values ( false ), AIS key.

Parameters
alphaSourceFlag if true
  • alpha as shape values, if false — as opacity values.
Returns
object itself.

◆ SetAutomaticStrokeAdjustmentFlag()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetAutomaticStrokeAdjustmentFlag ( bool  strokeAdjustment )
inlinevirtual

Sets value of an automatic stroke adjustment flag, SA key.

Parameters
strokeAdjustment a boolean value.
Returns
object itself.

◆ SetBlackGenerationFunction()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetBlackGenerationFunction ( PdfObject  blackGenerationFunction )
inlinevirtual

Sets the black-generation function value, BG.

Parameters
blackGenerationFunction a iText.Kernel.Pdf.PdfObject , shall be iText.Kernel.Pdf.Function.PdfFunction.
Returns
object itself.

◆ SetBlackGenerationFunction2()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetBlackGenerationFunction2 ( PdfObject  blackGenerationFunction2 )
inlinevirtual

Sets the black-generation function value or Default , BG2 key.

Sets the black-generation function value or Default , BG2 key. Note, if both BG and BG2 are present in the same graphics state parameter dictionary, BG2 takes precedence.

Parameters
blackGenerationFunction2 a iText.Kernel.Pdf.PdfObject value, shall be either iText.Kernel.Pdf.Function.PdfFunction or Default.
Returns
object itself.

◆ SetBlendMode()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetBlendMode ( PdfObject  blendMode )
inlinevirtual

Sets the current blend mode for the transparent imaging model, BM key.

Parameters
blendMode a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfArray ; array is deprecated in PDF 2.0.
Returns
object itself.

◆ SetDashPattern()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetDashPattern ( PdfArray  dashPattern )
inlinevirtual

Sets line dash pattern value, D key.

Parameters
dashPattern a PdfArray , that represents line dash pattern.
Returns
object itself.

◆ SetFillOpacity()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetFillOpacity ( float  fillingAlphaConstant )
inlinevirtual

Sets the current alpha constant, specifying the constant shape or constant opacity value for non-stroking operations in the transparent imaging model, ca key.

Parameters
fillingAlphaConstant a float value.
Returns
object itself.

◆ SetFillOverPrintFlag()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetFillOverPrintFlag ( bool  fillOverprintFlag )
inlinevirtual

Set overprint flag value for non-stroking operations, op key.

Parameters
fillOverprintFlag

true , for applying overprint for non-stroking operations.

Returns
object itself.

◆ SetFlatnessTolerance()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetFlatnessTolerance ( float  flatnessTolerance )
inlinevirtual

Sets the flatness tolerance value, FL key.

Parameters
flatnessTolerance a float value.
Returns
object itself.

◆ SetFont()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetFont ( PdfArray  font )
inlinevirtual

Sets font and size, Font key.

Sets font and size, Font key. NOTE: If you want add the font object which has just been created, make sure to register the font with iText.Kernel.Pdf.PdfDocument.AddFont(iText.Kernel.Font.PdfFont) method first.

Parameters
font a iText.Kernel.Pdf.PdfArray of the form [font size] , where font shall be an indirect reference to a font dictionary and size shall be a number expressed in text space units.
Returns
object itself.

◆ SetHalftone()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetHalftone ( PdfObject  halftone )
inlinevirtual

Sets the halftone or Default , HT key.

Parameters
halftone a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.PdfDictionary , iText.Kernel.Pdf.PdfStream or iText.Kernel.Pdf.PdfName.
Returns
object itself.

◆ SetHalftoneOrigin()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetHalftoneOrigin ( float  x,
float  y 
)
inlinevirtual

PDF 2.0.

PDF 2.0. Sets halftone origin

Parameters
x X location of the halftone origin in the current coordinate system
y Y location of the halftone origin in the current coordinate system
Returns
this PdfExtGState instance

◆ SetLineCapStyle()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetLineCapStyle ( int  lineCapStyle )
inlinevirtual

Sets line gap style value, LC key.

Parameters
lineCapStyle 0 - butt cap, 1 - round cap, 2 - projecting square cap.
Returns
object itself.

◆ SetLineJoinStyle()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetLineJoinStyle ( int  lineJoinStyle )
inlinevirtual

Sets line join style value, LJ key.

Parameters
lineJoinStyle 0 - miter join (see also miter limit), 1 - round join, 2 - bevel join.
Returns
object itself.

◆ SetLineWidth()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetLineWidth ( float  lineWidth )
inlinevirtual

Sets line width value, LW key.

Parameters
lineWidth a float value.
Returns
object itself.

◆ SetMiterLimit()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetMiterLimit ( float  miterLimit )
inlinevirtual

Sets miter limit value, ML key.

Sets miter limit value, ML key . See also line join style.

Parameters
miterLimit a float value.
Returns
object itself.

◆ SetOverprintMode()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetOverprintMode ( int  overprintMode )
inlinevirtual

Set overprint control mode, OPM key.

Parameters
overprintMode an int value, see ISO-320001, 8.6.7 Overprint Control.
Returns
object itself.

◆ SetRenderingIntent()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetRenderingIntent ( PdfName  renderingIntent )
inlinevirtual

Sets rendering intent value, RI key.

Parameters
renderingIntent a PdfName instance, Valid values are: AbsoluteColorimetric , RelativeColorimetric , Saturation , Perceptual.
Returns
object itself.

◆ SetSmoothnessTolerance()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetSmoothnessTolerance ( float  smoothnessTolerance )
inlinevirtual

Sets the smoothness tolerance value, SM key.

Parameters
smoothnessTolerance a float value.
Returns
object itself.

◆ SetSoftMask()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetSoftMask ( PdfObject  sMask )
inlinevirtual

Sets the current soft mask, SMask key.

Parameters
sMask a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfDictionary.
Returns
object itself.

◆ SetStrokeOpacity()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetStrokeOpacity ( float  strokingAlphaConstant )
inlinevirtual

Sets the current alpha constant, specifying the constant shape or constant opacity value for stroking operations in the transparent imaging model, CA key.

Parameters
strokingAlphaConstant a float value.
Returns
object itself.

◆ SetStrokeOverPrintFlag()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetStrokeOverPrintFlag ( bool  strokeOverPrintFlag )
inlinevirtual

Set overprint flag value for stroking operations, OP key.

Parameters
strokeOverPrintFlag

true , for applying overprint for stroking operations.

Returns
object itself.

◆ SetTextKnockoutFlag()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetTextKnockoutFlag ( bool  textKnockoutFlag )
inlinevirtual

Sets the text knockout flag, which determine the behaviour of overlapping glyphs within a text object in the transparent imaging model, TK key.

Parameters
textKnockoutFlag

true if enabled.

Returns
object itself.

◆ SetTransferFunction()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetTransferFunction ( PdfObject  transferFunction )
inlinevirtual

Sets the transfer function value, TR key.

Parameters
transferFunction a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.Function.PdfFunction , iText.Kernel.Pdf.PdfArray or iText.Kernel.Pdf.PdfName.
Returns
object itself.

◆ SetTransferFunction2()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetTransferFunction2 ( PdfObject  transferFunction2 )
inlinevirtual

Sets the transfer function value or Default , TR2 key.

Sets the transfer function value or Default , TR2 key. Note, if both TR and TR2 are present in the same graphics state parameter dictionary, TR2 takes precedence.

Parameters
transferFunction2 a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.Function.PdfFunction , iText.Kernel.Pdf.PdfArray , iText.Kernel.Pdf.PdfName or Default.
Returns
object itself.

◆ SetUndercolorRemovalFunction()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetUndercolorRemovalFunction ( PdfObject  undercolorRemovalFunction )
inlinevirtual

Sets the undercolor-removal function, UCR key.

Parameters
undercolorRemovalFunction a iText.Kernel.Pdf.PdfObject , shall be iText.Kernel.Pdf.Function.PdfFunction.
Returns
object itself.

◆ SetUndercolorRemovalFunction2()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetUndercolorRemovalFunction2 ( PdfObject  undercolorRemovalFunction2 )
inlinevirtual

Sets the undercolor-removal function value or Default , UCR2 key.

Sets the undercolor-removal function value or Default , UCR2 key. Note, if both UCR and UCR2 are present in the same graphics state parameter dictionary, UCR2 takes precedence.

Parameters
undercolorRemovalFunction2 a iText.Kernel.Pdf.PdfObject value, shall be either iText.Kernel.Pdf.Function.PdfFunction or Default.
Returns
object itself.

◆ SetUseBlackPointCompensation()

virtual iText.Kernel.Pdf.Extgstate.PdfExtGState iText.Kernel.Pdf.Extgstate.PdfExtGState.SetUseBlackPointCompensation ( bool  useBlackPointCompensation )
inlinevirtual

PDF 2.0.

PDF 2.0. This graphics state parameter controls whether black point compensation is performed while doing CIE-based colour conversions.

Parameters
useBlackPointCompensation true to enable, false to disable
Returns
object itself

Member Data Documentation

◆ BM_COLOR

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_COLOR = PdfName.Color
static

Standard nonseparable blend mode.

Standard nonseparable blend mode. See ISO-320001, table 137

◆ BM_COLOR_BURN

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_COLOR_BURN = PdfName.ColorBurn
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_COLOR_DODGE

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_COLOR_DODGE = PdfName.ColorDodge
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_DARKEN

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_DARKEN = PdfName.Darken
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_DIFFERENCE

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_DIFFERENCE = PdfName.Difference
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_EXCLUSION

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_EXCLUSION = PdfName.Exclusion
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_HARD_LIGHT

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_HARD_LIGHT = PdfName.HardLight
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_HUE

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_HUE = PdfName.Hue
static

Standard nonseparable blend mode.

Standard nonseparable blend mode. See ISO-320001, table 137

◆ BM_LIGHTEN

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_LIGHTEN = PdfName.Lighten
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_LUMINOSITY

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_LUMINOSITY = PdfName.Luminosity
static

Standard nonseparable blend mode.

Standard nonseparable blend mode. See ISO-320001, table 137

◆ BM_MULTIPLY

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_MULTIPLY = PdfName.Multiply
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_NORMAL

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_NORMAL = PdfName.Normal
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_OVERLAY

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_OVERLAY = PdfName.Overlay
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_SATURATION

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_SATURATION = PdfName.Saturation
static

Standard nonseparable blend mode.

Standard nonseparable blend mode. See ISO-320001, table 137

◆ BM_SCREEN

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_SCREEN = PdfName.Screen
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136

◆ BM_SOFT_LIGHT

PdfName iText.Kernel.Pdf.Extgstate.PdfExtGState.BM_SOFT_LIGHT = PdfName.SoftLight
static

Standard separable blend mode.

Standard separable blend mode. See ISO-320001, table 136