Table/Report
STAAD.Pro report tables and sheets — create reports and read/write individual cells. Reporting output, not modeling.
28 functions
Create
AddTable
Description
Adds the table.
Parameters
report_no(int): report no.table_name(str): table name.row_count(int): row count.col_count(int): col count.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.AddTable(1, "value", 1, 1)
print(result)
CreateReport
Description
Creates the report.
Parameters
report_title(str): report title.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.CreateReport("value")
print(result)
Get
GetCellValue
Description
Returns the cell value.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.
Returns
str: A string value returned by STAAD.Pro for this call.
Example
from openstaad import ops
s = ops.connect()
result = s.GetCellValue(1, 1, 1, 1)
print(result)
GetCountryTableNo
Description
Returns the country table no.
Parameters
beam_id(int): beam id.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetCountryTableNo(1)
print(result)
GetReportCount
Description
Returns the report count.
Parameters
None.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetReportCount()
print(result)
GetTableCount
Description
Returns the table count.
Parameters
report_no(int): report no.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetTableCount(1)
print(result)
GetUserProvidedTableCount
Description
Returns the user provided table count.
Parameters
None.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetUserProvidedTableCount()
print(result)
GetUserProvidedTableList
Description
Returns the user provided table list.
Parameters
None.
Returns
list: A list of integers.
Example
from openstaad import ops
s = ops.connect()
result = s.GetUserProvidedTableList()
print(result)
GetUserProvidedTableNo
Description
Returns the user provided table no.
Parameters
table_index(int): table index.
Returns
raw: The raw return value from the underlying OpenSTAAD COM call. Refer to the official Bentley OpenSTAAD API reference for this method's exact return semantics.
Example
from openstaad import ops
s = ops.connect()
result = s.GetUserProvidedTableNo(1)
print(result)
Set/Assign
RenameTable
Description
Renames the table.
Parameters
report_no(int): report no.table_no(int): table no.table_name(str): table name.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.RenameTable(1, 1, "value")
ResizeTable
Description
Resizes the table.
Parameters
report_no(int): report no.table_no(int): table no.row_nos(int): row nos.col_nos(int): col nos.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.ResizeTable(1, 1, 1, 1)
SaveReport
Description
Saves the report.
Parameters
report_no(int): report no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SaveReport(1)
SaveReportAll
Description
Saves the report all.
Parameters
None.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SaveReportAll()
SaveTable
Description
Saves the table.
Parameters
report_no(int): report no.table_no(int): table no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SaveTable(1, 1)
SetCellTextBold
Description
Sets the cell text bold.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextBold(1, 1, 1, 1)
SetCellTextColor
Description
Sets the cell text color.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.red(int): red.green(int): green.blue(int): blue.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextColor(1, 1, 1, 1, 1, 1, 1)
SetCellTextHorzAlignment
Description
Sets the cell text horz alignment.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.align(int): align.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextHorzAlignment(1, 1, 1, 1, 1)
SetCellTextItalic
Description
Sets the cell text italic.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextItalic(1, 1, 1, 1)
SetCellTextSize
Description
Sets the cell text size.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.size(float): size.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextSize(1, 1, 1, 1, 1.0)
SetCellTextSizeAll
Description
Sets the cell text size all.
Parameters
report_no(int): report no.table_no(int): table no.size(float): size.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextSizeAll(1, 1, 1.0)
SetCellTextUnderline
Description
Sets the cell text underline.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextUnderline(1, 1, 1, 1)
SetCellTextVertAlignment
Description
Sets the cell text vert alignment.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.align(int): align.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellTextVertAlignment(1, 1, 1, 1, 1)
SetCellValue
Description
Sets the cell value.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.col_no(int): col no.value(str): value.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetCellValue(1, 1, 1, 1, "value")
SetColumnHeader
Description
Sets the column header.
Parameters
report_no(int): report no.table_no(int): table no.col_no(int): col no.header(str): header.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetColumnHeader(1, 1, 1, "value")
SetColumnUnitString
Description
Sets the column unit string.
Parameters
report_no(int): report no.table_no(int): table no.col_no(int): col no.unit_string(str): unit string.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetColumnUnitString(1, 1, 1, "value")
SetRowHeader
Description
Sets the row header.
Parameters
report_no(int): report no.table_no(int): table no.row_no(int): row no.header(str): header.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.SetRowHeader(1, 1, 1, "value")
Delete
DeleteReport
Description
Deletes the report.
Parameters
report_no(int): report no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.DeleteReport(1)
DeleteTable
Description
Deletes the table.
Parameters
report_no(int): report no.table_no(int): table no.
Returns
None: This function does not return a value.
Example
from openstaad import ops
s = ops.connect()
s.DeleteTable(1, 1)