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 HierarchyNamespace: pdftron.PDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic sealed class GState
The GState type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Concat(Matrix2D) | Concatenate the given matrix to the transformation matrix of this element.
|
| Concat(Double, Double, Double, Double, Double, Double) | Concat.
|
| Equals | (Inherited from Object.) |
| GetAISFlag | Gets the aIS flag.
|
| GetAutoStrokeAdjust | Gets the auto stroke adjust.
|
| GetBlackGenFunct | Gets the black gen funct.
|
| GetBlendMode | Gets the blend mode.
|
| GetCharSpacing | Gets the Char spacing.
|
| GetDashes | Gets the dashes.
|
| GetFillColor | Gets the fill color space.
|
| GetFillColorSpace | Gets the fill color.
|
| GetFillOpacity | Gets the fill opacity.
|
| GetFillOverprint | Gets the fill overprint.
|
| GetFillPattern | Gets the fill pattern.
|
| GetFlatness | Gets the flatness.
|
| GetFont | Gets the font.
|
| GetFontSize | Gets the font size.
|
| GetHalftone | Gets the halftone.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHorizontalScale | Gets the horizontal scale.
|
| GetLeading | Gets the leading.
|
| GetLineCap | Gets the line cap.
|
| GetLineJoin | Gets the line join.
|
| GetLineWidth | Gets the line width.
|
| GetMiterLimit | Gets the miter limit.
|
| GetOverprintMode | Gets the overprint mode.
|
| GetPhase | Gets the phase.
|
| GetRenderingIntent | Gets the rendering intent.
|
 | GetRenderingIntentType | A utility function that maps a string representing a rendering intent to
RenderingIntent type.
|
| GetSmoothnessTolerance | Gets the smoothness tolerance.
|
| GetSoftMask | Gets the soft mask.
|
| GetSoftMaskTransform | Gets the soft mask transform.
|
| GetStrokeColor | Gets the stroke color space.
|
| GetStrokeColorSpace | Gets the stroke color.
|
| GetStrokeOpacity | Gets the stroke opacity.
|
| GetStrokeOverprint | Gets the stroke overprint.
|
| GetStrokePattern | Gets the stroke pattern.
|
| GetTextRenderMode | Gets the text render mode.
|
| GetTextRise | Gets the text rise.
|
| GetTransferFunct | Gets the transfer funct.
|
| GetTransform | Gets the transform.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetUCRFunct | Gets the uCR funct.
|
| GetWordSpacing | Gets the word spacing.
|
| IsTextKnockout | Checks if is text knockout.
|
| SetAISFlag | 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).
|
| SetAutoStrokeAdjust | Specify whether to apply automatic stroke adjustment.
Corresponds to the /SA key within the ExtGState's dictionary.
|
| SetBlackGenFunct | Sets black-generation function used during conversion between DeviceRGB
and DeviceCMYK. Corresponds to the /BG key within the ExtGState's
dictionary.
|
 | SetBlendMode | Gets the blend mode.
|
| SetCharSpacing | Sets Character spacing.
|
| SetDashPattern | 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.
|
| SetFillColor(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.
|
| SetFillColor(PatternColor) | Set the fill color to the given tiling pattern.
|
| SetFillColor(PatternColor, ColorPt) | Set the fill color to the given uncolored tiling pattern.
|
| SetFillColorSpace | Sets the color space used for filling operations.
|
| SetFillOpacity | Sets the opacity value for painting operations other than stroking.
Corresponds to the value of the /ca key in the ExtGState dictionary.
|
| SetFillOverprint | Specifies if overprint is enabled for fill operations. Corresponds to the /op
key within the ExtGState's dictionary.
|
| SetFlatness | Sets the value of flatness tolerance.
|
| SetFont | Sets the font and font size used to draw text.
|
| SetHalftone | Sets the halftone.
|
| SetHorizontalScale | 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.
|
| SetLeading | 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.
|
| SetLineCap | 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.
|
| SetLineJoin | Sets LineJoin style property.
The line join style specifies the shape to be used at the corners of paths that
are stroked.
|
| SetLineWidth | Sets the thickness of the line used to stroke a path.
|
| SetMiterLimit | Sets miter limit.
|
| SetOverprintMode | Sets the overprint mode. Corresponds to the /OPM key within the ExtGState's
dictionary.
|
| SetRenderingIntent | Sets the color intent to be used for rendering the Element.
|
| SetSmoothnessTolerance | Sets the smoothness tolerance used to control the quality of smooth
shading. Corresponds to the /SM key within the ExtGState's dictionary.
|
| SetSoftMask | Sets the soft mask of the extended graphics state.
Corresponds to the /SMask key within the ExtGState's dictionary.
|
| SetStrokeColor(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.
|
| SetStrokeColor(PatternColor) | Set the stroke color to the given tiling pattern.
|
| SetStrokeColor(PatternColor, ColorPt) | Set the stroke color to the given uncolored tiling pattern.
|
| SetStrokeColorSpace | Sets the color space used for stroking operations.
|
| SetStrokeOpacity | Sets opacity value for stroke painting operations for paths and glyph outlines.
Corresponds to the value of the /CA key in the ExtGState dictionary.
|
| SetStrokeOverprint | Specifies if overprint is enabled for stroke operations. Corresponds to the /OP
key within the ExtGState's dictionary.
|
| SetTextKnockout | Mark the object as elementary for purposes of color compositing in the
transparent imaging model.
|
| SetTextRenderMode | 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..
|
| SetTextRise | 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
|
| SetTransferFunct | 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.
|
| SetTransform(Matrix2D) | Set the transformation matrix associated with this element.
|
| SetTransform(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.
|
| SetUCRFunct | Sets undercolor-removal function used during conversion between DeviceRGB
and DeviceCMYK. Corresponds to the /UCR key within the ExtGState's
dictionary.
|
| SetWordSpacing | Sets word spacing.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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