Packages

 

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

Classes

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

Class EmfPlusStringFormat

  • All Implemented Interfaces:
    Cloneable


    public final class EmfPlusStringFormat
    extends EmfPlusGraphicsObjectType

    The EmfPlusStringFormat object specifies text layout, display manipulations, and language identification

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      short getDigitLanguage()
      Gets or sets an EmfPlusLanguageIdentifier object that specifies the language to use for numeric digits in the string.
      int getDigitSubstitution()
      Gets or sets a 32-bit unsigned integer that specifies how to substitute numeric digits in the string according to a locale or language.
      float getFirstTabOffset()
      Gets or sets a 32-bit floating-point value that specifies the number of spaces between the beginning of a text line and the first tab stop
      int getHotkeyPrefix()
      Gets or sets a 32-bit signed integer that specifies the type of processing that is performed on a string when a keyboard shortcut prefix (that is, an ampersand) is encountered.
      short getLanguage()
      Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23) that specifies the language to use for the string
      float getLeadingMargin()
      Gets or sets a 32-bit floating-point value that specifies the length of the space to add to the starting position of a string.
      int getLineAlign()
      Gets or sets a 32-bit unsigned integer that specifies how to align the string vertically in the layout rectangle.
      int getRangeCount()
      Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange objects (section 2.2.2.8) defined in the StringFormatData field.
      int getStringAlignment()
      Gets or sets a 32-bit unsigned integer that specifies how to align the string horizontally in the layout rectangle.
      EmfPlusStringFormatData getStringFormatData()
      Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44) that specifies optional text layout data.
      long getStringFormatFlags()
      Gets or sets a 32-bit unsigned integer that specifies text layout options for formatting, clipping and font handling.
      int getTabstopCount()
      Gets or sets a 32-bit signed integer that specifies the number of tab stops defined in the StringFormatData field.
      float getTracking()
      Gets or sets a 32-bit floating-point value that specifies the ratio of the horizontal space allotted to each character in a specified string to the font-defined width of the character.
      float getTrailingMargin()
      Gets or sets a 32-bit floating-point value that specifies the length of the space to leave following a string.
      int getTrimming()
      Gets or sets specifies how to trim characters from a string that is too large to fit into a layout rectangle.
      void setDigitLanguage(short value)
      Gets or sets an EmfPlusLanguageIdentifier object that specifies the language to use for numeric digits in the string.
      void setDigitSubstitution(int value)
      Gets or sets a 32-bit unsigned integer that specifies how to substitute numeric digits in the string according to a locale or language.
      void setFirstTabOffset(float value)
      Gets or sets a 32-bit floating-point value that specifies the number of spaces between the beginning of a text line and the first tab stop
      void setHotkeyPrefix(int value)
      Gets or sets a 32-bit signed integer that specifies the type of processing that is performed on a string when a keyboard shortcut prefix (that is, an ampersand) is encountered.
      void setLanguage(short value)
      Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23) that specifies the language to use for the string
      void setLeadingMargin(float value)
      Gets or sets a 32-bit floating-point value that specifies the length of the space to add to the starting position of a string.
      void setLineAlign(int value)
      Gets or sets a 32-bit unsigned integer that specifies how to align the string vertically in the layout rectangle.
      void setRangeCount(int value)
      Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange objects (section 2.2.2.8) defined in the StringFormatData field.
      void setStringAlignment(int value)
      Gets or sets a 32-bit unsigned integer that specifies how to align the string horizontally in the layout rectangle.
      void setStringFormatData(EmfPlusStringFormatData value)
      Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44) that specifies optional text layout data.
      void setStringFormatFlags(long value)
      Gets or sets a 32-bit unsigned integer that specifies text layout options for formatting, clipping and font handling.
      void setTabstopCount(int value)
      Gets or sets a 32-bit signed integer that specifies the number of tab stops defined in the StringFormatData field.
      void setTracking(float value)
      Gets or sets a 32-bit floating-point value that specifies the ratio of the horizontal space allotted to each character in a specified string to the font-defined width of the character.
      void setTrailingMargin(float value)
      Gets or sets a 32-bit floating-point value that specifies the length of the space to leave following a string.
      void setTrimming(int value)
      Gets or sets specifies how to trim characters from a string that is too large to fit into a layout rectangle.
    • Constructor Detail

      • EmfPlusStringFormat

        public EmfPlusStringFormat()
    • Method Detail

      • getDigitLanguage

        public short getDigitLanguage()

        Gets or sets an EmfPlusLanguageIdentifier object that specifies the language to use for numeric digits in the string. For example, if this string contains Arabic digits, this field MUST contain a language identifier that specifies an Arabic language

      • setDigitLanguage

        public void setDigitLanguage(short value)

        Gets or sets an EmfPlusLanguageIdentifier object that specifies the language to use for numeric digits in the string. For example, if this string contains Arabic digits, this field MUST contain a language identifier that specifies an Arabic language

      • getDigitSubstitution

        public int getDigitSubstitution()

        Gets or sets a 32-bit unsigned integer that specifies how to substitute numeric digits in the string according to a locale or language. This value MUST be defined in the StringDigitSubstitution enumeration (section 2.1.1.30).

      • setDigitSubstitution

        public void setDigitSubstitution(int value)

        Gets or sets a 32-bit unsigned integer that specifies how to substitute numeric digits in the string according to a locale or language. This value MUST be defined in the StringDigitSubstitution enumeration (section 2.1.1.30).

      • getFirstTabOffset

        public float getFirstTabOffset()

        Gets or sets a 32-bit floating-point value that specifies the number of spaces between the beginning of a text line and the first tab stop

      • setFirstTabOffset

        public void setFirstTabOffset(float value)

        Gets or sets a 32-bit floating-point value that specifies the number of spaces between the beginning of a text line and the first tab stop

      • getHotkeyPrefix

        public int getHotkeyPrefix()

        Gets or sets a 32-bit signed integer that specifies the type of processing that is performed on a string when a keyboard shortcut prefix (that is, an ampersand) is encountered. Basically, this field specifies whether to display keyboard shortcut prefixes that relate to text. The value MUST be defined in the HotkeyPrefix enumeration (section 2.1.1.14).

      • setHotkeyPrefix

        public void setHotkeyPrefix(int value)

        Gets or sets a 32-bit signed integer that specifies the type of processing that is performed on a string when a keyboard shortcut prefix (that is, an ampersand) is encountered. Basically, this field specifies whether to display keyboard shortcut prefixes that relate to text. The value MUST be defined in the HotkeyPrefix enumeration (section 2.1.1.14).

      • getLanguage

        public short getLanguage()

        Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23) that specifies the language to use for the string

      • setLanguage

        public void setLanguage(short value)

        Gets or sets an EmfPlusLanguageIdentifier object (section 2.2.2.23) that specifies the language to use for the string

      • getLeadingMargin

        public float getLeadingMargin()

        Gets or sets a 32-bit floating-point value that specifies the length of the space to add to the starting position of a string. The default is 1/6 inch; for typographic fonts, the default value is 0.

      • setLeadingMargin

        public void setLeadingMargin(float value)

        Gets or sets a 32-bit floating-point value that specifies the length of the space to add to the starting position of a string. The default is 1/6 inch; for typographic fonts, the default value is 0.

      • getLineAlign

        public int getLineAlign()

        Gets or sets a 32-bit unsigned integer that specifies how to align the string vertically in the layout rectangle. This value MUST be defined in the StringAlignment enumeration.

      • setLineAlign

        public void setLineAlign(int value)

        Gets or sets a 32-bit unsigned integer that specifies how to align the string vertically in the layout rectangle. This value MUST be defined in the StringAlignment enumeration.

      • getRangeCount

        public int getRangeCount()

        Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange objects (section 2.2.2.8) defined in the StringFormatData field.

      • setRangeCount

        public void setRangeCount(int value)

        Gets or sets a 32-bit signed integer that specifies the number of EmfPlusCharacterRange objects (section 2.2.2.8) defined in the StringFormatData field.

      • getStringAlignment

        public int getStringAlignment()

        Gets or sets a 32-bit unsigned integer that specifies how to align the string horizontally in the layout rectangle. This value MUST be defined in the StringAlignment enumeration (section 2.1.1.29).

      • setStringAlignment

        public void setStringAlignment(int value)

        Gets or sets a 32-bit unsigned integer that specifies how to align the string horizontally in the layout rectangle. This value MUST be defined in the StringAlignment enumeration (section 2.1.1.29).

      • getStringFormatData

        public EmfPlusStringFormatData getStringFormatData()

        Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44) that specifies optional text layout data.

      • setStringFormatData

        public void setStringFormatData(EmfPlusStringFormatData value)

        Gets or sets an EmfPlusStringFormatData object (section 2.2.2.44) that specifies optional text layout data.

      • getStringFormatFlags

        public long getStringFormatFlags()

        Gets or sets a 32-bit unsigned integer that specifies text layout options for formatting, clipping and font handling. This value MUST be composed of StringFormat flags (section 2.1.2.8).

      • setStringFormatFlags

        public void setStringFormatFlags(long value)

        Gets or sets a 32-bit unsigned integer that specifies text layout options for formatting, clipping and font handling. This value MUST be composed of StringFormat flags (section 2.1.2.8).

      • getTabstopCount

        public int getTabstopCount()

        Gets or sets a 32-bit signed integer that specifies the number of tab stops defined in the StringFormatData field.

      • setTabstopCount

        public void setTabstopCount(int value)

        Gets or sets a 32-bit signed integer that specifies the number of tab stops defined in the StringFormatData field.

      • getTracking

        public float getTracking()

        Gets or sets a 32-bit floating-point value that specifies the ratio of the horizontal space allotted to each character in a specified string to the font-defined width of the character. Large values for this property specify ample space between characters; values less than 1 can produce character overlap. The default is 1.03; for typographic fonts, the default value is 1.00.

      • setTracking

        public void setTracking(float value)

        Gets or sets a 32-bit floating-point value that specifies the ratio of the horizontal space allotted to each character in a specified string to the font-defined width of the character. Large values for this property specify ample space between characters; values less than 1 can produce character overlap. The default is 1.03; for typographic fonts, the default value is 1.00.

      • getTrailingMargin

        public float getTrailingMargin()

        Gets or sets a 32-bit floating-point value that specifies the length of the space to leave following a string. The default is 1/6 inch; for typographic fonts, the default value is 0.

      • setTrailingMargin

        public void setTrailingMargin(float value)

        Gets or sets a 32-bit floating-point value that specifies the length of the space to leave following a string. The default is 1/6 inch; for typographic fonts, the default value is 0.

      • getTrimming

        public int getTrimming()

        Gets or sets specifies how to trim characters from a string that is too large to fit into a layout rectangle. This value MUST be defined in the StringTrimming enumeration (section 2.1.1.31).

      • setTrimming

        public void setTrimming(int value)

        Gets or sets specifies how to trim characters from a string that is too large to fit into a layout rectangle. This value MUST be defined in the StringTrimming enumeration (section 2.1.1.31).