SurfaceGraphTextBox

The text box properties.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
graph = app.CartesianSurfaceGraphs:Add()
graph.Plots:Add(app.Models[1].Configurations[1].FarFields[1])

    -- Edit 'SurfaceGraphTextBox' text, which automatically sets 'AutoTextEnabled' to false

graph.Title.Text = [[My custom title.]]

    -- A subset of HTML4 and HTML5 tags can also be used for advanced styling

graph.Footer.Text = [[My partly bold <b>Footer</b>.]]

graph.HorizontalAxis.Title.Caption = [[My HTML4 
<sup>superscripted</sup> 
<u>underlined</u> axis.]]

graph.VerticalAxis.Title.Caption = [[My HTML5 
<span style=" vertical-align:super;">superscript </span>
<span style=" text-decoration: underline;">underlined</span> 
axis.]]

Usage locations (object properties)

The following objects have properties using the SurfaceGraphTextBox object:

Property List

AutoTextEnabled
Specifies whether the automatic text of the text item must be used. (Read/Write boolean)
Font
The font format for the text box. (Read only SurfaceGraphFontFormat)
Frame
The frame format for the text box. (Read only SurfaceGraphFrameFormat)
Text
The text of the item. The text can include HTML4 and HTML5 tags for custom formatting of the characters.The most common HTML4 and HTML5 tags are supported. (Read/Write string)

Property Details

AutoTextEnabled
Specifies whether the automatic text of the text item must be used.
Type
boolean
Access
Read/Write
Font
The font format for the text box.
Type
SurfaceGraphFontFormat
Access
Read only
Frame
The frame format for the text box.
Type
SurfaceGraphFrameFormat
Access
Read only
Text
The text of the item. The text can include HTML4 and HTML5 tags for custom formatting of the characters.The most common HTML4 and HTML5 tags are supported.
Type
string
Access
Read/Write