pycatia3dx.interfaces.application¶
Module initially auto generated using DSYAutomation files from CATIA 3DX R2025x on 2025-09-13 15:35:27.265802
Warning
The notes denoted “3DEXPERIENCE Automation Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.
- class pycatia3dx.interfaces.application.Application(com_object)¶
-
- property cache_size: int¶
- Returns:
int
- property caption: str¶
- Returns:
str
- disable_new_undo_redo_transaction() None¶
- Returns:
None
- property display_file_alerts: bool¶
- Returns:
bool
- enable_new_undo_redo_transaction() None¶
- Returns:
None
- file_selection_box(i_title: str, i_extension: str, i_mode: int) str¶
- Parameters:
i_title (str)
i_extension (str)
i_mode (int)
- Returns:
str
- property file_system: FileSystem¶
- Returns:
FileSystem
- folder_selection_box(i_title: str) str¶
- Parameters:
i_title (str)
- Returns:
str
- property full_name: str¶
- Returns:
str
- get_workbench_id() str¶
- Returns:
str
- property height: float¶
- Returns:
float
- help(i_help_id: str) None¶
- Parameters:
i_help_id (str)
- Returns:
None
- property hso_synchronized: bool¶
- Returns:
bool
- input_box(prompt: str, title: str = '', default: str = '') str | None¶
Display InputBox in CATIA 3DExperience. Default position is in the center screen.
More information on https://learn.microsoft.com/en-us/office/vba/language/reference/user-interface-help/inputbox-function
- Parameters:
prompt (str) – Required. String expression displayed as the message in the dialog box.
title (str) – Optional. The default is ‘’. String expression displayed in the title bar of the dialog box.
default (str) – Optional. The default is ‘’. String expression displayed in the text box as the default response if no other input is provided. If you omit default, the text box is displayed empty.
- Returns:
str
- property interactive: bool¶
- Returns:
bool
- property left: float¶
- Returns:
float
- property local_cache: str¶
- Returns:
str
- message_box(message_text: str, buttons: int = 0, title: str = '') int | None¶
The button values
Constant
Value
Description
vbOKOnly
0
Display OK button only.
vbOKCancel
1
Display OK and Cancel buttons.
vbAbortRetryIgnore
2
Display Abort, Retry, and Ignore buttons
vbYesNoCancel
3
Display Yes, No, and Cancel buttons.
vbYesNo
4
Display Yes and No buttons.
vbRetryCancel
5
Display Retry and Cancel buttons.
vbCritical
16
Display Critical Message icon.
vbQuestion
32
Display Warning Query icon.
vbExclamation
48
Display Warning Message icon.
vbInformation
64
Display Information Message icon.
vbDefaultButton1
0
First button is default.
vbDefaultButton2
256
Second button is default.
vbDefaultButton3
512
Third button is default.
vbDefaultButton4
768
Fourth button is default.
vbApplicationModal
0
Application modal; the user must respond to the message box before continuing work in the current application.
vbSystemModal
4096
System modal; all applications are suspended until the user responds to the message box.
vbMsgBoxHelpButton
16384
Adds Help button to the message box.
vbMsgBoxSetForeground
65536
Specifies the message box window as the foreground window.
vbMsgBoxRight
524288
Text is right-aligned.
vbMsgBoxRtlReading
1048576
Specifies text should appear as right-to-left reading on Hebrew and Arabic systems.
Return values
Constant
Value
Description
vbOK
1
OK
vbCancel
2
Cancel
vbAbort
3
Abort
vbRetry
4
Retry
vbIgnore
5
Ignore
vbYes
6
Yes
vbNo
7
No
Example:
This creates a message box with the buttons abort, retry ignore and displays the Warning Query icon. >>> from pycatia3dx import catia3dx >>> application = catia3dx() >>> buttons = 2 + 32 >>> result = application.message_box('Hello World!?', buttons=buttons, title='Asking a question.') >>> # result = 3 if the user presses Abort.
- Parameters:
message_text (str) – Text to be displayed in the message box window.
buttons (int) – Defines the message box configuration. See example.
title (str) – Text to be displayed in the message box title bar.
- Returns:
Returns an int which is representative of the button pressed.
- Return type:
int
- property path: str¶
- Returns:
str
- quit() None¶
- Returns:
None
- property refresh_display: bool¶
- Returns:
bool
- property script_command: CatScriptCommand¶
- Returns:
CatScriptCommand
- start_command(i_command_id: str) None¶
- Parameters:
i_command_id (str)
- Returns:
None
- start_workbench(i_workbench_id: str) None¶
- Parameters:
i_workbench_id (str)
- Returns:
None
- property status_bar: str¶
- Returns:
str
- property system_configuration: SystemConfiguration¶
- Returns:
SystemConfiguration
- property system_service: SystemService¶
- Returns:
SystemService
- property top: float¶
- Returns:
float
- property undo_redo_lock: bool¶
- Returns:
bool
- property user_interface_language: str¶
- Returns:
str
- property visible: bool¶
- Returns:
bool
- property width: float¶
- Returns:
float