Creates a single line of text on the legend layer.
 Syntax: |
|---|
FWizLegend.DrawText(insertionPoint, text, rotationAngle = 0, alignment = DlxApp.TEXTALIGN_DEFAULT, textStyle = null)
FWizLegend.DrawText(insertionPoint, text, rotationAngle = 0, alignment = DlxApp.TEXTALIGN_DEFAULT, styleIndex = -1)
|
Parameters
| Parameter |
Description |
| insertionPoint |
A DlxPoint object with the coordinates where the text is placed. |
| text |
The text string. To insert overlined characters in the text, they must be delimited with the '|' character. |
| rotationAngle |
The angle, in degrees, of rotation of the text with respect to the x-axis. |
| alignment |
Specifies the horizontal and vertical alignment of the text with respect to the insertion point.
Enter the following values:
| Vertical |
| DlxApp.TEXTALIGN_TOP |
| DlxApp.TEXTALIGN_MIDDLE |
| DlxApp.TEXTALIGN_BASE |
| DlxApp.TEXTALIGN_BOTTOM |
| Horizontal |
| DlxApp.TEXTALIGN_LEFT |
| DlxApp.TEXTALIGN_CENTER |
| DlxApp.TEXTALIGN_RIGHT |
| DlxApp.TEXTALIGN_COMMA |
| DlxApp.TEXTALIGN_JUSTIFY |
| Vertical & Horizontal |
| DlxApp.TEXTALIGN_TOPLEFT |
| DlxApp.TEXTALIGN_TOPCENTER |
| DlxApp.TEXTALIGN_TOPRIGHT |
| DlxApp.TEXTALIGN_TOPJUSTIFY |
| DlxApp.TEXTALIGN_MIDDLELEFT |
| DlxApp.TEXTALIGN_MIDDLECENTER |
| DlxApp.TEXTALIGN_MIDDLERIGHT |
| DlxApp.TEXTALIGN_MIDDLEJUSTIFY |
| DlxApp.TEXTALIGN_BASELEFT |
| DlxApp.TEXTALIGN_BASECENTER |
| DlxApp.TEXTALIGN_BASERIGHT |
| DlxApp.TEXTALIGN_BASEJUSTIFY |
| DlxApp.TEXTALIGN_BOTTOMLEFT |
| DlxApp.TEXTALIGN_BOTTOMCENTER |
| DlxApp.TEXTALIGN_BOTTOMRIGHT |
| DlxApp.TEXTALIGN_BOTTOMJUSTIFY |
| Current alignment |
| DlxApp.TEXTALIGN_DEFAULT |
|
| textStyle |
A DlxTextStyle object with the style of the text. |
| styleIndex |
Index of the style. There are 10 styles available with indexes from 0 to 9. Specifying -1 sets the default style for the legend layer. |
Return Value
If an error occurs it returns false otherwise it returns true.
Example
|
|
 Copy code
|
var ctx = FWiz.GetLegendCtx();
ctx.DrawText(new DlxPoint(90,100), "Hello, World.");
|
See also
