Packages

 

com.aspose.imaging.fileformats.emf.emf.objects

Class EmfText

  • All Implemented Interfaces:
    Cloneable


    public final class EmfText
    extends EmfObject

    The EmrText object contains values for text output.

    • Constructor Summary

      Constructors 
      Constructor and Description
      EmfText() 
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      int getChars()
      Gets or sets a 32-bit unsigned integer that specifies the number of characters in the string
      int[] getDxBuffer()
      Gets or sets the optional character spacing buffer UndefinedSpace2 (variable): An optional number of unused bytes.
      int[] getGlyphIndexBuffer()
      Gets the optional glyph index buffer.
      int getOptions()
      Gets or sets a 32-bit unsigned integer that specifies how to use the rectangle specified in the Rectangle field.
      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.
      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.
      String getStringBuffer()
      Gets or sets the character string buffer UndefinedSpace1 (variable): An optional number of unused bytes.
      void setChars(int value)
      Gets or sets a 32-bit unsigned integer that specifies the number of characters in the string
      void setDxBuffer(int[] value)
      Gets or sets the optional character spacing buffer UndefinedSpace2 (variable): An optional number of unused bytes.
      void setGlyphIndexBuffer(int[] value)
      Sets the optional glyph index buffer.
      void setOptions(int value)
      Gets or sets a 32-bit unsigned integer that specifies how to use the rectangle specified in the Rectangle field.
      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.
      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.
      void setStringBuffer(String value)
      Gets or sets the character string buffer UndefinedSpace1 (variable): An optional number of unused bytes.
    • Constructor Detail

      • EmfText

        public EmfText()
    • Method Detail

      • 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.

      • setReference

        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.

      • getChars

        public int getChars()

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

      • setChars

        public void setChars(int value)

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

      • 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

      • setOptions

        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

      • 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.

      • setRectangle

        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.

      • 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.

      • setStringBuffer

        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.

      • getGlyphIndexBuffer

        public final 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:
        the optional glyph index buffer.
      • setGlyphIndexBuffer

        public final 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:
        value - 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.

      • setDxBuffer

        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.