public final class EmfPlusDrawDriverString extends EmfPlusDrawingRecordType
The EmfPlusDrawDriverString record specifies text output with character positions.
Constructor and Description |
---|
EmfPlusDrawDriverString(EmfPlusRecord source)
Initializes a new instance of the
EmfPlusDrawDriverString class. |
Modifier and Type | Method and Description |
---|---|
int |
getBrushId()
Gets the brush identifier
A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush,
depending on the value of the S flag in the Flags
|
int |
getDriverStringOptionsFlags()
Gets the driver string options flags
A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.
|
int |
getGlyphCount()
Gets the glyph count
A 32-bit unsigned integer that specifies number of glyphs in the string
|
PointF[] |
getGlyphPos()
Gets the glyph positions array
An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph.
|
short[] |
getGlyphs()
Gets the glyphs array
An array of 16-bit values that define the text string to draw.
|
int |
getMatrixPresent()
Gets if the matrix present flag
A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field
0 - no matrix present.
|
byte |
getObjectId()
Gets the object identifier.
|
Matrix |
getTransformMatrix()
Gets the transform matrix
An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to
each value in the text array.
|
boolean |
isColor()
Gets or sets a value indicating whether this instance is color.
|
void |
setBrushId(int value)
Sets the brush identifier
A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush,
depending on the value of the S flag in the Flags
|
void |
setColor(boolean value)
Sets a value indicating whether this instance is color.
|
void |
setDriverStringOptionsFlags(int value)
Sets the driver string options flags
A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.
|
void |
setGlyphCount(int value)
Sets the glyph count
A 32-bit unsigned integer that specifies number of glyphs in the string
|
void |
setGlyphPos(PointF[] value)
Sets the glyph positions array
An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph.
|
void |
setGlyphs(short[] value)
Sets the glyphs array
An array of 16-bit values that define the text string to draw.
|
void |
setMatrixPresent(int value)
Sets if the matrix present flag
A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field
0 - no matrix present.
|
void |
setObjectId(byte value)
Sets the object identifier.
|
void |
setTransformMatrix(Matrix value)
Sets the transform matrix
An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to
each value in the text array.
|
getDataSize, getFlags, getSize, getType, setDataSize, setFlags, setSize
public EmfPlusDrawDriverString(EmfPlusRecord source)
Initializes a new instance of the EmfPlusDrawDriverString
class.
source
- The source.public byte getObjectId()
Gets the object identifier. The EMF+ Object Table index of an object (section 2.2.1.3) to render the text. The value MUST be zero to 63, inclusive.
public void setObjectId(byte value)
Sets the object identifier. The EMF+ Object Table index of an object (section 2.2.1.3) to render the text. The value MUST be zero to 63, inclusive.
value
- The object identifier.public int getBrushId()
Gets the brush identifier A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush, depending on the value of the S flag in the Flags
public void setBrushId(int value)
Sets the brush identifier A 32-bit unsigned integer that specifies either the foreground color of the text or a graphics brush, depending on the value of the S flag in the Flags
public int getDriverStringOptionsFlags()
Gets the driver string options flags A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.
public void setDriverStringOptionsFlags(int value)
Sets the driver string options flags A 32-bit unsigned integer that specifies the spacing, orientation, and quality of rendering for the string.
public int getGlyphCount()
Gets the glyph count A 32-bit unsigned integer that specifies number of glyphs in the string
public void setGlyphCount(int value)
Sets the glyph count A 32-bit unsigned integer that specifies number of glyphs in the string
public PointF[] getGlyphPos()
Gets the glyph positions array An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph. There MUST be GlyphCount elements, which have a one-to-one correspondence with the elements in the Glyphs array. Glyph positions are calculated from the position of the first glyph if the DriverStringOptionsRealizedAdvance flag in DriverStringOptions flags is set. In this case, GlyphPos specifies the position of the first glyph only.
public void setGlyphPos(PointF[] value)
Sets the glyph positions array An array of EmfPlusPointF objects (section 2.2.2.36) that specify the output position of each character glyph. There MUST be GlyphCount elements, which have a one-to-one correspondence with the elements in the Glyphs array. Glyph positions are calculated from the position of the first glyph if the DriverStringOptionsRealizedAdvance flag in DriverStringOptions flags is set. In this case, GlyphPos specifies the position of the first glyph only.
public short[] getGlyphs()
Gets the glyphs array An array of 16-bit values that define the text string to draw. If the DriverStringOptionsCmapLookup flag in the DriverStringOptionsFlags field is set, each value in this array specifies a Unicode character. Otherwise, each value specifies an index to a character glyph in the EmfPlusFont object specified by the ObjectId value in Flags field.
public void setGlyphs(short[] value)
Sets the glyphs array An array of 16-bit values that define the text string to draw. If the DriverStringOptionsCmapLookup flag in the DriverStringOptionsFlags field is set, each value in this array specifies a Unicode character. Otherwise, each value specifies an index to a character glyph in the EmfPlusFont object specified by the ObjectId value in Flags field.
public boolean isColor()
Gets or sets a value indicating whether this instance is color. This bit indicates the type of data in the BrushId field. If set, BrushId specifies the color value in an EmfPlusARGB object (section 2.2.2.1). If clear, BrushId contains the EMF+ Object Table index of an EmfPlusBrush object (section 2.2.1.1).
true
if this instance is color; otherwise, false
.public void setColor(boolean value)
Sets a value indicating whether this instance is color. This bit indicates the type of data in the BrushId field. If set, BrushId specifies the color value in an EmfPlusARGB object (section 2.2.2.1). If clear, BrushId contains the EMF+ Object Table index of an EmfPlusBrush object (section 2.2.1.1).
value
- true
if this instance is color; otherwise, false
.public int getMatrixPresent()
Gets if the matrix present flag A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field 0 - no matrix present. 1 - transform matrix is in TransformMatrix field
public void setMatrixPresent(int value)
Sets if the matrix present flag A 32-bit unsigned integer that specifies whether a transform matrix is present in the TransformMatrix field 0 - no matrix present. 1 - transform matrix is in TransformMatrix field
public Matrix getTransformMatrix()
Gets the transform matrix An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to each value in the text array. The presence of this data is determined from the MatrixPresent field.
public void setTransformMatrix(Matrix value)
Sets the transform matrix An optional EmfPlusTransformMatrix object (section 2.2.2.47) that specifies the transformation to apply to each value in the text array. The presence of this data is determined from the MatrixPresent field.