CDChartDirectorTextRoutines < Main

---++ Text Object Routines

All the text that you place on the chart is considered a 'text object', such as axis labels, chart titles, legends, etc. These subroutines allow you to change the default attributes of these 'text objects'.

%TOC%
---+++ General Text Box Routines
---++++ [[CDTextInitialize][.TEXT INITIALIZE]]

Initialize a Text Object
---++++ [[CDTextSetCurrent][.TEXT SET CURRENT]]

Set the "current" Text Object to be a previously initialized Text Object.
---++++ [[CDTextGetName][.TEXT GET NAME]]

Get the name of the "current" Text Object.
---++++ [[CDTextSetText][.TEXT SET TEXT]]

Set the text of the "current" Text Object.
---+++ Font Routines
---++++ [[CDTextSetFontName][.TEXT SET FONT NAME]]

Set the font name and font index for the "current" Text Object.
---++++ [[CDTextSetFontIndex][.TEXT SET FONT INDEX]]

Set the font index.
---++++ [[CDTextSetFontStyle][.TEXT SET FONT STYLE]]

Set the font style (normal, bold, italic) for the "current" Text Object.
---++++ [[CDTextSetFontSize][.TEXT SET FONT SZ]]

Set the font size for the "current" Text Object.
---++++ [[CDTextSetFontSizeH][.TEXT SET FONT SZ:H]]

Set the height of the font for the "current" Text Object.
---++++ [[CDTextSetFontSizeW][.TEXT SET FONT SZ:W]]

Set the width of the font for the "current" Text Object.
---++++ [[CDTextSetFontColor][.TEXT SET FONT CLR]]

Set the font color for the "current" Text Object.
---+++ Text Box Routines

The 'text object' is always contained in a 'text box'. By default, the 'text box' is not visible. These routines allow you to change the attribute of the 'text box' to make it visible, change the borders, etc.
---++++ [[CDTextBxAlign][.TEXT BX ALIGN]]

Set the alignment (position) of the "current" Text Box. 
---++++ [[CDTextSetBoxBGColor][.TEXT SET BX BG CLR]]

Set the background color for the "current" Text Object.
---++++ [[CDTextSetBoxEdgeColor][.TEXT SET BX EDGE CLR]]

Set the edge color for the "current" Text Object.
---++++ [[CDTextSetBoxEdgeEffect][.TEXT SET BX EDGE EFF]]

Set the edge effect (Flat, Raised, or Depressed) of the "current" Text Object.
---++++ [[CDTextSetBoxEdgeWidth][.TEXT SET BX EDGE W]]

Set the edge width of the "current" Text Object.
---++++ [[CDTextSetBoxCornerType][.TEXT SET BX CNR STYLE]]

Set the corner style (Square or Rounded) of the "current" Text Object.
---++++ [[CDTextSetBoxCornerRadius][.TEXT SET BX CNR R]]

Set the corner radius of the "current" Text Object.
---++++ [[CDTextSetBoxCornerRadiusTL][.TEXT SET BX CNR R:TL]]

Set the radius of the Top Left corner of the "current" Text Object.
---++++ [[CDTextSetBoxCornerRadiusTR][.TEXT SET BX CNR R:TR]]

Set the radius of the Top Right corner of the "current" Text Object.
---++++ [[CDTextSetBoxCornerRadiusBR][.TEXT SET BX CNR R:BR]]

Set the radius of the Bottom Right corner of the "current" Text Object.
---++++ [[CDTextSetBoxCornerRadiusBL][.TEXT SET BX CNR R:BL]]

Set the radius of the Bottom Left corner of the "current" Text Object.
---++++ [[CDTextSetBoxLocation][.TEXT SET BX LOC]]

Set the offset (x and y) of the "current" Text Object.
---++++ [[CDTextSetBoxLocationX][.TEXT SET BX LOC:X]]

Set the x offset of the "current" Text Object.
---++++ [[CDTextSetBoxLocationY][.TEXT SET BX LOC:Y]]

Set the y offset of the "current" Text Object.
---++++ [[CDTextSetBoxSize][.TEXT SET BX SZ]]

Set the size (height and width) of the "current" Text Object.
---++++ [[CDTextSetBoxSizeHeight][.TEXT SET BX SZ:H]]

Set the height of the "current" Text Object.
---++++ [[CDTextSetBoxSizeWidth][.TEXT SET BX SZ:W]]

Set the width of the "current" Text Object.
---++++ [[CDTextSetBoxZOrder][.TEXT SET BX Z ORDER]]

Set the Z Order of the "current" Text Object.
---+++ Text Format Routines
---++++ [[CDTextSetTextMaxSize][.TEXT SET TXT MAX SZ]]

Set the maximum size (width and height) of the text that can be displayed in the "current" Text Object.
---++++ [[CDTextSetTextMaxSizeWidth][.TEXT SET TXT MAX SZ:W]]

Set the maximum width (in pixels) of the text that can be displayed in the "current" Text Object.
---++++ [[CDTextSetTextMaxSizeHeight][.TEXT SET TXT MAX SZ:H]]

Set the maximum height (in lines) of the text that can be displayed in the "current" Text Object.
---++++ [[CDTextSetTextMargin][.TEXT SET TXT MARGIN]]

Set the margins for the text in the "current" Text Object.
---++++ [[CDTextSetTextMarginLeft][.TEXT SET TXT MARGIN:L]]

Set the Left margin for the text in the "current" Text Object.
---++++ [[CDTextSetTextMarginRight][.TEXT SET TXT MARGIN:R]]

Set the Right margin for the text in the "current" Text Object.
---++++ [[CDTextSetTextMarginTop][.TEXT SET TXT MARGIN:T]]

Set the Top margin for the text in the "current" Text Object.
---++++ [[CDTextSetTextMarginBottom][.TEXT SET TXT MARGIN:B]]

Set the Bottom margin for the text in the "current" Text Object.
---++++ [[CDTextSetTextRotation][.TEXT SET TXT ROTATION]]

Set the rotation angle for the text in the "current" Text Object.
---++++ [[CDTextSetTextAlignment][.TEXT SET TXT ALIGN]]

Set the alignment of the text in the "current" Text Object.
---++++ [[CDTextSetTextLayout][.TEXT SET TXT LAYOUT]]

Set the layout direction of the text(horizontal or Vertical) in the "current" Text Object.
---++ Comments:

_Read what other users have said about this page or add your own comments._

<br />%COMMENT%

-- Main.JeanNeron - 2011-11-24
This topic: Main > WebHome > APPX510Features > CDChartDirectorDesignerAPI > CDChartDirectorTextRoutines
Topic revision: r3 - 2012-02-17 - JeanNeron