Skip to main content

Speos Labs automation APIs 2024 R1

Caption

Last update: 17.07.2025

Description

Returns the caption title of the viewer/editor.

Syntax

object.Caption() As String

  • object: XM3Viewer object

VB script example

Sub TestLab()
  ' Starts the application
  Dim Viewer
  Set Viewer = CreateObject("Xm3Viewer.Application")
  ' Opens the file
  Dim MyVar
  MyVar = Viewer.OpenFile("C:\tmp\XM3Viewer\2cubes_005_4.xm3")
  Dim RetVal
  ' Gets the caption
  RetVal = Viewer.Caption()
End Sub

IronPython example

from System import Type, Activator
type = Type.GetTypeFromProgID("Xm3Viewer.Application")
MyXm3Viewer = Activator.CreateInstance(type)
# Gets the caption
Caption = MyXm3Viewer.Caption()

Connect with Ansys