David Alm: Automated Syncronization with Documentation

2012-10-18T17:18:50Z

Automated Syncronization with Documentation

New page

<b><span style="color:red">
This is a Beta Read Only version of this page.
Please review and send recommendations to [mailto:mitov@mitov.com mitov@mitov.com].
We will enable the editing as soon as we are happy with the overall Wiki site.
</span></b>

'''Package:''' [[Package SignalLabBasicPkg|SignalLabBasicPkg]]

'''Unit:''' [[Unit IGDIPlus|IGDIPlus]]

== Syntax ==
=== Delphi: ===
<code>
'''type''' IGPStringFormat = '''interface'''
</code>
== Summary ==
Interface to a [[Class IGDIPlus.TGPStringFormat|TGPStringFormat]] object.

== Description ==
Defines interface to a [[Class IGDIPlus.TGPStringFormat|TGPStringFormat]] object.

The [[Class IGDIPlus.TGPStringFormat|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 [[Class IGDIPlus.TGPStringFormat|TGPStringFormat]] object
can be passed to the Graphics::DrawString Methods method to
format a string.

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

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

[[Category:Interfaces]]

Interface IGDIPlus.IGPStringFormat - Revision history

David Alm: Automated Syncronization with Documentation