EmfText

Inheritance: java.lang.Object, com.aspose.imaging.fileformats.emf.MetaObject, com.aspose.imaging.fileformats.emf.emf.objects.EmfObject

public final class EmfText extends EmfObject

The EmrText object contains values for text output.

Constructors

ConstructorDescription
EmfText()

Methods

MethodDescription
getReference()Gets or sets a WMF PointL object ([MS-WMF] section 2.2.2.15) that specifies the coordinates of the reference point used to position the string.
setReference(Point value)Gets or sets a WMF PointL object ([MS-WMF] section 2.2.2.15) that specifies the coordinates of the reference point used to position the string.
getChars()Gets or sets a 32-bit unsigned integer that specifies the number of characters in the string
setChars(int value)Gets or sets a 32-bit unsigned integer that specifies the number of characters in the string
getOptions()Gets or sets a 32-bit unsigned integer that specifies how to use the rectangle specified in the Rectangle field.
setOptions(int value)Gets or sets a 32-bit unsigned integer that specifies how to use the rectangle specified in the Rectangle field.
getRectangle()Gets or sets an optional WMF RectL object ([MS-WMF] section 2.2.2.19) that defines a clipping and/or opaquing rectangle in logical units.
setRectangle(Rectangle value)Gets or sets an optional WMF RectL object ([MS-WMF] section 2.2.2.19) that defines a clipping and/or opaquing rectangle in logical units.
getStringBuffer()Gets or sets the character string buffer UndefinedSpace1 (variable): An optional number of unused bytes.
setStringBuffer(String value)Gets or sets the character string buffer UndefinedSpace1 (variable): An optional number of unused bytes.
getGlyphIndexBuffer()Gets the optional glyph index buffer.
setGlyphIndexBuffer(int[] value)Sets the optional glyph index buffer.
getDxBuffer()Gets or sets the optional character spacing buffer UndefinedSpace2 (variable): An optional number of unused bytes.
setDxBuffer(int[] value)Gets or sets the optional character spacing buffer UndefinedSpace2 (variable): An optional number of unused bytes.

EmfText()

public EmfText()

getReference()

public Point getReference()

Gets or sets a WMF PointL object ([MS-WMF] section 2.2.2.15) that specifies the coordinates of the reference point used to position the string. The reference point is defined by the last EMR_SETTEXTALIGN record (section 2.3.11.25). If no such record has been set, the default alignment is TA_LEFT,TA_TOP.

Returns: Point

setReference(Point value)

public void setReference(Point value)

Gets or sets a WMF PointL object ([MS-WMF] section 2.2.2.15) that specifies the coordinates of the reference point used to position the string. The reference point is defined by the last EMR_SETTEXTALIGN record (section 2.3.11.25). If no such record has been set, the default alignment is TA_LEFT,TA_TOP.

Parameters:

ParameterTypeDescription
valuePoint

getChars()

public int getChars()

Gets or sets a 32-bit unsigned integer that specifies the number of characters in the string

Returns: int

setChars(int value)

public void setChars(int value)

Gets or sets a 32-bit unsigned integer that specifies the number of characters in the string

Parameters:

ParameterTypeDescription
valueint

getOptions()

public int getOptions()

Gets or sets a 32-bit unsigned integer that specifies how to use the rectangle specified in the Rectangle field. This field can be a combination of more than one ExtTextOutOptions enumeration (section 2.1.11) values

Returns: int

setOptions(int value)

public void setOptions(int value)

Gets or sets a 32-bit unsigned integer that specifies how to use the rectangle specified in the Rectangle field. This field can be a combination of more than one ExtTextOutOptions enumeration (section 2.1.11) values

Parameters:

ParameterTypeDescription
valueint

getRectangle()

public Rectangle getRectangle()

Gets or sets an optional WMF RectL object ([MS-WMF] section 2.2.2.19) that defines a clipping and/or opaquing rectangle in logical units. This rectangle is applied to the text output performed by the containing record.

Returns: Rectangle

setRectangle(Rectangle value)

public void setRectangle(Rectangle value)

Gets or sets an optional WMF RectL object ([MS-WMF] section 2.2.2.19) that defines a clipping and/or opaquing rectangle in logical units. This rectangle is applied to the text output performed by the containing record.

Parameters:

ParameterTypeDescription
valueRectangle

getStringBuffer()

public String getStringBuffer()

Gets or sets the character string buffer UndefinedSpace1 (variable): An optional number of unused bytes. The OutputString field is not required to follow immediately the preceding portion of this structure. OutputString (variable): An array of characters that specify the string to output. The location of this field is specified by the value of offString in bytes from the start of this record. The number of characters is specified by the value of Chars.

Returns: java.lang.String

setStringBuffer(String value)

public void setStringBuffer(String value)

Gets or sets the character string buffer UndefinedSpace1 (variable): An optional number of unused bytes. The OutputString field is not required to follow immediately the preceding portion of this structure. OutputString (variable): An array of characters that specify the string to output. The location of this field is specified by the value of offString in bytes from the start of this record. The number of characters is specified by the value of Chars.

Parameters:

ParameterTypeDescription
valuejava.lang.String

getGlyphIndexBuffer()

public int[] getGlyphIndexBuffer()

Gets the optional glyph index buffer. If options has ETO_GLYPH_INDEX flag then the codes for characters in an output text string are actually indexes of the character glyphs in a TrueType font (2.1.11 ExtTextOutOptions enumeration). Glyph indexes are font-specific, so to display the correct characters on playback, the font that is used MUST be identical to the font used to generate the indexes.

Returns: int[] - the optional glyph index buffer.

setGlyphIndexBuffer(int[] value)

public void setGlyphIndexBuffer(int[] value)

Sets the optional glyph index buffer. If options has ETO_GLYPH_INDEX flag then the codes for characters in an output text string are actually indexes of the character glyphs in a TrueType font (2.1.11 ExtTextOutOptions enumeration). Glyph indexes are font-specific, so to display the correct characters on playback, the font that is used MUST be identical to the font used to generate the indexes.

Parameters:

ParameterTypeDescription
valueint[]the optional glyph index buffer.

getDxBuffer()

public int[] getDxBuffer()

Gets or sets the optional character spacing buffer UndefinedSpace2 (variable): An optional number of unused bytes. The OutputDx field is not required to follow immediately the preceding portion of this structure. OutputDx (variable): An array of 32-bit unsigned integers that specify the output spacing between the origins of adjacent character cells in logical units. The location of this field is specified by the value of offDx in bytes from the start of this record. If spacing is defined, this field contains the same number of values as characters in the output string. If the Options field of the EmrText object contains the ETO_PDY flag, then this buffer contains twice as many values as there are characters in the output string, one horizontal and one vertical offset for each, in that order. If ETO_RTLREADING is specified, characters are laid right to left instead of left to right. No other options affect the interpretation of this field.

Returns: int[]

setDxBuffer(int[] value)

public void setDxBuffer(int[] value)

Gets or sets the optional character spacing buffer UndefinedSpace2 (variable): An optional number of unused bytes. The OutputDx field is not required to follow immediately the preceding portion of this structure. OutputDx (variable): An array of 32-bit unsigned integers that specify the output spacing between the origins of adjacent character cells in logical units. The location of this field is specified by the value of offDx in bytes from the start of this record. If spacing is defined, this field contains the same number of values as characters in the output string. If the Options field of the EmrText object contains the ETO_PDY flag, then this buffer contains twice as many values as there are characters in the output string, one horizontal and one vertical offset for each, in that order. If ETO_RTLREADING is specified, characters are laid right to left instead of left to right. No other options affect the interpretation of this field.

Parameters:

ParameterTypeDescription
valueint[]