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.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
TextView
txtITextEditor Class
txtITextEditor GetBackgroundColor
Returns the background color.

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.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
    - HyperGraph 2D
    - HyperGraph 3D
    - MediaView
    - TextView
      - txtIReportManager Class
      - txtITextEditor Class
        txtITextEditor Clear
        Clears the text editor.
        txtITextEditor Draw
        Redraws the text editor.
        txtITextEditor Evaluate
        Evaluates the raw text.
        txtITextEditor GetBackgroundColor
        Returns the background color.
        txtITextEditor GetEvaluated
        Returns the evaluation state of text client text.
        txtITextEditor GetEvaluatedText
        Returns the evaluated text.
        txtITextEditor GetFontHandle
        Gets a handle to the font.
        txtITextEditor GetForegroundColor
        Returns the foreground color.
        txtITextEditor GetTextFileName
        Returns the name of the text file.
        txtITextEditor GetRawText
        Returns the raw (unevaluated) text.
        txtITextEditor LoadTextFile
        Loads the text from a file.
        txtITextEditor RefreshAllText
        Refreshes all page areas with the text changes that have been made.
        txtITextEditor SaveTextFile
        Saves the content of the text editor to a file.
        txtITextEditor SetBackgroundColor
        Sets the background color.
        txtITextEditor SetEvaluated
        Allows you to control the evaluation state of text client text.
        txtITextEditor SetForegroundColor
        Sets the foreground color.
        txtITextEditor SetRawText
        Sets the raw (unevaulated) text.
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- 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
- 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.

txtITextEditor GetBackgroundColor

Returns the background color.

Syntax

txtITextEditor_handle GetBackgroundColor

Application

Tcl Query

Description

Returns an integer indicating the background color.

Errors

None.