ResultTextBox

A 2D results text box.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/startup.fek]])
app.Views[1]:Close()

    -- Add a Cartesian graph to the application's collection and obtain
    -- the shapes collection

graph = app.CartesianGraphs:Add()
shapes = graph.Shapes

textBox1 = shapes:AddTextBox("TextBox", 20,30)
textBox1.TextDirection = pf.Enums.TextDirectionEnum.Rotate90
textBox1.BackColour = pf.Enums.ColourEnum.Yellow
textBox1.Width = 100
textBox1.Height = 150

circle1 = shapes:AddCircle(35,30)
circle1.BackColour = pf.Enums.ColourEnum.Cyan

rectangle1 = shapes:AddRectangle(50,30)
rectangle1.BackColour = pf.Enums.ColourEnum.Magenta

Property List

BackColour
The background colour. See ColourEnum. (Read/Write string)
FontBoldfaced
Enables font bold. (Read/Write boolean)
FontColour
The font colour. See ColourEnum. (Read/Write string)
FontFamily
The font family. (Read/Write string)
FontItalicised
Enables font italic. (Read/Write boolean)
FontSize
The font size. (Read/Write number)
FontUnderlined
Enables font underline. (Read/Write boolean)
Height
The text box height. (Read/Write number)
LineColour
The line colour. See ColourEnum. (Read/Write string)
LineStyle
The line style. See LineStyleEnum. (Read/Write string)
LineWeight
The line weight. (Read/Write number)
PositionX
The X coordinate position of the text box. Measured as a percentage of the width of the graph. (Read/Write number)
PositionY
The Y coordinate position of the text box. Measured as a percentage of the height of the graph. (Read/Write number)
ShadowSize
The drop shadow size. (Read/Write number)
ShadowVisible
Enables drop shadow visibility. (Read/Write boolean)
Text
The text box text. (Read/Write string)
TextDirection
The orientation of the text box text. See TextDirectionEnum. (Read/Write string)
Type
The object type string. (Read only string)
Width
The text box width. (Read/Write number)

Method List

Delete ()
Delete the text box.
Duplicate ()
Duplicate the text box. (Returns a ResultTextBox object.)
Lower ()
Lower the text box.
Raise ()
Raise the text box.

Property Details

BackColour
The background colour. See ColourEnum.
Type
string
Access
Read/Write
FontBoldfaced
Enables font bold.
Type
boolean
Access
Read/Write
FontColour
The font colour. See ColourEnum.
Type
string
Access
Read/Write
FontFamily
The font family.
Type
string
Access
Read/Write
FontItalicised
Enables font italic.
Type
boolean
Access
Read/Write
FontSize
The font size.
Type
number
Access
Read/Write
FontUnderlined
Enables font underline.
Type
boolean
Access
Read/Write
Height
The text box height.
Type
number
Access
Read/Write
LineColour
The line colour. See ColourEnum.
Type
string
Access
Read/Write
LineStyle
The line style. See LineStyleEnum.
Type
string
Access
Read/Write
LineWeight
The line weight.
Type
number
Access
Read/Write
PositionX
The X coordinate position of the text box. Measured as a percentage of the width of the graph.
Type
number
Access
Read/Write
PositionY
The Y coordinate position of the text box. Measured as a percentage of the height of the graph.
Type
number
Access
Read/Write
ShadowSize
The drop shadow size.
Type
number
Access
Read/Write
ShadowVisible
Enables drop shadow visibility.
Type
boolean
Access
Read/Write
Text
The text box text.
Type
string
Access
Read/Write
TextDirection
The orientation of the text box text. See TextDirectionEnum.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
Width
The text box width.
Type
number
Access
Read/Write

Method Details

Delete ()
Delete the text box.
Duplicate ()
Duplicate the text box.
Return
ResultTextBox
The duplicated text box.
Lower ()
Lower the text box.
Raise ()
Raise the text box.