iText 8.0.2 API
|
Graphics state parameter dictionary wrapper. More...
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... |
|
![]() |
|
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... |
|
Graphics state parameter dictionary wrapper.
Graphics state parameter dictionary wrapper. See ISO-320001, 8.4.5 Graphics State Parameter Dictionaries.
|
inline |
Create instance of graphics state parameter dictionary wrapper by existed iText.Kernel.Pdf.PdfDictionary object
pdfObject | instance of graphics state parameter dictionary |
|
inline |
Create default instance of graphics state parameter dictionary
|
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
Reimplemented from iText.Kernel.Pdf.PdfObjectWrapper< PdfDictionary >.
|
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.
boolean
value if exist, otherwise null
.
|
inlinevirtual |
Gets value of an automatic stroke adjustment flag, SA
key.
boolean
value if exist, otherwise null
.
|
inlinevirtual |
Gets the black-generation function value, BG
.
|
inlinevirtual |
Gets the black-generation function value or Default
, BG2
key.
|
inlinevirtual |
Gets the current blend mode for the transparent imaging model, BM
key.
|
inlinevirtual |
Gets line dash pattern value, D
key.
PdfArray
, that represents line dash pattern.
|
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.
float
value if exist, otherwise null
.
|
inlinevirtual |
Get overprint flag value for non-stroking operations, op
key.
boolean
value if exist, otherwise null
.
|
inlinevirtual |
Gets the flatness tolerance value, FL
key.
float
value if exist, otherwise null
.
|
inlinevirtual |
Gets font and size, Font
key.
[font size]
, where font
shall be an indirect reference to a font dictionary and size
shall be a number expressed in text space units.
|
inlinevirtual |
Gets the halftone dictionary, stream or Default
, HT
key.
|
inlinevirtual |
PDF 2.0.
PDF 2.0. Gets halftone origin
null
if halftone origin is not specified
|
inlinevirtual |
Gets line gap style value, LC
key.
|
inlinevirtual |
Gets line join style value, LJ
key.
|
inlinevirtual |
Gets line width value, LW
key.
float
value if exist, otherwise null
.
|
inlinevirtual |
Gets miter limit value, ML key
.
Gets miter limit value, ML key
. See also line join style.
float
value if exist, otherwise null
.
|
inlinevirtual |
Get overprint control mode, OPM
key.
int
value if exist, otherwise null
.
|
inlinevirtual |
Gets rendering intent value, RI
key.
Gets rendering intent value, RI
key. Valid values are: AbsoluteColorimetric
, RelativeColorimetric
, Saturation
, Perceptual
.
PdfName
instance.
|
inlinevirtual |
Gets the smoothness tolerance value, SM
key.
float
value if exist, otherwise null
.
|
inlinevirtual |
Gets the current soft mask, SMask
key.
|
inlinevirtual |
Gets the current alpha constant, specifying the constant shape or constant opacity value for stroking operations in the transparent imaging model, CA
key.
float
value if exist, otherwise null
.
|
inlinevirtual |
Get overprint flag value for stroking operations, OP
key.
boolean
value if exist, otherwise null
.
|
inlinevirtual |
Gets the text knockout flag, which determine the behaviour of overlapping glyphs within a text object in the transparent imaging model, TK
key.
boolean
value if exist, otherwise null
.
|
inlinevirtual |
Gets the transfer function value, TR
key.
|
inlinevirtual |
Gets the transfer function value or Default
, TR2
key.
|
inlinevirtual |
Gets the undercolor-removal function, UCR
key.
|
inlinevirtual |
Gets the undercolor-removal function value or Default
, UCR2
key.
|
inlinevirtual |
PDF 2.0.
PDF 2.0. Checks whether the black point compensation is performed while doing CIE-based colour conversions.
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
|
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.
key | key to insert or to override |
value | the value to associate with the specified key |
|
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.
alphaSourceFlag | if true
|
|
inlinevirtual |
Sets value of an automatic stroke adjustment flag, SA
key.
strokeAdjustment | a boolean value. |
|
inlinevirtual |
Sets the black-generation function value, BG
.
blackGenerationFunction | a iText.Kernel.Pdf.PdfObject , shall be an object representing custom function (see iText.Kernel.Pdf.Function.IPdfFunction object wrapper for convenience API in reading/manipulating such function objects). |
|
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.
blackGenerationFunction2 | a iText.Kernel.Pdf.PdfObject value, shall be an object representing custom function (see iText.Kernel.Pdf.Function.IPdfFunction object wrapper for convenience API in reading/manipulating such function objects) or Default . |
|
inlinevirtual |
Sets the current blend mode for the transparent imaging model, BM
key.
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. |
|
inlinevirtual |
Sets line dash pattern value, D
key.
dashPattern | a PdfArray , that represents line dash pattern. |
|
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.
fillingAlphaConstant | a float value. |
|
inlinevirtual |
Set overprint flag value for non-stroking operations, op
key.
fillOverprintFlag |
true
, for applying overprint for non-stroking operations.
|
inlinevirtual |
Sets the flatness tolerance value, FL
key.
flatnessTolerance | a float value. |
|
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.
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. |
|
inlinevirtual |
Sets the halftone or Default
, HT
key.
halftone | a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.PdfDictionary , iText.Kernel.Pdf.PdfStream or iText.Kernel.Pdf.PdfName. |
|
inlinevirtual |
PDF 2.0.
PDF 2.0. Sets halftone origin
x | X location of the halftone origin in the current coordinate system |
y | Y location of the halftone origin in the current coordinate system |
|
inlinevirtual |
Sets line gap style value, LC
key.
lineCapStyle | 0 - butt cap, 1 - round cap, 2 - projecting square cap. |
|
inlinevirtual |
Sets line join style value, LJ
key.
lineJoinStyle | 0 - miter join (see also miter limit), 1 - round join, 2 - bevel join. |
|
inlinevirtual |
Sets line width value, LW
key.
lineWidth | a float value. |
|
inlinevirtual |
Sets miter limit value, ML key
.
Sets miter limit value, ML key
. See also line join style.
miterLimit | a float value. |
|
inlinevirtual |
Set overprint control mode, OPM
key.
overprintMode | an int value, see ISO-320001, 8.6.7 Overprint Control. |
|
inlinevirtual |
Sets rendering intent value, RI
key.
renderingIntent | a PdfName instance, Valid values are: AbsoluteColorimetric , RelativeColorimetric , Saturation , Perceptual . |
|
inlinevirtual |
Sets the smoothness tolerance value, SM
key.
smoothnessTolerance | a float value. |
|
inlinevirtual |
Sets the current soft mask, SMask
key.
sMask | a iText.Kernel.Pdf.PdfObject , shall be either iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfDictionary. |
|
inlinevirtual |
Sets the current alpha constant, specifying the constant shape or constant opacity value for stroking operations in the transparent imaging model, CA
key.
strokingAlphaConstant | a float value. |
|
inlinevirtual |
Set overprint flag value for stroking operations, OP
key.
strokeOverPrintFlag |
true
, for applying overprint for stroking operations.
|
inlinevirtual |
Sets the text knockout flag, which determine the behaviour of overlapping glyphs within a text object in the transparent imaging model, TK
key.
textKnockoutFlag |
true
if enabled.
|
inlinevirtual |
Sets the transfer function value, TR
key.
transferFunction | a iText.Kernel.Pdf.PdfObject , shall be either a iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfArray of a predefined value or an object representing custom function (see iText.Kernel.Pdf.Function.IPdfFunction object wrapper for convenience API in reading/manipulating such function objects). |
|
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.
transferFunction2 | a iText.Kernel.Pdf.PdfObject , shall be either a iText.Kernel.Pdf.PdfName or iText.Kernel.Pdf.PdfArray of a predefined value or an object representing custom function (see iText.Kernel.Pdf.Function.IPdfFunction object wrapper for convenience API in reading/manipulating such function objects). |
|
inlinevirtual |
Sets the undercolor-removal function, UCR
key.
undercolorRemovalFunction | a iText.Kernel.Pdf.PdfObject , shall be an object representing custom function (see iText.Kernel.Pdf.Function.IPdfFunction object wrapper for convenience API in reading/manipulating such function objects). |
|
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.
undercolorRemovalFunction2 | a iText.Kernel.Pdf.PdfObject value, shall be an object representing custom function (see iText.Kernel.Pdf.Function.IPdfFunction object wrapper for convenience API in reading/manipulating such function objects) or Default . |
|
inlinevirtual |
PDF 2.0.
PDF 2.0. This graphics state parameter controls whether black point compensation is performed while doing CIE-based colour conversions.
useBlackPointCompensation | true to enable, false to disable |
|
static |
Standard nonseparable blend mode.
Standard nonseparable blend mode. See ISO-320001, table 137
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard nonseparable blend mode.
Standard nonseparable blend mode. See ISO-320001, table 137
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard nonseparable blend mode.
Standard nonseparable blend mode. See ISO-320001, table 137
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard nonseparable blend mode.
Standard nonseparable blend mode. See ISO-320001, table 137
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136
|
static |
Standard separable blend mode.
Standard separable blend mode. See ISO-320001, table 136