TRSGPStringFormat Class

Create(TRSGPCanvas)

Constructs the graphics object. Specify the canvas that owns the graphics object. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Create(TRSGPCanvas).)

Align

Specifies the character alignment of this String Format object in relation to the origin of the layout rectangle. A layout rectangle is used to position the displayed string.

DigitSubstitutionLanguage

Specifies the language that corresponds with the digits that are to be substituted for Western European digits.

DigitSubstitutionMethod

Specifies the digit substitution method that is used by this String Format object.

FirstTabOffset

Specifies the initial tab offset position. This initial offset position is relative to the string's origin and the offset of the first tab stop is relative to the initial offset position..
 

Flags

Specifies the set of text layout information (such as orientation and clipping) and display manipulations (such as ellipsis insertion, digit substitution, and representation of characters that are not supported by a font).

Handle

Handle of the graphics object, used by the MS GDI+ flat API routines (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

HotkeyPrefix

Specifies the type of processing that is performed on a string when a hot key prefix, an ampersand (&), is encountered.

LineAlign

Specifies the line alignment of this String Format record in relation to the origin of the layout rectangle. The line alignment setting specifies how to align the string vertically in the layout rectangle. The layout rectangle is used to position the displayed string.

MeasurableCharacterRangeCount

Returns the number of character ranges in the measurable character ranges array.

MeasurableCharacterRange[Integer]

Specifies a series of character ranges for this String Format object that, when in a string, can be measured.

A character range is a range of character positions within a string of text. The area of the display that is occupied by a group of characters that are specified by the character range, is the bounding region. A character range is set by AddMeasurableCharacterRange method. The number of ranges that are currently set can be determined by the MeasurableCharacterRangeCount property. This number is also the number of regions expected to be obtained by the MeasureCharacterRanges method.
 

OnChange

Occurs when the graphics object changes.

OnChanged

Occurs when the graphics object changes.

Owner

Canvas that owns the object. The Canvas will free this graphics object if it is destroyed. However, to keep memory use under control, it is recommended that you free graphics objects when you are finished with them. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

TabStopCount

Returns the number of tab stops

TabStop[Integer]

Specifies the offsets of the tab stops. Use the AddTabStop method to add tab stops to the string format.

Trimming

Specifies the trimming style of this String Format object. The trimming style determines how to trim characters from a string that is too large to fit in the layout rectangle.

AddMeasurableCharacterRange(TCharacterRange)

Adds a character range for this String Format object that, when in a string, can be measured.

A character range is a range of character positions within a string of text. The area of the display that is occupied by a group of characters that are specified by the character range, is the bounding region. A character range is set by AddMeasurableCharacterRange method. The number of ranges that are currently set can be determined by the MeasurableCharacterRangeCount property. This number is also the number of regions expected to be obtained by the MeasureCharacterRanges method.
 

AddTabStop(Single)

Adds a tab stop and returns the current object.

Assign(GpStringFormat)

Overloaded. Copies the GDI+ StringFormat object to the current RiverSoftAVG GDI+ string format object.

Assign(TPersistent)

Overloaded. Represents method Assign(TPersistent).

Changed

Call this method when the graphics object changes. It triggers an OnChange event. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

ClearMeasurableCharacterRanges

Deletes all measurable character ranges from the string format object.

ClearTabStops

Clears all tab stops from the string format

Clone

Creates a copy of the graphics object (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

DeleteMeasurableCharacterRange(Integer)

Deletes a character range for this string format object. The character range deleted is specified by the index.

DeleteTabStop(Integer)

Deletes the tab stop at the specified position in the list of tab stops

GenericTypographic

Creates a generic, typographic StringFormat object. It is the responsibility of the calling routine to free the object.A generic, typographic StringFormat object has the following characteristics:

GetFlagMask(TRSGPStringFormatFlags)

Converts the set of string format flags into an integer appropriate to pass into GDI+ API functions.

String format flags specify the set of text layout information (such as orientation and clipping) and display manipulations (such as ellipsis insertion, digit substitution, and representation of characters that are not supported by a font).

GetFlags(Integer)

Converts a GDI+ flag integer into a set of string format flags .

String format flags specify the set of text layout information (such as orientation and clipping) and display manipulations (such as ellipsis insertion, digit substitution, and representation of characters that are not supported by a font).

GetHandle

Call this method to acquire a handle from the GDI+ flat API library (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.GetHandle.)

Notification(TRSGPCanvas)

Called when the Canvas is releasing control of the graphics object. The canvas will no longer be responsible for freeing the graphics object. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Prepare(TRectF,Single)

Prepare the graphics object for drawing. Graphics objects respond in this method to upcoming calls. For example, gradient brushes can make sure the gradient will cover the entire rectangle. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

QueryInterface(TGUID,Void)

Represents method QueryInterface(TGUID,Void). (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

ReleaseHandle

Releases the underlying GDI+ object back to the GDI+ library. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.ReleaseHandle.)

Update

Update native graphics object (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Update.)

_AddRef

Represents method _AddRef. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

_Release

Represents method _Release. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

FHandle

Represents field FHandle. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

var
   i: Integer;
   sf: TRSGPStringFormat;
 begin
   sf := TRSGPStringFormat.Create(aCanvas);
   try
     sf.AddTabStop(150).AddTabStop(100).AddTabStop(100);
     aCanvas.FillText(RectF(20, 20, 500, 100), 'Hello World', sf, 1);
     // draw the rectangle that encloses the text
     aCanvas.Pen.Color := TRSGPColorRec.Red;
     aCanvas.DrawRect(RectF(20, 20, 500, 100), 0, 0, AllCorners, 1);
     // get the tab stops
     for i := 0 to sf.TabStopCount - 1 do
       // do something with sf.TabStop[i]
   finally
     sf.Free;
   end;
 end;