Click or drag to resize

GState Class

GState is a class that keeps track of a number of style attributes used to visually define graphical Elements. Each PDF::Element has an associated GState that can be used to query or set various graphics properties.
Inheritance Hierarchy
SystemObject
  pdftron.PDFGState

Namespace:  pdftron.PDF
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
public sealed class GState

The GState type exposes the following members.

Methods
  NameDescription
Public methodConcat(Matrix2D)
Concatenate the given matrix to the transformation matrix of this element.
Public methodConcat(Double, Double, Double, Double, Double, Double)
Concat.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodGetAISFlag
Gets the aIS flag.
Public methodGetAutoStrokeAdjust
Gets the auto stroke adjust.
Public methodGetBlackGenFunct
Gets the black gen funct.
Public methodGetBlendMode
Gets the blend mode.
Public methodGetCharSpacing
Gets the Char spacing.
Public methodGetDashes
Gets the dashes.
Public methodGetFillColor
Gets the fill color space.
Public methodGetFillColorSpace
Gets the fill color.
Public methodGetFillOpacity
Gets the fill opacity.
Public methodGetFillOverprint
Gets the fill overprint.
Public methodGetFillPattern
Gets the fill pattern.
Public methodGetFlatness
Gets the flatness.
Public methodGetFont
Gets the font.
Public methodGetFontSize
Gets the font size.
Public methodGetHalftone
Gets the halftone.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetHorizontalScale
Gets the horizontal scale.
Public methodGetLeading
Gets the leading.
Public methodGetLineCap
Gets the line cap.
Public methodGetLineJoin
Gets the line join.
Public methodGetLineWidth
Gets the line width.
Public methodGetMiterLimit
Gets the miter limit.
Public methodGetOverprintMode
Gets the overprint mode.
Public methodGetPhase
Gets the phase.
Public methodGetRenderingIntent
Gets the rendering intent.
Public methodStatic memberGetRenderingIntentType
A utility function that maps a string representing a rendering intent to RenderingIntent type.
Public methodGetSmoothnessTolerance
Gets the smoothness tolerance.
Public methodGetSoftMask
Gets the soft mask.
Public methodGetSoftMaskTransform
Gets the soft mask transform.
Public methodGetStrokeColor
Gets the stroke color space.
Public methodGetStrokeColorSpace
Gets the stroke color.
Public methodGetStrokeOpacity
Gets the stroke opacity.
Public methodGetStrokeOverprint
Gets the stroke overprint.
Public methodGetStrokePattern
Gets the stroke pattern.
Public methodGetTextRenderMode
Gets the text render mode.
Public methodGetTextRise
Gets the text rise.
Public methodGetTransferFunct
Gets the transfer funct.
Public methodGetTransform
Gets the transform.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUCRFunct
Gets the uCR funct.
Public methodGetWordSpacing
Gets the word spacing.
Public methodIsTextKnockout
Checks if is text knockout.
Public methodSetAISFlag
Specifies if the alpha is to be interpreted as a shape or opacity mask. The alpha source flag ('alpha is shape'), specifies whether the current soft mask and alpha constant are to be interpreted as shape values (true) or opacity values (false).
Public methodSetAutoStrokeAdjust
Specify whether to apply automatic stroke adjustment. Corresponds to the /SA key within the ExtGState's dictionary.
Public methodSetBlackGenFunct
Sets black-generation function used during conversion between DeviceRGB and DeviceCMYK. Corresponds to the /BG key within the ExtGState's dictionary.
Public methodCode exampleSetBlendMode
Gets the blend mode.
Public methodSetCharSpacing
Sets Character spacing.
Public methodSetDashPattern
Sets the dash pattern used to stroke paths. The line dash pattern controls the pattern of dashes and gaps used to stroke paths. It is specified by a dash Array and a dash phase. The dash Array’s elements are numbers that specify the lengths of alternating dashes and gaps; the dash phase specifies the distance into the dash pattern at which to start the dash. The elements of both the dash Array and the dash phase are expressed in user space units.
Public methodSetFillColor(ColorPt)
Sets the color value/point used for filling operations. The color value must be represented in the currently selected color space used for filling.
Public methodSetFillColor(PatternColor)
Set the fill color to the given tiling pattern.
Public methodSetFillColor(PatternColor, ColorPt)
Set the fill color to the given uncolored tiling pattern.
Public methodSetFillColorSpace
Sets the color space used for filling operations.
Public methodSetFillOpacity
Sets the opacity value for painting operations other than stroking. Corresponds to the value of the /ca key in the ExtGState dictionary.
Public methodSetFillOverprint
Specifies if overprint is enabled for fill operations. Corresponds to the /op key within the ExtGState's dictionary.
Public methodSetFlatness
Sets the value of flatness tolerance.
Public methodSetFont
Sets the font and font size used to draw text.
Public methodSetHalftone
Sets the halftone.
Public methodSetHorizontalScale
Sets horizontal scale. The horizontal scaling parameter adjusts the width of glyphs by stretching or compressing them in the horizontal direction. Its value is specified as a percentage of the normal width of the glyphs, with 100 being the normal width. The scaling always applies to the horizontal coordinate in text space, independently of the writing mode. See Section 5.2.3 in PDF Reference Manual for details.
Public methodSetLeading
Sets the leading parameter. The leading parameter is measured in unscaled text space units. It specifies the vertical distance between the baselines of adjacent lines of text. See Section 5.2.4 in PDF Reference Manual for details.
Public methodSetLineCap
Sets LineCap style property. The line cap style specifies the shape to be used at the ends of open subpaths (and dashes, if any) when they are stroked.
Public methodSetLineJoin
Sets LineJoin style property. The line join style specifies the shape to be used at the corners of paths that are stroked.
Public methodSetLineWidth
Sets the thickness of the line used to stroke a path.
Public methodSetMiterLimit
Sets miter limit.
Public methodSetOverprintMode
Sets the overprint mode. Corresponds to the /OPM key within the ExtGState's dictionary.
Public methodSetRenderingIntent
Sets the color intent to be used for rendering the Element.
Public methodSetSmoothnessTolerance
Sets the smoothness tolerance used to control the quality of smooth shading. Corresponds to the /SM key within the ExtGState's dictionary.
Public methodSetSoftMask
Sets the soft mask of the extended graphics state. Corresponds to the /SMask key within the ExtGState's dictionary.
Public methodSetStrokeColor(ColorPt)
Sets the color value/point used for stroking operations. The color value must be represented in the currently selected color space used for stroking.
Public methodSetStrokeColor(PatternColor)
Set the stroke color to the given tiling pattern.
Public methodSetStrokeColor(PatternColor, ColorPt)
Set the stroke color to the given uncolored tiling pattern.
Public methodSetStrokeColorSpace
Sets the color space used for stroking operations.
Public methodSetStrokeOpacity
Sets opacity value for stroke painting operations for paths and glyph outlines. Corresponds to the value of the /CA key in the ExtGState dictionary.
Public methodSetStrokeOverprint
Specifies if overprint is enabled for stroke operations. Corresponds to the /OP key within the ExtGState's dictionary.
Public methodSetTextKnockout
Mark the object as elementary for purposes of color compositing in the transparent imaging model.
Public methodSetTextRenderMode
Sets text rendering mode. The text rendering mode determines whether showing text causes glyph outlines to be stroked, filled, used as a clipping boundary, or some combination of the three. See Section 5.2.5 in PDF Reference Manual for details..
Public methodSetTextRise
Sets text rise. Text rise specifies the distance, in unscaled text space units, to move the baseline up or down from its default location. Positive values of text rise move the baseline up
Public methodSetTransferFunct
Sets transfer function used during color conversion process. A transfer function adjusts the values of color components to compensate for nonlinear response in an output device and in the human eye. Corresponds to the /TR key within the ExtGState's dictionary.
Public methodSetTransform(Matrix2D)
Set the transformation matrix associated with this element.
Public methodSetTransform(Double, Double, Double, Double, Double, Double)
Sets the transformation matrix for this element. This method accepts text transformation matrix components directly. A transformation matrix in PDF is specified by six numbers, usually in the form of an Array containing six elements. In its most general form, this Array is denoted [a b c d h v]; it can represent any linear transformation from one coordinate system to another. For more information about PDF matrices please refer to section 4.2.2 'Common Transformations' in PDF Reference Manual, and to documentation for pdftron::Common::Matrix2D class.
Public methodSetUCRFunct
Sets undercolor-removal function used during conversion between DeviceRGB and DeviceCMYK. Corresponds to the /UCR key within the ExtGState's dictionary.
Public methodSetWordSpacing
Sets word spacing.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Remarks
current clipping path is not tracked in the graphics state for efficiency reasons. In most cases tracking of the current clipping path is best left to the client.
See Also