in_interfaces¶

application¶

class pycatia.in_interfaces.application.Application(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Application

Represents the current CNext application and its frame window.

The application is the root object for all the other objects you can use and

access from scripts. It directly aggregates:

The document collection represented by the Documents object. This

collection contains all the documents currently opened by the

application

The window collection represented by the Windows object. This collection

contains all the windows currently opened by the application, each window

displaying one of the documents contained in the document

collection

The SystemService object, providing information about the system

environment.

The active document and the active window are two key objects for the

application you can access using the ActiveDocument and ActiveWindow properties

respectively. The active window is the window the end user is currently working

in, and the active document is the document displayed in this active window and

that the end user is being editing. This document sets its workshop, that is

the available menus and toolbars that make it possible to edit it, according to

its type.

When you create or use macros for in-process access, the application is always

referred to as CATIA.

property active_document¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ActiveDocument() As Document (Read Only)

Returns the active document. The active document is the document the end

user is being editing.

Example:

This example retrieves in ActiveDoc the active document of the CATIA

application.

Dim ActiveDoc As Document

Set ActiveDoc = CATIA.ActiveDocument

Returns

Document()

property active_printer¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ActivePrinter() As Printer

Returns or sets the active printer. The active printer is the printer on

which documents are printed

Example:

This example retrieves in ActivePrinter the active printer of the CATIA

application.

Dim ActivePrinter As Printer

Set ActivePrinter = CATIA.ActivePrinter

Returns

Printer

property active_window¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ActiveWindow() As Window (Read Only)

Returns the active window. The active window is the window in which the end

user is currently editing the active document.

Example:

This example retrieves in ActiveWin the active window of the CATIA

application.

Dim ActiveWin As Window

Set ActiveWin = CATIA.ActiveWindow

Returns

Window

property cache_size¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CacheSize() As long

Returns or sets the default local cache size used by the

application.

Example:

This example sets the cache size for by the CATIA application to those

defined in LocalCacheSize.

LocalCacheSize= 10

CATIA.CacheSize = LocalCacheSize

Returns

int

property caption¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Caption() As CATBSTR

Returns or sets the application’s window title. This title is displayed in

the application’s window title bar.

Example:

This example retrieves in Title the CATIA application’s window

title.

Title = CATIA.Caption

The returned value is like this:

CNext

Returns

str

create_send_to()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CreateSendTo() As SendToService

Creates a Send TO.

Role:This method creates a SendToService instance.

Warning : CATIASendToService interface requires the

installation of CATIA - PPR xPDM Gateway 1 Product (PX1)

In case this product is not granted, the first invocation

to one of CATIASendToService methods will fail.

Returns

SendToService

disable_new_undo_redo_transaction()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub DisableNewUndoRedoTransaction()

Prevents new Undo/Redo transaction creation.

If too many Undo/Redo transactions are created during macro execution, it

may affect performance. So it is valuable to prevent Undo/Redo transaction

creation during macro execution when lots of data are created, deleted or

modified.

Note: preventing Undo/Redo transaction creation must not be done when a

selection is required in the macro

Do not forget to call EnableNewUndoRedoTransaction at the end of the macro

or before selection to restore the common behavior.

Example:

This example prevents new transactions to be created, which may

increase performance.

CATIA.DisableNewUndoRedoTransaction()

Returns

None

property display_file_alerts¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DisplayFileAlerts() As boolean

Returns or sets the application ability to display file

alerts.

True if the application enables file alert display.

True is the default. A file alert is, for example, the dialog box that

prompts you that the file you want to save is in read only mode, or that the

file you want to close needs to be saved. It could be handy to disable these

file alerts for automation since they may freeze your macro execution, waiting

for an end user input in the displayed dialog box.

Example:

This example disables file alerts for the CATIA

application.

CATIA.DisplayFileAlerts = False

Returns

bool

property documents¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Documents() As Documents (Read Only)

Returns the collection of documents currently managed by the

application.

Example:

This example retrieves in DocCollection the collection of documents

currently managed by the CATIA application.

Dim DocCollection As Documents

Set DocCollection = CATIA.Documents

Returns

Documents

enable_new_undo_redo_transaction()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub EnableNewUndoRedoTransaction()

Allows new Undo/Redo transaction creation.

Example:

This example restores the common behavior after

DisableNewUndoRedoTransaction has been called.

CATIA.EnableNewUndoRedoTransaction()

Returns

None

evaluate(vba_code, function_name, measurable_items, cat_script_language=0)¶

Note

CATIA V5 Visual Basic help

Func Evaluate( CATBSTR iScriptText,

CATScriptLanguage iLanguage,

CATBSTR iFunctionName,

CATSafeArrayVariant iParameters) As CATVariant

Evaluates a scripted function.

Parameters:

iScriptText

The program text

iLanguage

The language the program is written in

iFunctionName

The name of the function to invoke

iParameters

An array of parameters for the function

Result

The value returned by the function (if any)

Example:

This example executes the function CATMain from the CodeToEvaluate string

Dim params()

Dim codeToEvaluate

CodeToEvaluate = “Sub CATMain()” & vbNewLine & _

“MsgBox ” & chr(34) & “Hello World” & chr(34) & vbNewLine & _

“End Sub”

CATIA.SystemService.Evaluate CodeToEvaluate, CATVBScriptLanguage, “CATMain”, params

Parameters

• vba_code (str) – String containing script to run.

• function_name (str) – Name of function within vba script.

• measurable_items (list) – list of items to pass to script.

• cat_script_language (int) – An integer representing the language selection from list() [CATVBScriptLanguage, CATVBALanguage, CATBasicScriptLanguage, CATJavaLanguage, CATJScriptLanguage]

Returns

execute_script(library_name, library_type, program_name, function_name, items)¶

Note

CAA V5 Visual Basic help

Func ExecuteScript( CATBSTR iLibraryName,

CatScriptLibraryType iType,

CATBSTR iProgramName,

CATBSTR iFunctionName,

CATSafeArrayVariant iParameters) As CATVariant

Executes a scripted function.

Parameters:

iLibraryName

The library in which the script is contained

iLibraryType

The type of the library

iProgramName

The name of the program in the library

iFunctionName

The name of the function to invoke

iParameters

An array of parameters for the function

Result

The value returned by the function (if any)

Example:

This example executes the function CATMain in the program Macro1.catvbs contained by Part1.CATPart

Dim params()

CATIA.SystemService.ExecuteScript”Part1.CATPart”,

catScriptLibraryTypeDocument,

“Macro1.catvbs”,

“CATMain”,

params

Parameters

• library_name (str) – Full path to location of catia script.

• library_type (int) – An integer representing the library type selection from list() CatScriptLibraryType[catScriptLibraryTypeDocument, catScriptLibraryTypeDirectory, catScriptLibraryTypeVBAProject]

• program_name (str) – file name of script.

• function_name (str) – Name of function to call within script.

• items (list) – List of items to pass to script.

Returns

property file_search_order¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FileSearchOrder() As CATBSTR

Returns or sets the default path concatenation.

Role: This property returns or sets the default path concatenation used by

Other folders setting of the Linked Documents Localization function. The

primary aim of the Linked Documents Localization function is to resolve

document links and to manage the strategy that will be used to locate your

linked documents.

Example:

This example sets the paths to search for by the CATIA application to

those defined in PathConcatenation.

PathConcatenation = “/u/users/fbq/db/model:/u/users/psr/db/model”

CATIA.FileSearchOrder = PathConcatenation

Theese methods require the installation of CATIA - PPR xPDM Gateway 1

Product (PX1) In case this product is not granted, the first invocation to one

of the methods will fail.

Returns

str

file_selection_box(i_title, i_extension, i_mode)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func FileSelectionBox(CATBSTR iTitle,

CATBSTR iExtension,

CatFileSelectionMode iMode) As CATBSTR

Displays a modal dialog box which can be used to select / enter the name of

a file to open / save.

Parameters:

iTitle

The title of the dialog box.

iExtension

A file extension filter.

iMode

The mode in which to run the dialog box (either

CatFileSelectionModeOpen or CatFileSelectionModeSave.

oFilePath

The return string containing the full path of the selected file, or

a zero-length string if the user selects Cancel.

Example:

This example asks the user to select a text file and prints the

path of the selected file.

filepath = CATIA.FileSelectionBox(“Select a text file”,

“*.txt”, CatFileSelectionModeOpen)

CATIA.SystemServices.Print “The selected file is ” &

filepath

Parameters

• i_title (str) –

• i_extension (str) –

• i_mode (CatFileSelectionMode) –

Returns

str

property file_system¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FileSystem() As FileSystem (Read Only)

Returns the file system. The file system provides access to a computer’s

file system.

Example:

This example retrieves in AppliFileSys the file sytem of the CATIA

application.

Dim AppliFileSys As FileSystem

Set AppliFileSys = CATIA.FileSystem

Returns

FileSystem

property full_name¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FullName() As CATBSTR (Read Only)

Returns the application’s executable file full name, including its path.

This name is the name of the executable file used to start the

application.

Example:

This example retrieves in ApplicationFullName the CATIA application’s

executable file full name.

ApplicationFullName = CATIA.FullName

The returned value is like this:

\lisacxr1arelbsfalpha_acodebinCNEXT.exe

Returns

str

get_workbench_id()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetWorkbenchId() As CATBSTR

Returns the identifier of the CATIA current workbench.

Parameters:

oworkbenchId

The id of the current workbench.

Returns

str

property height¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Height() As float

Returns or sets the height of the application’s frame window. The height is

expressed in pixels.

Example:

This example sets the height of the CATIA application’s frame window to

300 pixels.

CATIA.Height = 300

Returns

float

help(i_help_id)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Help(CATBSTR iHelpID)

Displays application’s online help.

Parameters:

iHelpID

Identifier of the help message to display

Example:

This example displays the string referred to by the HelpKey message key

in the message catalog concatenation.

CATIA.Help(“HelpKey”)

Parameters

i_help_id (str) –

Returns

None

property hso_synchronized¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property HSOSynchronized() As boolean

For selection performance purposes, returns or sets the HSO synchronization

in comparison with the CSO.

Role: Precises if, for all Selection object instances, the HSO (Highlighted

Set of Objects) is synchronized in comparison with the CSO (Current Set of

Objects).

Valid values are:

True: In this case, Selection methods work directly with CATIA’s CSO,

to reflect instantly the changes made in Automation Selection. This ensures

correct selection results, but may impact performance in certain

cases.

This is the default value at the beginning of a CATIA

session.

False: In this case, Selection methods work with an internal SO buffer,

which allows faster execution when performing a large number of CSO-independent

Selection calls, or when performing a single Selection call working on a large

number of objects (usually the Search method). This may also prevent the

features from blinking between two user interactions.

Note: even if this property is set to False, the HSO is synchronized in

comparison with the CSO at the begining of the following

methods:

Selection.SelectElement2

Selection.SelectElement3

Selection.SelectElement4

Selection.IndicateOrSelectElement2D

Selection.IndicateOrSelectElement3D

Application.StartCommand

CAUTION: If you use the False value of this property, you must make sure to

reset it to True for CATIA’s CSO to reflect properly the changes made in

Automation Selection. For example, it should be reset to True before

interactive parts of your script: MsgBox, InputBox calls, VBA forms updates and

so on.

Returns

bool

property interactive¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Interactive() As boolean

Returns or sets the application sensitivity to end user

interactions.

True if the application is end user interaction sensitive.

Example:

This example makes the CATIA application sensitive to end user

interactions.

CATIA.Interactive = True

Returns

bool

property left¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Left() As float

Returns or sets the distance from the application’s frame window left side

to the left side of the screen. This distance is expressed in

pixels.

Example:

This example sets the distance from the CATIA application’s frame

window left side to the left side of the screen to 150

pixels.

CATIA.Left = 150

Returns

float

property local_cache¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property LocalCache() As CATBSTR

Returns or sets the default local cache path used by the

application.

Example:

This example sets the cache path for by the CATIA application to those

defined in LocalCachePath.

LocalCachePath= “/tmp/cache”

CATIA.LocalCache = LocalCachePath

Returns

str

property path¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Path() As CATBSTR (Read Only)

Returns the path of the application’s executable files.

Example:

This example retrieves in ApplicationPath the path where the CATIA

application executable files are located.

ApplicationPath = CATIA.Path

The returned value is like this:

\lisacxr1arelbsfalpha_acodebin

Returns

Path()

property printers¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Printers() As Printers (Read Only)

Returns the collection of the printers currently managed by the

application.

Example:

This example retrieves in PrintersCollection the collection of the

printers currently managed by the CATIA application.

Dim PrintersCollection As Windows

Set PrintersCollection = CATIA.Printers

Returns

Printers

quit()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Quit()

Exits the application and closes all open documents.

Example:

This example exits the CATIA application and closes all its open

documents.

CATIA.Quit()

Returns

None

property refresh_display¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property RefreshDisplay() As boolean

Enables or disables the update of the display during the script replay. To

improve performance, this update can be temporarely disabled by setting this

property to False in the script.

True (value set by default) if the application’s display is refreshed after

each method call executed in late binding mode . This property does not affect

early binding calls nor the get methods because they are never followed by a

refresh of the display.

Example:

This example makes the update of the CATIA application’s display

disabled during the script replay.

CATIA.RefreshDisplay = False

Returns

bool

start_command(i_command_id)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub StartCommand(CATBSTR iCommandId)

Starts a CATIA command.

Role:This method starts a command and executes it untill its first

interaction. Please notice interactions such as selections you could add after

in your macro will not work. StartCommand is useful to execute one-shot (not

interactive) commands, it is not safe for interactive

commands.

Parameters:

iCommandId

The id of the command to be started. This id can be the name of the

command or its alias.

Parameters

i_command_id (str) –

Returns

None

start_workbench(iworkbench_id)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub StartWorkbench(CATBSTR iworkbenchId)

Starts a CATIA workbench.

Parameters:

iworkbenchId

The id of the workbench to be started.

Parameters

iworkbench_id (str) –

Returns

None

property status_bar¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property StatusBar() As CATBSTR

Returns or sets the text displayed in the application’s window status

bar.

Example:

This example retrieves in Text the text displayed in the CATIA

application’s window status bar.

Text = CATIA.StatusBar

The returned value is like this:

Welcome to CATIA CxR1

Returns

str

property system_configuration¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SystemConfiguration() As SystemConfiguration (Read

Only)

Returns the system configuration object (an object which provides access to

system or configuration dependent resources).

Parameters:

oConfiguration

The system configuration object.

Returns

SystemConfiguration

property system_service¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SystemService() As SystemService (Read Only)

Returns system services.

Example:

This example retrieves in AppliSysSer the CATIA application’s system

services.

Dim AppliSysSer As SystemService

Set AppliSysSer = CATIA.SystemService

Returns

SystemService

property top¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Top() As float

Returns or sets the distance from the application’si frame window top to

the top of the screen. This distance is expressed in

pixels.

Example:

This example sets the distance from the CATIA application’s frame

window top to the top of the screen to 50 pixels.

CATIA.Top = 50

Returns

float

property undo_redo_lock¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property UndoRedoLock() As boolean

Returns or sets the application status about Undo/Redo.

True if the Undo/Redo mechanism is locked.

False is the default. Since Undo/Redo mechanism uses lots of memory, it can

be useful to disable it during consuming operations. Then Undo and Redo stacks

are flushed and no model modification is kept until the Undo/Redo mechanism is

unlocked. It is mandatory to unlock it before the end of the

macro.

Example:

This example disables Undo/Redo mechanism until it is

unlocked.

CATIA.UndoRedoLock = True

Returns

bool

property visible¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Visible() As boolean

Returns or sets the application’s window visibility.

True if the application’s window is visible to the end

user.

Example:

This example makes the CATIA application’s window

visible.

CATIA.Visibility = True

Returns

bool

property width¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Width() As float

Returns or sets the width of the application’s frame window. The width is

expressed in pixels.

Example:

This example sets the width of the CATIA application’s frame window to

350 pixels.

CATIA.Width = 350

Returns

float

property windows¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Windows() As Windows (Read Only)

Returns the collection of windows currently managed by the

application.

Example:

This example retrieves in WinCollection the collection of windows

currently managed by the CATIA application.

Dim WinCollection As Windows

Set WinCollection = CATIA.Windows

Returns

Windows

camera¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.camera.Camera(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Camera

Represents the camera.

The camera is the object that stores a viewpoint saved from a viewer at a given

moment using the Viewer.NewCamera method of the Viewer object. The viewpoint

stored in the camera can then be applied to another viewer to display the

document in this viewer according to this viewpoint.

property type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Type() As CatCameraType (Read Only)

Returns the camera’s type.

Example:

This example retrieves in MyCameraType the type of the MyCamera 3D

camera and applies the viewpoint stored in this camera to the active

viewer.

MyCameraType = MyCamera.Type

CATIA.ActiveWindow.ActiveViewer.Viewpoint3D = MyCamera.Viewpoint3D

The value returned by the Type property in MyCameraType is catCamera3D

Returns

enum cat_camera_type

camera2_d¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.camera2_d.Camera2D(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

InfInterfaces.Camera

Camera2D

Represents a 2D camera.

The 2D camera stores a 2D viewpoint, that is a Viewpoint2D

object.

property viewpoint2_d¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Viewpoint2D() As Viewpoint2D

Returns or sets the 2D viewpoint of a 2D camera.

Example:

Assume the active window is a SpecsAndGeomWindow object. This example

retrieves the Viewpoint2D of the SpecsViewer and creates from it a Camera2D you

handle using the MyCamera variable. Then the camera zoom is set to 2, and the

camera’s viewpoint is assigned to the SpecsViewer.

Dim MyCamera As Camera

Set MyCamera = CATIA.ActiveWindow.SpecsViewer.NewCamera()

MyCamera.Viewpoint2D.Zoom = 2

CATIA.ActiveWindow.SpecsViewer.Viewpoint2D = MyCamera.Viewpoint2D

Returns

Viewpoint2D

camera3_d¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.camera3_d.Camera3D(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

InfInterfaces.Camera

Camera3D

Represents a 3D camera.

The 3D camera stores a 3D viewpoint, that is a Viewpoint3D

object.

property viewpoint3_d¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Viewpoint3D() As Viewpoint3D

Returns or sets the 3D viewpoint of a 3D camera.

Example:

Assume the active window is a SpecsAndGeomWindow object. This example

retrieves the Viewpoint3D of the active 3D viewer and creates from it a

Camera3D you handle using the MyCamera variable. Then the camera zoom is set to

2, and the camera’s viewpoint is assigned to the active

viewer.

Dim MyCamera As Camera3D

Set MyCamera = CATIA.ActiveWindow.ActiveViewer.NewCamera()

MyCamera.Viewpoint3D.Zoom = 2

CATIA.ActiveWindow.ActiveViewer.Viewpoint3D = MyCamera.Viewpoint3D

Returns

Viewpoint3D

cameras¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.cameras.Cameras(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Cameras

A collection of all the Camera objects currently attached to a Document

object.

A camera can be created using the Viewer.NewCamera method of the Viewer object.

The first seventh cameras of the collection are Camera3D objects and cannot be

modified or removed. They can just be retrieved and used “as is”. They store

the following viewpoints whose sight direction is always toward the 3D-axis

system origin:

* iso

The origin is on a line with (1,1,1) as components with positive

coordinates

* front

The origin is on the x axis with a positive x coordinate

* back

The origin is on the x axis with a negative x coordinate

* left

The origin is on the y axis with a positive y coordinate

* right

The origin is on the y axis with a negative y coordinate

* top

The origin is on the z axis with a positive z coordinate

* bottom

The origin is on the z axis with a negative z coordinate

The cameras of the Cameras collection are available using the dialog box

displayed by clicking the View->Defined Views menu.

item(i_index)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As Camera

Returns a camera using its index or its name from the Cameras

collection.

Parameters:

iIndex

The index or the name of the camera to retrieve from the collection

of cameras. As a numerics, this index is the rank of the camera in the

collection. The index of the first camera in the collection is 1, and the index

of the last camera is Count. As a string, it is the name you assigned to the

camera using the

AnyObject.Name property.

Returns:

The retrieved camera

Example:

This example retrieves in ThisCamera the ninth camera, and in

ThatCamera the camera named MyCamera in the camera collection of the active

document.

Dim ThisCamera As Camera

Set ThisCamera = CATIA.ActiveDocument.Cameras.Item(9)

Dim ThatCamera As Camera

Set ThatCamera = CATIA.ActiveDocument.Cameras.Item(“MyCamera”)

Parameters

i_index (CATVariant) –

Returns

Camera

remove(i_index)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Remove(CATVariant iIndex)

Removes a camera from the Cameras collection.

Parameters:

iIndex

The index or the name of the camera to remove from the collection

of cameras. As a numerics, this index is the rank of the camera in the

collection. The index of the first camera in the collection is 1, and the index

of the last camera is Count. As a string, it is the name you assigned to the

camera using the

AnyObject.Name property. You cannot remove the first seventh cameras in

the collection.

Example:

The following example removes the tenth camera and the camera named

CameraToBeRemoved in the camera collection of the active

document.

CATIA.ActiveDocument.Cameras.Remove(10)

CATIA.ActiveDocument.Cameras.Remove(“CameraToBeRemoved”)

Parameters

i_index (CATVariant) –

Returns

None

cgr_adhesion_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.cgr_adhesion_setting_att.CgrAdhesionSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

CGRAdhesionSettingAtt

Represents the base object to handle the parameters of the

cache.

get_v4_model_comment_page_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetV4_Model_CommentPageInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Locks or unlocks the V4_Model_CommentPage container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

• admin_level (str) –

• o_locked (str) –

Returns

bool

get_v4_model_ln_f_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetV4_Model_LnFInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the V4_Model_LnF container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

• admin_level (str) –

• o_locked (str) –

Returns

bool

get_v4_v5_fdt_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetV4V5_FDTInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the V4V5_FDT container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

• admin_level (str) –

• o_locked (str) –

Returns

bool

get_v5_spa_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetV5_SPAInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the V5_SPA container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

• admin_level (str) –

• o_locked (str) –

Returns

bool

get_voxels_info(admin_level, o_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetVoxelsInfo(CATBSTR AdminLevel,

CATBSTR oLocked) As boolean

Retrieves information about the Voxels container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

• admin_level (str) –

• o_locked (str) –

Returns

bool

set_v4_model_comment_page_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetV4_Model_CommentPageLock(boolean iLocked)

Retrieves information about the V4_Model_CommentPage container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

set_v4_model_ln_f_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetV4_Model_LnFLock(boolean iLocked)

Locks or unlocks the V4_Model_LnF container activation

state.

Refer to CATSysSettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

set_v4_v5_fdt_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetV4V5_FDTLock(boolean iLocked)

Locks or unlocks the V4V5_FDT container activation state.

Refer to CATSysSettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

set_v5_spa_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetV5_SPALock(boolean iLocked)

Locks or unlocks the V5_SPA container activation state.

Refer to CATSysSettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

set_voxels_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetVoxelsLock(boolean iLocked)

Locks or unlocks the Voxels container activation state.

Refer to CATSysSettingController for a detailed description.

Parameters

i_locked (bool) –

Returns

None

property v4_model_comment_page¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property V4_Model_CommentPage() As boolean

Retrieves the V4_Model_CommentPage container activation state.

Returns

bool

property v4_model_ln_f¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property V4_Model_LnF() As boolean

Retrieves the V4_Model_LnF container activation state.

Returns

bool

property v4_v5_fdt¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property V4V5_FDT() As boolean

Retrieves the V4V5_FDT container activation state.

Returns

bool

property v5_spa¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property V5_SPA() As boolean

Retrieves the V5_SPA container activation state.

Returns

bool

property voxels¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Voxels() As boolean

Retrieves the Voxels container activation state.

Returns

bool

document¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.document.Document(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Document

Represents the document.

The document is the object handled by the operating system as a whole that

stores your data in files and databases. It is assigned a type determined by

its contents. It may contain other documents with a different type. For

example, a PartDocument contains a part and can be contained in a

ProductDocument. A workshop is associated with a document to gather all the

commands that can be used to create, modify, and edit the objects making up the

the document. These commands are arranged in menus and

toolbars.

See also:

PartDocument, ProductDocument, DrawingDocument

activate()¶

Activates the document

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Activate()

Activates the document. Activating a document means that this document is

the one on which the end user is now working on. This document possibly

reconfigures the menu bar and toolbars with its own commands if its type is

different from the type of the previous active document. The first window in

the window collection which contains this document becomes the active

one.

Example:

This example activates the Doc document.

Doc.Activate()

property cameras¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Cameras() As Cameras (Read Only)

Returns the document’s collection of cameras.

Example:

This example retrieves in CameraCollection the collection of cameras

attached to the Doc document.

Dim CameraCollection As Cameras

Set CameraCollection = Doc.Cameras

Returns

Cameras

close()¶

Closes the current document.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Close()

Closes the document. This closes all the windows displaying the document.

If the document needs to be saved, the end user is prompted whether to save the

document, or to close it anyway.

Example:

This example closes the Doc document

Doc.Close()

create_filter(i_filter_name=None, i_filter_definition=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CreateFilter(CATBSTR iFilterName,

CATBSTR iFilterDefinition)

Creates a new visualization filter from a name and a definition. Fails if

there is already a filter named iFilterName.

Parameters:

iFilterName

The filter name.

iFilterDefinition

The filter definition

Example:

This example creates the filter named “Filter001” and with “layer=

2 & layer= 1” definition for the Doc document.

Doc.CreateFilter (“Filter001”, “layer= 2 & layer=

1”)

Parameters

• i_filter_name (str) –

• i_filter_definition (str) –

Returns

None

create_reference_from_name(i_label=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CreateReferenceFromName(CATBSTR iLabel) As Reference

Creates a reference from a GenericNaming label. Each kind of document

provides a specific implementation.

Parameters:

iLabel

The GenericNaming identification for an object.

Returns:

The reference to the object.

Parameters

i_label (str) –

Returns

Reference

property current_filter¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CurrentFilter() As CATBSTR

Returns or sets the current visualization filter. CurrentFilter uses the

filter name and not its definition. The “All visible” filter means that all

layers are visible. For all filters, remind that the current layer is always

visible.

Example:

This example makes the filter named “Filter001” as the current

visualization filter for the Doc document.

Doc.CurrentFilter = “Filter001”

Returns

str

property current_layer¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CurrentLayer() As CATBSTR

Returns or sets the current layer. CurrentLayer uses the layer name and not

its number. The “None” layer means that there is no current

layer.

Example:

This example makes the layer named “Layer 3” as the current layer for

the Doc document.

Doc.CurrentLayer = “Layer 3”

Returns

str

drawing_root()¶

Returns

export_data(file_name, file_type, overwrite=False)¶

Note

CAA V5 Visual Basic help

Sub ExportData( CATBSTR fileName, CATBSTR format)

Exports the data contained in the document to another format.

Parameters:

fileName

The name of the exported file

format

The name of the format

Example:

This example writes the Doc document in the IGES format under the IGESDoc name.

Doc.ExportData(“IGESDoc”, “igs”)

Parameters

• file_name (str) – file_name including full path.

• file_type (str) – file_type is the extension of required file_type. The file_type must be supported by CATIA and the CATIA license.

• overwrite (bool) –

Returns

property full_name¶

Note

CAA V5 Visual Basic help

Property FullName( ) As CATBSTR (Read Only)

Returns the document’s full file name, including its path.

Example:

This example retrieves in DocFullName the Doc document’s full file name.

DocFullName = Doc.FullName

The returned value is like this:

e://users//psr//Parts//MyNicePart.CATPart

Returns

str - full path document name

get_workbench(workbench_name=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetWorkbench(CATBSTR workbenchName) As Workbench

Returns one of the workbenches of the document.

Parameters:

workbenchName

The name of the workbench

Example:

This example retrieves the Structural workbench on the Doc

document

Doc.GetWorkbench(“Structural”)

Parameters

workbench_name (str) –

Returns

Workbench

indicate_2d(i_message=None, io_document_window_location=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Indicate2D(CATBSTR iMessage,

CATSafeArrayVariant ioDocumentWindowLocation) As CATBSTR

Runs an 2D interactive indication command.

Role: Indicate2D asks to the user to select a location in the document

window. It can be used:

When this document is a DrawingDocument

When this document is a PartDocument, and a sketch is being edited (

Sketch.OpenEdition has been called and Sketch.CloseEdition has not been called

yet)

See also: Selection.IndicateOrSelectElement2D which can, in particular,

enable indication and not selection (positionning the iFilterType parameter to

an empty string), whichs enables to subscribe to mouse move events,

positionning the iTriggeringOnPreSelection to true.

Note:If the scripting language is Visual Basic for Applications or Visual

Basic 6 Development Studio, then, you have to know that during the execution of

an interactive selection method such as this one, no form (dialog box) must be

displayed, otherwise it would lead to unpredictible results. In a form method,

before calling an interactive selection method such as Document.Indicate2D, you

must hide all forms, and, after the call to the method, you must show the

forms.

Parameters:

iMessage

A string which instructs the user that he must select a location in

the document window. This string is displayed in the message area located at

the left of the power input area.

oDocumentWindowLocation

An array made of 2 doubles: X, Y - coordinates array of the

location the user specified in the document window.

oOutputState

The state of the indication command once Indicate2D returns. It can

be either “Normal” (the indication has succeeded), “Cancel” (the user wants to

cancel the VB command, which must exit immediately, see the oOutputState

parameter of the

Selection.SelectElement2 method), “Undo” or “Redo”. About the use of

“Undo” and “Redo”, see the example of the Selection.SelectElement2 method.

Example:

The following example suppose a drawing document is currently edited.

It asks the end user to select a

location in the current drawing window, and creates a text (see

DrawingText ) at the specified location:

Set Document = CATIA.ActiveDocument :

Set Selection = Document.Selection :

Set DrawingSheets = Document.Sheets

Set DrawingSheet = DrawingSheets.ActiveSheet : Set DrawingViews = DrawingSheet.Views

Set DrawingView = DrawingViews.ActiveView : Set DrawingTexts = DrawingView.Texts

‘We propose to the user that he specify a location in the drawing

window

Dim DrawingWindowLocation(1)

Status=Document.Indicate2D(“select a location into the drawing

window”,DrawingWindowLocation)

if (Status = “Cancel”) then Exit Sub

Set DrawingText=DrawingTexts.Add(“Hello

world”,DrawingWindowLocation(0),DrawingWindowLocation(1))

Parameters

• i_message (str) –

• io_document_window_location (tuple) –

Returns

str

indicate_3d(i_planar_geometric_object=None, i_message=None, io_window_location2_d=None, io_window_location3_d=None)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Indicate3D(AnyObject iPlanarGeometricObject,

CATBSTR iMessage,

CATSafeArrayVariant ioWindowLocation2D,

CATSafeArrayVariant ioWindowLocation3D) As CATBSTR

Runs an 3D interactive indication command.

Role: Indicate3D asks to the user to select a location in the document

window. It cannot be used:

When this document is a DrawingDocument

When this document is a PartDocument, and a sketch is being edited (

Sketch.OpenEdition has been called and Sketch.CloseEdition has not been called

yet)

In these cases, Indicate2D must be used.

See also: Selection.IndicateOrSelectElement3D which can, in particular,

enable indication and not selection (positionning the iFilterType parameter to

an empty string), whichs enables to subscribe to mouse move events,

positionning the iTriggeringOnPreSelection to true.

Note:If the scripting language is Visual Basic for Applications or Visual

Basic 6 Development Studio, then, you have to know that during the execution of

an interactive selection method such as this one, no form (dialog box) must be

displayed, otherwise it would lead to unpredictible results. In a form method,

before calling an interactive selection method such as Document.Indicate2D, you

must hide all forms, and, after the call to the method, you must show the

forms.

Parameters:

iPlanarGeometricObject

A planar geometric object.

The following objects are supported:

HybridShapeCircle, HybridShapeCircleExplicit, HybridShapeConic, Sketch,

Circle2D, Ellipse2D, Hyperbola2D, Parabola2D and Spline2D.

iMessage

A string which instructs the user that he must select a location in the

document window. This string is displayed in the message area located at the

left of the power input area.

oWindowLocation2D

An array made of 2 doubles: X, Y - coordinates array of the location

the user specified in the document window, in the input planar object

coordinates system

oWindowLocation3D

An array made of 3 doubles: X, Y, Z - coordinates array of the location

the user specified in the document window

oOutputState

The state of the indication command once Indicate3D returns. It can be

either “Normal” (the indication has succeeded), “Cancel” (the user wants to

cancel the VB command, which must exit immediately, see the oOutputState

parameter of the Selection.SelectElement2 method), “Undo” or “Redo”. About the

use of “Undo” and “Redo”, see the example of the Selection.SelectElement2

method.

Example:

The following example asks the end user to select a location in the

document window, on the Plane.1 plane, and creates a

HybridShapePointOnPlane at the specified location:

Set Document = CATIA.ActiveDocument :

Set Part = Document.Part :

Set Selection = Document.Selection

Set HybridShapeFactory = Part.HybridShapeFactory

Set HybridShapePlane = Part.Bodies.Item(“PartBody”).HybridShapes.Item(“Plane.1”)

Set PlaneReference = Part.CreateReferenceFromObject(HybridShapePlane)

‘We propose to the user that he select a location in the

window

ReDim WindowLocation2D(1),WindowLocation3D(2)

Status=Document.Indicate3D(HybridShapePlane,”select a location in the

document window”, _

WindowLocation2D,WindowLocation3D)

if (Status = “Cancel”) then Exit Sub

Set HybridShapePointOnPlane = HybridShapeFactory.AddNewPointOnPlane( _

PlaneReference,WindowLocation2D(0),WindowLocation2D(1))

Part.Bodies.Item(“PartBody”).InsertHybridShape

HybridShapePointOnPlane

Part.InWorkObject = HybridShapePointOnPlane

Part.Update

Parameters

• i_planar_geometric_object (AnyObject) –

• i_message (str) –

• io_window_location2_d (tuple) –

• io_window_location3_d (tuple) –

Returns

str

property is_part¶

Determine whether the active document is a CATPart.

Returns

bool

property is_product¶

Determine whether the active document is a CATProduct.

Returns

bool

property is_saved¶

Returns true if document is saved.

Note

CAA V5 Visual Basic help

Property Saved( ) As boolean (Read Only)

Returns whether the document has been modified, and thus needs to be saved. This happens when the document has changed since either its creation or its last save. True if the document has not been changed: the document doesn’t need to be saved. False if the document has been changed: the document needs to be saved.

Example:

This example retrieves in HasChanged whether the Doc document needs to be saved.

HasChanged = NOT Doc.Saved

Returns

bool

new_window()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func NewWindow() As Window

Duplicates the window which contains the active document. This implies

creating a window, displaying the active document in this window with the same

view point, making this window the active one, and adding the window to the

collection of windows.

Example:

This example creates the MyWindow new window for the Doc

document.

Dim MyWindow As Window

Set MyWindow = Doc.NewWindow()

Returns

Window

part()¶

Returns

Part()

path()¶

Returns the pathlib.Path() object of the document fullname.

example e://users//psr//Parts//MyNicePart.CATPart >>> Document.path().name MyNicePart.CATPart >>> Document.path().parent e://users//psr//Parts// >>> Document.path().suffix .CATPart

Returns

Path()

product()¶

Returns

Product()

property read_only¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ReadOnly() As boolean (Read Only)

Returns whether the file containing the document can be read only, on can

be read and written.

True if the file is read-only.

Example:

This example retrieves in IsReadOnly the ability to read, and possibly

to write in, the file containing the Doc document.

IsReadOnly = Doc.ReadOnly

Returns

bool

remove_filter(i_filter_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveFilter(CATBSTR iFilterName)

Removes an existing visualization filter. Fails if the filter to be removed

is the current filter.

Parameters:

iFilterName

The filter name.

Example:

This example removes the filter named “Filter001” for the Doc

document.

Doc.RemoveFilter (“Filter001”)

Parameters

i_filter_name (str) –

Returns

None

save()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Save()

Saves the document.

Example:

This example saves the Doc document.

Doc.Save()

Returns

None

save_as(file_name, overwrite=False)¶

Save the document to a new name.

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SaveAs(CATBSTR fileName)

Saves the document with another name.

Parameters:

fileName

The name to assign to the document

Example:

This example saves the Doc document with the NewName

name.

Doc.SaveAs(“NewName”)

Parameters

• file_name (str) – full pathname to new file_name

• overwrite (bool) –

static search_for_items(document, selection_objects)¶

# todo: This search is currently restricted to GSD objects only.

Selection objects is a list of items to search for. Example: selection_objects = [‘Point’, ‘Line’]

Example query string to search for all lines and points “(‘Generative Shape Design’.Point + ‘Generative Shape Design’.Line),in”

Parameters

• document –

• selection_objects (list) –

Return Selected Automation Object

property see_hidden_elements¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SeeHiddenElements() As boolean

Returns or sets the document’s hidden elements visibility.

True if the document’s hidden elements are visible to the

user.

Example:

This example makes the Doc document’s hidden elements

visible.

Doc.SeeHiddenElements = True

Returns

bool

property selection¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Selection() As Selection (Read Only)

Returns the current selection. The current selection is the object or the

set of objects the end user has selected, usually with the mouse, in the active

document displayed in the active window.

Example:

This example returns in CurSel the current selection in the Doc

document

Dim CurSel As Selection

Set CurSel = Doc.Selection

Returns

Selection

spa_workbench()¶

Returns:

documentation_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.documentation_setting_att.DocumentationSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

Document

Represents the document.

The document is the object handled by the operating system as a whole that

stores your data in files and databases. It is assigned a type determined by

its contents. It may contain other documents with a different type. For

example, a PartDocument contains a part and can be contained in a

ProductDocument. A workshop is associated with a document to gather all the

commands that can be used to create, modify, and edit the objects making up the

the document. These commands are arranged in menus and

toolbars.

See also:

PartDocument, ProductDocument, DrawingDocument

activate()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Activate()

Activates the document. Activating a document means that this document is

the one on which the end user is now working on. This document possibly

reconfigures the menu bar and toolbars with its own commands if its type is

different from the type of the previous active document. The first window in

the window collection which contains this document becomes the active

one.

Example:

This example activates the Doc document.

Doc.Activate()

Returns

None

property cameras¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Cameras() As Cameras (Read Only)

Returns the document’s collection of cameras.

Example:

This example retrieves in CameraCollection the collection of cameras

attached to the Doc document.

Dim CameraCollection As Cameras

Set CameraCollection = Doc.Cameras

Returns

Cameras

close()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Close()

Closes the document. This closes all the windows displaying the document.

If the document needs to be saved, the end user is prompted whether to save the

document, or to close it anyway.

Example:

This example closes the Doc document

Doc.Close()

Returns

None

create_filter(i_filter_name, i_filter_definition)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CreateFilter(CATBSTR iFilterName,

CATBSTR iFilterDefinition)

Creates a new visualization filter from a name and a definition. Fails if

there is already a filter named iFilterName.

Parameters:

iFilterName

The filter name.

iFilterDefinition

The filter definition

Example:

This example creates the filter named “Filter001” and with “layer=

2 & layer= 1” definition for the Doc document.

Doc.CreateFilter (“Filter001”, “layer= 2 & layer=

1”)

Parameters

• i_filter_name (str) –

• i_filter_definition (str) –

Returns

None

create_reference_from_name(i_label)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CreateReferenceFromName(CATBSTR iLabel) As Reference

Creates a reference from a GenericNaming label. Each kind of document

provides a specific implementation.

Parameters:

iLabel

The GenericNaming identification for an object.

Returns:

The reference to the object.

Parameters

i_label (str) –

Returns

Reference

property current_filter¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CurrentFilter() As CATBSTR

Returns or sets the current visualization filter. CurrentFilter uses the

filter name and not its definition. The “All visible” filter means that all

layers are visible. For all filters, remind that the current layer is always

visible.

Example:

This example makes the filter named “Filter001” as the current

visualization filter for the Doc document.

Doc.CurrentFilter = “Filter001”

Returns

str

property current_layer¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property CurrentLayer() As CATBSTR

Returns or sets the current layer. CurrentLayer uses the layer name and not

its number. The “None” layer means that there is no current

layer.

Example:

This example makes the layer named “Layer 3” as the current layer for

the Doc document.

Doc.CurrentLayer = “Layer 3”

Returns

str

export_data(file_name, format_py)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub ExportData(CATBSTR fileName,

CATBSTR format)

Exports the data contained in the document to another

format.

Parameters:

fileName

The name of the exported file

format

The name of the format

Example:

This example writes the Doc document in the IGES format under the

IGESDoc name.

Doc.ExportData(“IGESDoc”, “igs”)

Parameters

• file_name (str) –

• format_py (str) –

Returns

None

property full_name¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FullName() As CATBSTR (Read Only)

Returns the document’s full file name, including its path.

Example:

This example retrieves in DocFullName the Doc document’s full file

name.

DocFullName = Doc.FullName

The returned value is like this:

e:/users/psr/Parts/MyNicePart.CATPart

Returns

str

get_workbench(workbench_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetWorkbench(CATBSTR workbenchName) As Workbench

Returns one of the workbenches of the document.

Parameters:

workbenchName

The name of the workbench

Example:

This example retrieves the Structural workbench on the Doc

document

Doc.GetWorkbench(“Structural”)

Parameters

workbench_name (str) –

Returns

Workbench

indicate2_d(i_message, io_document_window_location)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Indicate2D(CATBSTR iMessage,

CATSafeArrayVariant ioDocumentWindowLocation) As CATBSTR

Runs an 2D interactive indication command.

Role: Indicate2D asks to the user to select a location in the document

window. It can be used:

When this document is a DrawingDocument

When this document is a PartDocument, and a sketch is being edited (

Sketch.OpenEdition has been called and Sketch.CloseEdition has not been called

yet)

See also: Selection.IndicateOrSelectElement2D which can, in particular,

enable indication and not selection (positionning the iFilterType parameter to

an empty string), whichs enables to subscribe to mouse move events,

positionning the iTriggeringOnPreSelection to true.

Note:If the scripting language is Visual Basic for Applications or Visual

Basic 6 Development Studio, then, you have to know that during the execution of

an interactive selection method such as this one, no form (dialog box) must be

displayed, otherwise it would lead to unpredictible results. In a form method,

before calling an interactive selection method such as Document.Indicate2D, you

must hide all forms, and, after the call to the method, you must show the

forms.

Parameters:

iMessage

A string which instructs the user that he must select a location in

the document window. This string is displayed in the message area located at

the left of the power input area.

oDocumentWindowLocation

An array made of 2 doubles: X, Y - coordinates array of the

location the user specified in the document window.

oOutputState

The state of the indication command once Indicate2D returns. It can

be either “Normal” (the indication has succeeded), “Cancel” (the user wants to

cancel the VB command, which must exit immediately, see the oOutputState

parameter of the

Selection.SelectElement2 method), “Undo” or “Redo”. About the use of

“Undo” and “Redo”, see the example of the Selection.SelectElement2 method.

Example:

The following example suppose a drawing document is currently edited.

It asks the end user to select a

location in the current drawing window, and creates a text (see

DrawingText ) at the specified location:

Set Document = CATIA.ActiveDocument :

Set Selection = Document.Selection :

Set DrawingSheets = Document.Sheets

Set DrawingSheet = DrawingSheets.ActiveSheet : Set DrawingViews = DrawingSheet.Views

Set DrawingView = DrawingViews.ActiveView : Set DrawingTexts = DrawingView.Texts

‘We propose to the user that he specify a location in the drawing

window

Dim DrawingWindowLocation(1)

Status=Document.Indicate2D(“select a location into the drawing

window”,DrawingWindowLocation)

if (Status = “Cancel”) then Exit Sub

Set DrawingText=DrawingTexts.Add(“Hello

world”,DrawingWindowLocation(0),DrawingWindowLocation(1))

Parameters

• i_message (str) –

• io_document_window_location (tuple) –

Returns

str

indicate3_d(i_planar_geometric_object, i_message, io_window_location2_d, io_window_location3_d)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Indicate3D(AnyObject iPlanarGeometricObject,

CATBSTR iMessage,

CATSafeArrayVariant ioWindowLocation2D,

CATSafeArrayVariant ioWindowLocation3D) As CATBSTR

Runs an 3D interactive indication command.

Role: Indicate3D asks to the user to select a location in the document

window. It cannot be used:

When this document is a DrawingDocument

When this document is a PartDocument, and a sketch is being edited (

Sketch.OpenEdition has been called and Sketch.CloseEdition has not been called

yet)

In these cases, Indicate2D must be used.

See also: Selection.IndicateOrSelectElement3D which can, in particular,

enable indication and not selection (positionning the iFilterType parameter to

an empty string), whichs enables to subscribe to mouse move events,

positionning the iTriggeringOnPreSelection to true.

Note:If the scripting language is Visual Basic for Applications or Visual

Basic 6 Development Studio, then, you have to know that during the execution of

an interactive selection method such as this one, no form (dialog box) must be

displayed, otherwise it would lead to unpredictible results. In a form method,

before calling an interactive selection method such as Document.Indicate2D, you

must hide all forms, and, after the call to the method, you must show the

forms.

Parameters:

iPlanarGeometricObject

A planar geometric object.

The following objects are supported:

HybridShapeCircle, HybridShapeCircleExplicit, HybridShapeConic, Sketch,

Circle2D, Ellipse2D, Hyperbola2D, Parabola2D and Spline2D.

iMessage

A string which instructs the user that he must select a location in the

document window. This string is displayed in the message area located at the

left of the power input area.

oWindowLocation2D

An array made of 2 doubles: X, Y - coordinates array of the location

the user specified in the document window, in the input planar object

coordinates system

oWindowLocation3D

An array made of 3 doubles: X, Y, Z - coordinates array of the location

the user specified in the document window

oOutputState

The state of the indication command once Indicate3D returns. It can be

either “Normal” (the indication has succeeded), “Cancel” (the user wants to

cancel the VB command, which must exit immediately, see the oOutputState

parameter of the Selection.SelectElement2 method), “Undo” or “Redo”. About the

use of “Undo” and “Redo”, see the example of the Selection.SelectElement2

method.

Example:

The following example asks the end user to select a location in the

document window, on the Plane.1 plane, and creates a

HybridShapePointOnPlane at the specified location:

Set Document = CATIA.ActiveDocument : Set Part = Document.Part :

Set Selection = Document.Selection

Set HybridShapeFactory = Part.HybridShapeFactory

Set HybridShapePlane = Part.Bodies.Item(“PartBody”).HybridShapes.Item(“Plane.1”)

Set PlaneReference = Part.CreateReferenceFromObject(HybridShapePlane)

‘We propose to the user that he select a location in the

window

ReDim WindowLocation2D(1),WindowLocation3D(2)

Status=Document.Indicate3D(HybridShapePlane,”select a location in the

document window”, _

WindowLocation2D,WindowLocation3D)

if (Status = “Cancel”) then Exit Sub

Set HybridShapePointOnPlane = HybridShapeFactory.AddNewPointOnPlane( _

PlaneReference,WindowLocation2D(0),WindowLocation2D(1))

Part.Bodies.Item(“PartBody”).InsertHybridShape

HybridShapePointOnPlane

Part.InWorkObject = HybridShapePointOnPlane

Part.Update

Parameters

• i_planar_geometric_object (AnyObject) –

• i_message (str) –

• io_window_location2_d (tuple) –

• io_window_location3_d (tuple) –

Returns

str

new_window()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func NewWindow() As Window

Duplicates the window which contains the active document. This implies

creating a window, displaying the active document in this window with the same

view point, making this window the active one, and adding the window to the

collection of windows.

Example:

This example creates the MyWindow new window for the Doc

document.

Dim MyWindow As Window

Set MyWindow = Doc.NewWindow()

Returns

Window

property path¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Path() As CATBSTR (Read Only)

Returns the document’s file path.

Example:

This example retrieves in DocPath the path where the Doc document is

stored.

DocPath = Doc.Path

The returned value is like this:

e:/users/psr/Parts

Returns

str

property read_only¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ReadOnly() As boolean (Read Only)

Returns whether the file containing the document can be read only, on can

be read and written.

True if the file is read-only.

Example:

This example retrieves in IsReadOnly the ability to read, and possibly

to write in, the file containing the Doc document.

IsReadOnly = Doc.ReadOnly

Returns

bool

remove_filter(i_filter_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub RemoveFilter(CATBSTR iFilterName)

Removes an existing visualization filter. Fails if the filter to be removed

is the current filter.

Parameters:

iFilterName

The filter name.

Example:

This example removes the filter named “Filter001” for the Doc

document.

Doc.RemoveFilter (“Filter001”)

Parameters

i_filter_name (str) –

Returns

None

save()¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub Save()

Saves the document.

Example:

This example saves the Doc document.

Doc.Save()

Returns

None

save_as(file_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SaveAs(CATBSTR fileName)

Saves the document with another name.

Parameters:

fileName

The name to assign to the document

Example:

This example saves the Doc document with the NewName

name.

Doc.SaveAs(“NewName”)

Parameters

file_name (str) –

Returns

None

property saved¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Saved() As boolean (Read Only)

Returns whether the document has been modified, and thus needs to be

saved.

This happens when the document has changed since either its creation or its

last save.

True if the document has not been changed: the document doesn’t need to

be saved.

False if the document has been changed: the document needs to be

saved.

Example:

This example retrieves in HasChanged whether the Doc document needs to

be saved.

HasChanged = NOT Doc.Saved

Returns

bool

property see_hidden_elements¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SeeHiddenElements() As boolean

Returns or sets the document’s hidden elements visibility.

True if the document’s hidden elements are visible to the

user.

Example:

This example makes the Doc document’s hidden elements

visible.

Doc.SeeHiddenElements = True

Returns

bool

property selection¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Selection() As Selection (Read Only)

Returns the current selection. The current selection is the object or the

set of objects the end user has selected, usually with the mouse, in the active

document displayed in the active window.

Example:

This example returns in CurSel the current selection in the Doc

document

Dim CurSel As Selection

Set CurSel = Doc.Selection

Returns

Selection

documents¶

class pycatia.in_interfaces.documents.Documents(com_object)¶

The Documents object is used to access multiple open documents in the catia session.

Usage:

>>> from pycatia import catia
>>> documents = catia.documents

.. note::
    CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

        | System.IUnknown
        |     System.IDispatch
        |         System.CATBaseUnknown
        |             System.CATBaseDispatch
        |                 System.Collection
        |                     Documents
        |
        | A collection of all the Document objects currently managed by the
        | application.
        | These documents belong to one of the following types: PartDocument,
        | ProductDocument, and Drawing.
        |
        | See also:
        |     PartDocument, ProductDocument, DrawingDocument

add(document_type)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Add(CATBSTR docType) As Document

Creates a Document object and adds it to the documents collection. This

document becomes the active one, and a window is created to accomodate it which

becomes the active window.

Parameters:

docType

The type of the document to create, chosen among:

Part

For PartDocument

Product

For ProductDocument

Drawing

For Drawing

Returns:

The created document

Example:

The following example creates a PartDocument document in the collection

retrieved in PartDoc.

Dim PartDoc As Document

Set PartDoc = Documents.Add(“Part”)

Parameters

document_type (str) –

Returns

Document

count_types(file_type_list)¶

Returns the number of documents which presents special file extensions like:

‘catpart’, ‘catdrawing’, ‘catproduct’, ‘catmaterial’, ‘catalog’, ‘catfct’

Parameters

(list) file_type_list (str) – filetype(s) to count.

Returns

int()

item(index)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(CATVariant iIndex) As Document

Returns a document using its index or its name from the documents

collection.

Parameters:

iIndex

The index or the name of the document to retrieve frm the

collection of documents. As a numerics, this index is the rank of the document

in the collection. The index of the first document in the collection is 1, and

the index of the last document is Count. As a string, it is the name you

assigned to the document using the

AnyObject.Name property.

Returns:

The retrieved document

Example:

This example retrieves in ThisDoc the fifth document in the collection

and in ThatDoc the document named MyDoc.

Dim ThisDoc As Document

Set ThisDoc = Documents.Item(5)

Dim ThatDoc As Document

Set ThatDoc = Documents.Item(“MyDoc”)

Parameters

index (CATVariant) –

Returns

Document

new_from(file_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func NewFrom(CATBSTR iFileName) As Document

Creates a new document from a document stored in a file. Role: Reads a

document stored in a file and creates a new document containing the resulting

data, adds the new document to the document collection, displays it in a new

window, adds the window to the window collection and activates both the

document and the window.

Parameters:

The

name of the file containing the document.

Returns:

The created document.

Example:

The following example creates a new Doc document from the contents of

the FileToRead file.

FileToRead = “e:userspsrPartsThisIsANicePart.CATPart”

Dim Doc As Document

Set Doc = Documents.NewFrom(FileToRead)

Parameters

file_name (str) –

Returns

Document

num_open()¶

Returns the number of open documents.

Warning

The COM object can return the incorrect number of documents open. After a document is closed CATIA can keep the linked document ABQMaterialPropertiesCatalog.CATfct open.

Returns

int()

open(file_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Open(CATBSTR iFileName) As Document

Opens a document stored in a file. Reads a document stored in a file,

displays it in a new window, adds the document to the documents collection and

the window to the windows collection, and makes both the document and the

window the active ones.

Parameters:

iFileName

The name of the file containing the document

Returns:

The retrieved document

Example:

The following example opens the Doc document contained in the

FileToOpen file.

FileToOpen = “e:userspsrPartsThisIsANicePart.CATPart”

Dim Doc As Document

Set Doc = Documents.Open(FileToOpen)

Parameters

file_name (str) –

Returns

Document

read(file_name)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Read(CATBSTR iFileName) As Document

Reads a document stored in a file. This method has to be used only for

Browse purpose, for instance to retrieve Product properties. Be careful, it

doesn’t open any editor (no visualization, no undo/redo capabilities…) As

soon as you want to modify the V5 document, you have to use the VB Open method

collection. If this solution is not satisfactory because it opens an editor for

every document, you have to move to C++ and use the CAA methods

CATDocumentServices::Open and CATDocumentServices::SaveAs with the same file

name as the initial one.

Parameters:

iFileName

The name of the file containing the document

Returns:

The retrieved document

Example:

The following example reads the Doc document contained in the

FileToOpen file.

FileToOpen = “e:userspsrPartsThisIsANicePart.CATPart”

Dim Doc As Document

Set Doc = Documents.Read(FileToOpen)

Parameters

i_file_name (str) –

Returns

Document

drafting_page_setup¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.drafting_page_setup.DraftingPageSetup(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

InfInterfaces.PageSetup

DraftingPageSetup

Represents the page setup for the drawing documents.

The page setup is the object that stores data which defines how your documents

and images are actually printed on paper. This data includes namely the paper

size, the orientation, the bottom, top, right, and left margins, the zoom

factor, the banner, the printing quality, the choice of the best orientation,

and the choice to fit either the drawing sheet format or the printer

format.

property choose_best_orientation¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ChooseBestOrientation() As boolean

Activates or deactivates the choice of the best

orientation.

Example:

This example requests the best orientation to be chosen for

MySheet.

MySheet.DrawingPageSetUp.ChooseBestOrientation = TRUE

Returns

bool

property fit_to_printer_format¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FitToPrinterFormat() As boolean

Fits the format of the print to the printer format.

Example:

This example turns this calculation on.

MySheet.DrawingPageSetUp.FitToPrinterFormat = TRUE

Returns

bool

property fit_to_sheet_format¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FitToSheetFormat() As boolean

Fits the format of the print to the sheet format.

Example:

This example turns this calculation on.

MySheet.DrawingPageSetUp.FitToSheetFormat = TRUE

Returns

bool

file¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.file.File(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

InfInterfaces.FileComponent

File

Represents the file object.

Role: The file object allows to manipulate files with UNIX and Windows. Use it

instead of the one of Visual Basic to make portable macros. Its gives access to

information about the file and can open a file as a TextStream

object.

open_as_text_stream(i_mode)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func OpenAsTextStream(CATBSTR iMode) As TextStream

Opens the file and retrieves it as a TextSteam object. Paramater iMode can

have the value “ForReading”, “ForWriting” or

“ForAppending”.

Example:

This example opens the file TestFile for reading and retrieves in the

text stream TextStr.

Dim TextStr As CATIATextSteam

Set TextStr = TestFile.OpenAsTextStream(“ForReading”)

Parameters

i_mode (str) –

Returns

TextStream

property size¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Size() As long (Read Only)

Returns the size of the file.

Example:

This example retrieves in FileSize the size of the File

TestFile.

Dim FileSize As Long

FileSize = TestFile.Size

Returns

int

property type¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Type() As CATBSTR (Read Only)

Returns the type of the file. For instance, if the file has a .txt or .doc

extension, its type will be “Text Document”.

Example:

This example retrieves in FileType the type of the File

TestFile.

Dim FileType As String

FileSize = TestFile.Size

Returns

str

file_component¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.file_component.FileComponent(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

FileComponent

Represents the file object.

Role: The file object allows to manipulate files with UNIX and Windows. Use it

instead of the one of Visual Basic to make portable macros. Its gives access to

information about the file and can open a file as a TextStream

object.

property parent_folder¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property ParentFolder() As Folder

Returns or sets the parent folder of the file.

Example:

This example sets the folder ParentFold as parent of the file TestFile.

This moves the file into ParentFold.

TestFile.ParentFolder

Returns

Folder

property path¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Path() As CATBSTR (Read Only)

Returns the full path of the file.

Example:

This example retrieves in FilePath the path of the File

TestFile.

Dim FilePath As String

FilePath = TestFile.Path

Returns

str

file_system¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.file_system.FileSystem(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

FileSystem

Represents the file system object.

Role: The file system object allows you to access and manipulate folders and

files. It can check the existence of, get, create, delete, or copy folders and

files.

See also:

Folder, File

concatenate_paths(i_path_chunk1, i_path_chunk2)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func ConcatenatePaths(CATBSTR iPathChunk1,

CATBSTR iPathChunk2) As CATBSTR

Concatenates two path chunks to make a new path. Either path chunk can be

empty. The resulting path does not have to exist. The method automatically

corrects improper path separators (/ Unix separators used on a Windows platform

are automatically replaced by // and vice versa).

Parameters:

iPathChunk1

The first path chunk (for instance “E://tmp”).

iPathChunk2

The second path chunk (for instance “local/myfile.txt”).

oPath

The resulting path (for instance

“E://tmp//local//myfile.txt”).

Parameters

• i_path_chunk1 (str) –

• i_path_chunk2 (str) –

Returns

str

copy_file(i_path_source, i_path_destination, i_overwrite)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CopyFile(CATBSTR iPathSource,

CATBSTR iPathDestination,

boolean iOverwrite)

Copies a file from one location to another.

Parameters:

iSourcePath

The full path of the source file.

iDestinationPath

The full destination path where the source file is to be copied.

iOverwrite

Boolean value that is True if an existing file with the same name

can be overwritten; False if it is not, and the copy doesn’t take

place.

Example:

This example copies the file C:/Tests/File1 to C:/Tests/File2

from the file system object FileSys, except if a file with the name

C:/Tests/File2 already exists.

FileSys.CopyFile(“C:/Tests/File1”, “C:/Tests/File2”,

False)

Parameters

• i_path_source (str) –

• i_path_destination (str) –

• i_overwrite (bool) –

Returns

None

copy_folder(i_source_path, i_destination_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub CopyFolder(CATBSTR iSourcePath,

CATBSTR iDestinationPath)

Recursively copies a folder from one location to another. Role: The folder

is copied along with its files, and all its subfolders and their own

files.

Parameters:

iSourcePath

The full path of the source folder.

iDestinationPath

The full destination path where the source folder, its files, and

its subfolders are to be copied.

Example:

This example copies the folder “C:/Tests/Fold1” to

“C:/Tests/Fold2” of the file system object

FileSys.

FileSys.CopyFolder(“C:/Tests/Fold1”,

“C:/Tests/Fold2”)

Parameters

• i_source_path (str) –

• i_destination_path (str) –

Returns

None

create_file(i_path, i_overwrite)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CreateFile(CATBSTR iPath,

boolean iOverwrite) As File

Creates a file and returns the associated file object.

Parameters:

iPath

The full path where the file is to be created.

iOverwrite

Boolean value that is True if an existing file with the same name

can be overwritten; False if it is not, and the creation doesn’t take place.

Returns:

The created file

Example:

This example creates the file C:/Tests/File1 and retrieves it in

the file object FileObj from the file system object FileSys, except if a file

with the name C:/Tests/File1 already exists.

Dim FileObj As File

Set FileObj = FileSys.CreateFile(“C:/Tests/File1”, False)

Parameters

• i_path (str) –

• i_overwrite (bool) –

Returns

File

create_folder(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func CreateFolder(CATBSTR iPath) As Folder

Creates a folder and returns the associated folder object.

Parameters:

iPath

The full path where the folder is to be created.

Returns:

The created folder object. If the folder already exists, the method

fails.

Example:

This example creates the folder “C:/Tests/Fold1” and retrieves it

in FoldObj from the FileSystem FileSys.

Dim FoldObj As Folder

Set FoldObj = FileSys.CreateFolder(“C:/Tests/Fold1”)

Parameters

i_path (str) –

Returns

Folder

delete_file(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub DeleteFile(CATBSTR iPath)

Deletes a file.

The method fails if the folder doesn’t exist.

Parameters:

iPath

The full path of the file to delete.

Example:

This example deletes the file “C:/Tests/File” from the file

system object FileSys.

FileSys.DeleteFile(“C:/Tests/File1”)

Parameters

i_path (str) –

Returns

None

delete_folder(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub DeleteFolder(CATBSTR iPath)

Deletes a folder.

The method fails if the folder doesn’t exist.

Parameters:

iPath

The full path of the folder to delete.

Example:

This example deletes the folder “C:/Tests/Fold1” from the

FileSystem FileSys.

FileSys.DeleteFolder(“C:/Tests/Fold1”)

Parameters

i_path (str) –

Returns

None

file_exists(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func FileExists(CATBSTR iPath) As boolean

Returns whether a given file exists.

True if the file exists.

Parameters:

iPath

The full path of the file.

Example:

This example retrieves in Exists whether the file

“C:/Tests/File1” exists in the file system object

FileSys.

Dim Exists As Boolean

Exists = FileSys.FileExists(“C:/Tests/File1”)

Parameters

i_path (str) –

Returns

bool

property file_separator¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property FileSeparator() As CATBSTR (Read Only)

Returns the file separator string. (usually, // on Windows and / on

UNIX)

Parameters:

oTmpDirectory

The file separator string.

Returns

str

folder_exists(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func FolderExists(CATBSTR iPath) As boolean

Returns whether a given folder exists.

True if the folder exists.

Parameters:

iPath

The full path of the folder.

Example:

This example retrieves in Exists whether the folder

“C:/Tests/Fold1” exists in the file system object

FileSys.

Dim Exists As Boolean

Exists=FileSys.FolderExists(“C:/Tests/Fold1”)

Parameters

i_path (str) –

Returns

bool

get_file(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetFile(CATBSTR iPath) As File

Returns a file using its full path.

The method fails if the folder doesn’t exist.

Parameters:

iPath

The full path of the file to retrieve.

Example:

This example retrieves the file C:/Tests in the FileObj from

the file system object FileSys.

Dim FileObj As File

Set FileObj = FileSys.GetFile(“C:/Tests”)

Parameters

i_path (str) –

Returns

File

get_folder(i_path)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetFolder(CATBSTR iPath) As Folder

Returns a folder using its full path.

Parameters:

iPath

The full path of the folder to retrieve.

Returns:

The retrieved folder. If the folder doesn’t exist, the method

fails.

Example:

This example retrieves the C:Tests folder in FoldObj from the file

system object FileSys.

Dim FoldObj As Folder

Set FoldObj = FileSys.GetFolder(“C:/Tests/”)

Parameters

i_path (str) –

Returns

Folder

property path_separator¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property PathSeparator() As CATBSTR (Read Only)

Returns the path separator string. (usually,; on Windows and : on UNIX)

Parameters:

oTmpDirectory

The path separator string.

Returns

str

property temporary_directory¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TemporaryDirectory() As Folder (Read Only)

Returns the temporary system directory. (usually, C://temp on Windows and

/tmp on UNIX)

Parameters:

oTmpDirectory

A folder which corresponds to the temporary system

directory.

Returns

Folder

files¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.files.Files(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Files

A collection of all the file objects in a folder.

It lists all the files contained in the folder. It allows to retrieve File

objects.

item(i_number)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(long iNumber) As File

Returns a file using its index or its name from the file

collection.

Parameters:

iIndex

The index or the name of the file to retrieve from the collection

of files. As a numerics, this index is the rank of the file in the collection.

The index of the first file in the collection is 1, and the index of the last

file is Count. As a string, it is the name you assigned to the file using the

AnyObject.Name property.

Returns:

The retrieved file

Example:

This example retrieves in ThisFile the third file, and it ThatFile the

file named MyFile. in the TestFiles file collection.

Dim ThisFile As File

Set ThisFile = TestFiles.Item(3)

Dim ThatFile As File

Set ThatFile = TestFiles.Item(“MyFile”)

Parameters

i_number (int) –

Returns

File

folder¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.folder.Folder(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

InfInterfaces.FileComponent

Folder

Represents the folder object.

It allows you to manipulate folders and gives access to information about

them.

property files¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Files() As Files (Read Only)

Returns the file collection of the folder.

Example:

This example retrieves in TestFiles the file collection of the folder

TestFolder.

Dim TestFiles As Files

Set TestFiles = TestFolder.Files

Returns

Files

property sub_folders¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property SubFolders() As Folders (Read Only)

Returns the folder collection of the folder.

Example:

This example retrieves in TestSubFolders the folder colection of the

folder TestFolder.

Dim TestSubFolders As CATIAFolders

Set TestSubFolders = TestFolder.SubFolders

Returns

Folders

folders¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.folders.Folders(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.Collection

Folders

The folders object belongs to a folder.

It lists all the folders contained in the folder. It allows to retrieve Folder

objects.

item(i_number)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func Item(long iNumber) As Folder

Returns a folder using its index or its name from the folder

collection.

Parameters:

iIndex

The index or the name of the folder to retrieve from the collection

of folders. As a numerics, this index is the rank of the folder in the

collection. The index of the first folder in the collection is 1, and the index

of the last folder is Count. As a string, it is the name you assigned to the

folder using the

AnyObject.Name property.

Returns:

The retrieved folder

Example:

This example retrieves in ThisFolder the third folder, and it

ThatFolder the folder named MyFolder. in the TestFolders folder

collection.

Dim ThisFolder As Folder

Set ThisFolder = TestFolders.Item(3)

Dim ThatFolder As Folder

Set ThatFolder = TestFolders.Item(“MyFolder”)

Parameters

i_number (int) –

Returns

Folder

general_session_setting_att¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.general_session_setting_att.GeneralSessionSettingAtt(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

GeneralSessionSettingAtt

Setting controller for the General property tab page.

Role: This interface is implemented by a component which represents the

controller of the general settings.

property auto_save¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property AutoSave() As CATGenDataSave

Returns the data save parameter.

Returns

enum cat_gen_data_save

property conferencing¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Conferencing() As CATGenConferencing

Returns the conference driver parameter.

Returns

enum cat_gen_conferencing

property drag_drop¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DragDrop() As boolean

Returns the drag & drop parameter.

Returns

bool

get_auto_save_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetAutoSaveInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the data save

parameter.

Role:Retrieves the state of the data save parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_conferencing_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetConferencingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the conference driver

parameter.

Role:Retrieves the state of the conference driver parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_drag_drop_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDragDropInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the drag & drop

parameter.

Role:Retrieves the state of the drag & drop parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_ref_doc_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetRefDocInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the referenced documents

parameter.

Role:Retrieves the state of the referenced documents parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_ui_style_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetUIStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the user interface style

parameter.

Role:Retrieves the state of the user interface style parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

property ref_doc¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property RefDoc() As boolean

Returns the referenced documents parameter.

Returns

bool

set_auto_save_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetAutoSaveLock(boolean iLocked)

Locks or unlocks the data save parameter.

Role:Locks or unlocks the data save parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_conferencing_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetConferencingLock(boolean iLocked)

Locks or unlocks the conference driver parameter.

Role:Locks or unlocks the conference driver parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_drag_drop_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDragDropLock(boolean iLocked)

Locks or unlocks the drag & drop parameter.

Role:Locks or unlocks the drag & drop parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_ref_doc_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetRefDocLock(boolean iLocked)

Locks or unlocks the referenced documents parameter.

Role:Locks or unlocks the referenced documents parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_ui_style_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetUIStyleLock(boolean iLocked)

Locks or unlocks the user interface style parameter.

Role:Locks or unlocks the user interface style parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

property time_roll¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TimeRoll() As long

Returns the data save parameter (in milliseconds).

Returns

int

property ui_style¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property UIStyle() As CATGenUIStyle

Returns the user interface style parameter.

Returns

enum cat_gen_ui_style

light_source¶

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

class pycatia.in_interfaces.light_source.LightSource(com_object)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown

System.IDispatch

System.CATBaseUnknown

System.CATBaseDispatch

System.AnyObject

System.SettingController

GeneralSessionSettingAtt

Setting controller for the General property tab page.

Role: This interface is implemented by a component which represents the

controller of the general settings.

property auto_save¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property AutoSave() As CATGenDataSave

Returns the data save parameter.

Returns

enum cat_gen_data_save

property conferencing¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property Conferencing() As CATGenConferencing

Returns the conference driver parameter.

Returns

enum cat_gen_conferencing

property drag_drop¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property DragDrop() As boolean

Returns the drag & drop parameter.

Returns

bool

get_auto_save_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetAutoSaveInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the data save

parameter.

Role:Retrieves the state of the data save parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_conferencing_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetConferencingInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the conference driver

parameter.

Role:Retrieves the state of the conference driver parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_drag_drop_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetDragDropInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the drag & drop

parameter.

Role:Retrieves the state of the drag & drop parameter in the current

environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_ref_doc_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetRefDocInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the referenced documents

parameter.

Role:Retrieves the state of the referenced documents parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

get_ui_style_info(io_admin_level, io_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Func GetUIStyleInfo(CATBSTR ioAdminLevel,

CATBSTR ioLocked) As boolean

Retrieves environment informations for the user interface style

parameter.

Role:Retrieves the state of the user interface style parameter in the

current environment.

Parameters:

ioAdminLevel

If the parameter is locked, AdminLevel gives the administration

level that imposes the value of the parameter.

If the parameter is not locked, AdminLevel gives the administration

level that will give the value of the parameter after a reset.

ioLocked

Indicates if the parameter has been locked.

Returns:

Indicates if the parameter has been explicitly modified or remain to

the administrated value.

Parameters

• io_admin_level (str) –

• io_locked (str) –

Returns

bool

property ref_doc¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property RefDoc() As boolean

Returns the referenced documents parameter.

Returns

bool

set_auto_save_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetAutoSaveLock(boolean iLocked)

Locks or unlocks the data save parameter.

Role:Locks or unlocks the data save parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_conferencing_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetConferencingLock(boolean iLocked)

Locks or unlocks the conference driver parameter.

Role:Locks or unlocks the conference driver parameter if it is possible in

the current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_drag_drop_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetDragDropLock(boolean iLocked)

Locks or unlocks the drag & drop parameter.

Role:Locks or unlocks the drag & drop parameter if it is possible in the

current administrative context. In user mode this method will always return

E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_ref_doc_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetRefDocLock(boolean iLocked)

Locks or unlocks the referenced documents parameter.

Role:Locks or unlocks the referenced documents parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

set_ui_style_lock(i_locked)¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))

o Sub SetUIStyleLock(boolean iLocked)

Locks or unlocks the user interface style parameter.

Role:Locks or unlocks the user interface style parameter if it is possible

in the current administrative context. In user mode this method will always

return E_FAIL.

Parameters:

iLocked

the locking operation to be performed Legal

values:

TRUE : to lock the parameter.

FALSE: to unlock the parameter.

Parameters

i_locked (bool) –

Returns

None

property time_roll¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property TimeRoll() As long

Returns the data save parameter (in milliseconds).

Returns

int

property ui_style¶

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

o Property UIStyle() As CATGenUIStyle

Returns the user interface style parameter.

Returns

enum cat_gen_ui_style