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.
Framework
hwIWindow Class
hwIWindow SetHTMLOutputType
Sets the window caption used when exporting to HTML.

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
      - amfIMarker Class
      - amfIMeasure Class
      - amfIMovie Class
      - hwi Class
      - hwI2DViewControl Class
      - hwI3DViewControl Class
      - hwIAMFExportOptions Class
      - hwIAnimator Class
      - hwIAnimator AtModelStep
      - hwIAVIExportOptions Class
      - hwIClientInfo Class
      - hwIDataFile Class
      - hwIFont Class
      - hwIH3DExportOptions Class
      - hwIHWC Class
      - hwIJPGExportOptions Class
      - hwILayer Class
      - hwIMessageLog Class
      - hwIObject Class
      - hwIPage Class
      - hwIPPTPublish Class
      - hwIPPTPublishOption Class
      - hwIPreferenceManager Class
      - hwIProject Class
      - hwIReportTemplate Class
      - hwISession Class
      - hwITemplex Class
      - hwIViewControl Class
      - hwIWindow Class
        hwIWindow Draw
        Draws the client object.
        hwIWindow GetClientHandle
        Returns the client object handle.
        hwIWindow GetClientType
        Returns the window client type.
        hwIWindow GetGraphicsHeight
        Gets the height of the graphics window.
        hwIWindow GetGraphicsWidth
        Gets the width of the graphics window.
        hwIWindow GetHTMLCaption
        Gets the window caption used when exporting to HTML.
        hwIWindow GetHTMLOutputType
        Gets the window caption used when exporting to HTML.
        hwIWindow GetID
        Returns the window ID.
        hwIWindow GetSyncOffset
        Returns the offset of a given window.
        hwIWindow GetSyncScale
        Returns the scale of a given window.
        hwIWindow GetViewControlHandle
        Returns the view control handle for the current client.
        hwIWindow GetXMLOutputType
        Gets the export file type for hwlSession_handle PublishSession.
        hwIWindow IsEmpty
        Tests if the window is empty.
        hwIWindow SetClientType
        Sets the window client type.
        hwIWindow SetHTMLCaption
        Sets the window caption used when exporting to HTML.
        hwIWindow SetHTMLOutputType
        Sets the window caption used when exporting to HTML.
        hwIWindow SetSyncOffset
        Sets the offset of a given window.
        hwIWindow SetSyncScale
        Sets the scale of a given window.
        hwIWindow SetXMLOutputType
        Sets the export file type for hwlSession_handle PublishSession.
      - hwIXMLFile Class
    - MotionView
    - HyperView
    - HyperGraph 2D
    - HyperGraph 3D
    - MediaView
    - TextView
    - 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.

hwIWindow SetHTMLOutputType

Sets the window caption used when exporting to HTML.

Syntax

hwIWindow_handle SetHTMLOutputType type

Application

Tcl Modify

Description

This parameter is used during HTML export. It indicates the type of the object created when you click on this window in the HTML report. Not all options are supported by every client.

Inputs

type: The output type of the window. Can be "avi", "jpeg", "h3d", "bitmap", or "html", depending on the client type.

Example

To set the HTML output type of window 1 on page 1 to h3d:

hwi GetSessionHandle mySessionName
mySessionName GetProjectHandle myProject 
myProject GetPageHandle myPage 1
myPage GetWindowHandle myWindow 1
myWindow SetHTMLOutputType h3d

Errors

Success (0) or an error code (see below).

3 = HW_InvalidHandle - The handle used to invoke the method is no longer valid.

HW_InvalidArgs - The value of argument type is invalid for the window’s client type.