RiverSoftAVG Products Help

AlignText(TSVGCustomText,TSVGShapePath,TSVGRect,TSVGPoint)

Aligns (start, middle, end) the text shape in the Line parameter (a string of character shapes) within the TextR rectangle. The TextPadding parameter controls the amount of padding, or margin, to leave within the TextR rectangle.

The alignment is based on the GetTextAlign method as well as the inline progression direction.

AssignProperties(TPersistent)

Copies the properties of source to the current element (but not children) (Overrides FMX.RS.SVG.Text.TSVGCustomText.AssignProperties(TPersistent).)

CalculateXYRotate(TSVGCanvas,TSVGMatrix)

Overloaded.  Calculates the X and Y position and rotation of each character in the text path in order to make the characters appear on the path. The function fills the FChars array with the X and Y positions of the characters in the text.

The X position is the mid-point of the glyph for each character. The Y position is on the actual path.

CalculateXYRotate(TSVGCanvas,TSVGMatrix,TSVGTextChunk,Integer,Single)

Overloaded.  Calculates the X and Y position and rotation of each character in the text path in order to make the characters appear on the path. The function fills the FChars array with the X and Y positions of the characters in the text.

The X position is the mid-point of the glyph for each character. The Y position is on the actual path.

ChildSVGTypes

Returns the set of allowable child SVG element types (Overrides FMX.RS.SVG.TSVGElement.ChildSVGTypes.)

ChunkChildrenText(TSVGCanvas,TSVGMatrix,TSVGTextChunks)

Chunks the children of the current text element (Overrides FMX.RS.SVG.Text.TSVGCustomText.ChunkChildrenText(TSVGCanvas,TSVGMatrix,TSVGTextChunks).)

ChunkText(TSVGCanvas,TSVGMatrix,TSVGTextChunks)

Chunks the current text element. If the TextChunks parameter already holds chunks, it appends onto the end.

Chunking means to divide text up into segments. Each absolute position adjustment defines a new text chunk. A text chunk can span text child elements if they do not define a new absolute position.
 
The Text field holds the text. The Chars array holds the position and formatting information for each character in the text.
 

Clear

Clears the SVG element and resets its properties back to their defaults (Overrides FMX.RS.SVG.Text.TSVGCustomText.Clear.)

DoInternalDraw(TSVGMatrix,TSVGCanvas,TSVGRect)

Draw the current SVG element only (not its children) to the specified canvas inside the specified rectangle. The matrix parameter specifies the cumulative transformations from the Parent element (and its Parents) to apply when drawing the element.

This method is overridden by descendant classes for svg element specific drawing.

DoLoadFromXML(IXMLNode)

This method sets the properties of the svg element from the node when loading the svg from XML

This method does the work for the current svg element only.

DoSaveToXML(IXMLNode)

This method saves the properties of the svg element to the xml node.

This method does the work for the current svg element only.

GetBaseline(TSVGCustomText,TSVGCanvas,Char,TSVGShapePath)

Returns the baseline of the character based on the element's Font property. The baseline refers to the alignment point for the characters in a string of text. In horizontal writing-modes, the glyphs of a given script are positioned so that a particular point on each glyph, the alignment-point, is aligned with the alignment-points of the other glyphs in that script. The glyphs of different scripts, for example, Western, Northern Indic and Far-Eastern scripts, are typically aligned at different points on the glyph. For example, Western glyphs are aligned on the bottoms of the capital letters, northern indic glyphs are aligned at the top of a horizontal stroke near the top of the glyphs and far-eastern glyphs are aligned either at the bottom or center of the glyph.

All text elements and their children share the same baseline, even if the font or font size change.

GetDX(Cardinal)

Returns the delta x-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.DX property length, it returns its parent text element's DX property. (Overrides FMX.RS.SVG.Text.TSVGCustomText.GetDX(Cardinal).)

GetDY(Cardinal)

Returns the delta y-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.DY property length, it returns its parent text element's DY property. (Overrides FMX.RS.SVG.Text.TSVGCustomText.GetDY(Cardinal).)

GetPathElement

Overloaded. Represents method GetPathElement.

GetRotate(Cardinal)

Returns the rotation (in degrees) for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.Rotate property length, it returns the last rotation item in the Rotate array. (Overrides FMX.RS.SVG.Text.TSVGCustomText.GetRotate(Cardinal).)

GetX(Cardinal)

Returns the x-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.X property length, it returns its parent text element's X property. (Overrides FMX.RS.SVG.Text.TSVGCustomText.GetX(Cardinal).)

GetY(Cardinal)

Returns the y-axis coordinate for the character at the Index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.Y property length, it returns its parent text element's Y property. (Overrides FMX.RS.SVG.Text.TSVGCustomText.GetY(Cardinal).)

IsCharClipped(Cardinal)

Returns true if the character is outside of the boundary of the text element. This method really only applies to text on a path element where text can run off the end of the path. (Overrides FMX.RS.SVG.Text.TSVGCustomText.IsCharClipped(Cardinal).)

IsXSpecified(Cardinal)

Returns true if there is an x-axis value specified for the character at the index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.X property length, it checks its parent text element's X property. (Overrides FMX.RS.SVG.Text.TSVGCustomText.IsXSpecified(Cardinal).)

IsYSpecified(Cardinal)

Returns true if there is an y-axis value specified for the character at the index position. If the index is greater than the FMX.RS.SVG.Text.TSVGCustomText.Y property length, it checks its parent text element's Y property. (Overrides FMX.RS.SVG.Text.TSVGCustomText.IsYSpecified(Cardinal).)

LengthRangePathLength(TSVGLength,Single,Single,Boolean)

Represents method LengthRangePathLength(TSVGLength,Single,Single,Boolean).

NotifyListener(TSVGElement)

The NotifyListener method is called when aElement has changed or is being destroyed (Overrides FMX.RS.SVG.TSVGElement.NotifyListener(TSVGElement).)

RetrievePath

Retrieves the path data from the Reference element, whether a TSVGPath.Data or the shape of the TSVGGraphicElement. The path data is modified by the referenced element's transformation matrix.

SetX(Single)

Sets the X coordinate, in pixels, of the element (Overrides FMX.RS.SVG.Text.TSVGCustomText.SetX(Single).)

SetX(TSVGLengths)

Sets the FMX.RS.SVG.Text.TSVGCustomText.X Array property to a copy of the value arrray.

SetY(Single)

Sets the Y coordinate, in pixels, of the element (Overrides FMX.RS.SVG.Text.TSVGCustomText.SetY(Single).)

SetY(TSVGLengths)

Sets the FMX.RS.SVG.Text.TSVGCustomText.Y Array property to a copy of the value arrray.

ShouldDrawTextAllAtOnce

Returns true if the text drawing can be optimized and all text can be drawn at once.

Text can be drawn as one unit if there are not multiple X, Y coordinates, or DX, DY changes, and no individual character rotations. Also, the text needs to be left-to-right or right-to-left and the characters need to be facing perpendicular to the text direction (up with Western alphabets).

SVGType

Returns the SVG element type of the class (Overrides FMX.RS.SVG.TSVGElement.SVGType.)