Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
HyperMesh Report
tcl
Report APIs for Altair applications that use Tcl as a scripting language.
rpti::item
Add, access or modify report items.
rpti::item::exceldocument
Interact with items of type exceldocument.

Welcome
What's New
View new features for version 2024.1.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
  - tcl
    Report APIs for Altair applications that use Tcl as a scripting language.
    - rpti::frwk
      Enables you to execute and export report.
    - rpti::item
      Add, access or modify report items.
      - rpti::item::break
        Interact with items of type break.
      - rpti::item::chapter
        Interact with items of type chapter. This item type is valid only for document reports.
      - rpti::item::exceldocument
        Interact with items of type exceldocument.
      - rpti::item::externalobject
        Interact with items of type externalobject.
      - rpti::item::image
        Interact with items of type image.
      - rpti::item::module
        Create or modify report modules.
      - rpti::item::property
        Interact with items of type property.
      - rpti::item::slide
        Interact with items of type slide. This item type is valid only for presentation reports.
      - rpti::item::table
        Interact with items of type table.
      - rpti::item::tableofreference
        Interact with items of type tableofreference.
      - rpti::item::text
        Interact with items of type text.
      - rpti::item::textdocument
        Interact with items of type textdocument.
      - rpti::item::worddocument
        Interact with items of type worddocument.
      - rpti::item apply
        For better performance data created, manipulated or deleted go into a cache.
      - rpti::item clone
        Clone an Item.
      - rpti::item delete
        Deletes the item with the specified ID.
      - rpti::item get
        Queries the value of one property or role or attribute.
      - rpti::item has
        Check if an item attribute, property or role exists.
      - rpti::item insert
        Insert an item to a parent.
      - rpti::item isleaf
        Check if the item is a leaf.
      - rpti::item isvalid
        Check if the item with the specified ID is valid.
      - rpti::item loadproperty
        Load items properties defined in configuration xml.
      - rpti::item redraw
        Notifies all registered views to redraw itself.
      - rpti::item remove
        Remove an item from parent.
      - rpti::item reparent
        Reparents an object that already has a parent.
      - rpti::item set
        Sets one or multiple parameters to specified values.
      - rpti::item validate
        Evaluates registered validate callback.
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

View All Altair HyperWorks Help

rpti::item::exceldocument

Interact with items of type exceldocument.

Supported Property Names: -name -value -parent -type(read only) -file -sheet -caption -caption_location; All properties available can be passed via the "create" API or modified on an existing item via the "set" API.

rpti::item::exceldocument create

Creates an item of type "exceldocument".

Syntax: rpti::item::exceldocument create

Parameters

For: Value: A full list of property names see Supported property name above.

Returns: The ID of the item or .tcl-error in case an error occurred during creation.

Example: rpti::item::exceldocument create -name "My External Excel Document Item"

rpti::item::exceldocument delete

Deletes the item with the specified ID.

Syntax: rpti::item::exceldocument delete

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

Returns: 1 for OK, .tcl-error in case of error.

Example: rpti::item::exceldocument delete -id $id

rpti::item::exceldocument get

Queries the value of one property.

Syntax: rpti::item::exceldocument get

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

For: Value: A full list of property names see Supported property name above.

Returns: The value of the specified property or .tcl-error in case of error.

Example: rpti::item::exceldocument get -id $id -property parent

rpti::item::exceldocument getcell

Queries the value of one property from table cell.

Syntax: rpti::item::exceldocument getcell

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

-row: Value: Row ID. The ID of the row you want to set a particular header text.

-column: Value: Column ID. The ID of the column you want to set a particular header text.

-property: Mandatory value: Property name. 'value' or 'href'.

Returns: The value of the specified property or .tcl-error in case of error.

Example: rpti::item::exceldocument getcell -id $id -row 0 -column 0 -property value

rpti::item::exceldocument getpropertyid

Queries ID of property.

Syntax: rpti::item::exceldocument getpropertyid

Parameters

-id: Value: Item ID.

-key: Value: Property key.

rpti::item::exceldocument getpropertykeylist

Queries list of properties

Syntax: rpti::item::exceldocument getpropertykeylist

Parameters

-id: Value: Item ID.

Returns: List of property keys for a particular item ID.

rpti::item::exceldocument set

Sets one or multiple parameters to specified values. The type of the item is assigned upon creation and cannot be changed after.

Syntax: rpti::item::exceldocument set

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

For: Value: A full list of standard property names see Supported property name above.

Returns: 1 for OK, .tcl-error in case of error.

Example: rpti::item::exceldocument set -id $id -name "My External Excel Document" -file "c:/temp/mydoc.xlsx"

rpti::item::exceldocument setcell

Sets one or multiple parameters to table cell.

Syntax: rpti::item::exceldocument setcell

Parameters

-id: Mandatory value: Item ID. The item ID which is returned by the corresponding "create" API.

-row: Mandatory value: Row ID. Row ID is an integer starting from 0.

-column: Mandatory value: Column ID. Column ID is an integer starting from 0.

-value: Value: The value you want to set on the cell.

-href: Value: Object ID to hyperlink.

Returns: 1 for OK, .tcl-error in case of error.

Example: rpti::item::exceldocument setcell -id $id -row 0 -column 0 -value "Hello" -href $refobjid