Interface IGDIPlus.IGPStringFormat

This is a Beta Read Only version of this page. Please review and send recommendations to mitov@mitov.com. We will enable the editing as soon as we are happy with the overall Wiki site.

Package: SignalLabBasicPkg

Unit: IGDIPlus

Contents 1 Syntax 1.1 Delphi: 2 Summary 3 Description 4 Properties 5 Methods

Syntax

Delphi:

type IGPStringFormat = interface

Summary

Interface to a TGPStringFormat object.

Description

Defines interface to a TGPStringFormat object.

The TGPStringFormat class encapsulates text layout information (such as alignment, orientation, tab stops, and clipping) and display manipulations (such as trimming, font substitution for characters that are not supported by the requested font, and digit substitution for languages that do not use Western European digits). A TGPStringFormat object can be passed to the Graphics::DrawString Methods method to format a string.

Properties

• FormatFlags - Sets or gets the format flags for the TGPStringFormat object.
• Alignment - Sets or gets the character alignment of this StringFormat object in relation to the origin of the layout rectangle.
• LineAlignment - Sets or gets the line alignment of the TGPStringFormat object in relation to the origin of the layout rectangle.
• HotkeyPrefix - Sets or gets the type of processing that is performed on a string when the hot key prefix, an ampersand (&), is encountered.
• TabStopCount - Returns the number of tab-stop offsets in the TGPStringFormat object.
• TabStops - Sets or gets the offsets for tab stops in the TGPStringFormat object.
• InitialTabOffset - Returns the initial tab offset.
• DigitSubstitutionLanguage - Returns the language that corresponds with the digits that are to be substituted for Western European digits.
• DigitSubstitutionMethod - Returns the digit substitution method that is used by the TGPStringFormat object.
• Trimming - Sets or gets the trimming style for the TGPStringFormat object.

Methods

• function GetNativeFormat() : GpStringFormat
• function Clone() : TGPStringFormat - Creates a new TGPStringFormat object and initializes it with the contents of this TGPStringFormat object.
• function SetFormatFlags(flags : Integer) : TGPStringFormat - Sets the format flags for the TGPStringFormat object.
• procedure SetFormatFlagsProp(flags : Integer)
• function GetFormatFlags() : Integer - Returns the string format flags for the TGPStringFormat object.
• function SetAlignment(align : TGPStringAlignment) : TGPStringFormat - Sets the character alignment of this StringFormat object in relation to the origin of the layout rectangle.
• procedure SetAlignmentProp(align : TGPStringAlignment)
• function GetAlignment() : TGPStringAlignment - Returns the character alignment of the TGPStringFormat object in relation to the origin of the layout rectangle.
• function SetLineAlignment(align : TGPStringAlignment) : TGPStringFormat - Sets the line alignment of the TGPStringFormat object in relation to the origin of the layout rectangle.
• procedure SetLineAlignmentProp(align : TGPStringAlignment)
• function GetLineAlignment() : TGPStringAlignment - Returns the line alignment of this TGPStringFormat object in relation to the origin of the layout rectangle.
• function SetHotkeyPrefix(hotkeyPrefix : TGPHotkeyPrefix) : TGPStringFormat - Sets the type of processing that is performed on a string when the hot key prefix, an ampersand (&), is encountered.
• procedure SetHotkeyPrefixProp(hotkeyPrefix : TGPHotkeyPrefix)
• function GetHotkeyPrefix() : TGPHotkeyPrefix - Returns the type of processing that is performed on a string when a hot key prefix, an ampersand (&), is encountered.
• function SetTabStops(firstTabOffset : Single; tabStops : array) : TGPStringFormat
• function GetTabStopCount() : Integer - Returns the number of tab-stop offsets in the TGPStringFormat object.
• function GetTabStops(initialTabOffset : Single) : TGPSingleArray - Returns the offsets of the tab stops in the TGPStringFormat object.
• function GetTabStops() : TGPSingleArray - Returns the offsets of the tab stops in the TGPStringFormat object.
• function GetTabStopsProp() : TGPSingleArray
• function GetInitialTabOffset() : Single - Returns the initial tab offset.
• function SetDigitSubstitution(language : LANGID; substitute : TGPStringDigitSubstitute) : TGPStringFormat - Sets the digit substitution method and the language that corresponds to the digit substitutes.
• function GetDigitSubstitutionLanguage() : LANGID - Returns the language that corresponds with the digits that are to be substituted for Western European digits.
• function GetDigitSubstitutionMethod() : TGPStringDigitSubstitute - Returns the digit substitution method that is used by the TGPStringFormat object.
• function SetTrimming(trimming : TGPStringTrimming) : TGPStringFormat - Sets the trimming style for the TGPStringFormat object.
• procedure SetTrimmingProp(trimming : TGPStringTrimming)
• function GetTrimming() : TGPStringTrimming - Returns the trimming style of the TGPStringFormat object.
• function SetMeasurableCharacterRanges(ranges : array) : TGPStringFormat
• function GetMeasurableCharacterRangeCount() : Integer - Returns the number of measurable character ranges that are currently set.