pycatia.drafting_interfaces.drawing_threads

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

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.drafting_interfaces.drawing_threads.DrawingThreads(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
DrawingThreads

A collection of all the drawing threads currently managed by a drawing view of
drawing sheet in a drawing document.
add(i_geom_elem) → DrawingThread

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(CATBaseDispatch iGeomElem) As DrawingThread

Creates a drawing thread and adds it to the DrawingThreads
collection.

Parameters:

iGeomElem
Geometry to create the thread on. Be careful, this geometry must be
a 2D geometry

Returns:
The created drawing thread

Example:
The following example creates a drawing thread and retrieved in MyThread in
the drawing view collection of the MyView drawing view. This view belongs to
the drawing view collection of the drawing sheet

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim MyThread As DrawingThread
Set MyThread = MyView.Threads.Add(iGeomElem)
Parameters:

i_geom_elem –

Return type:

DrawingThread

item(i_index: int) → DrawingThread

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Item(long iIndex) As DrawingThread

Returns a drawing thread using its index from the DrawingThreads
collection.

Parameters:

iIndex
The index of the drawing thread to retrieve from the collection of
drawing threads. As a numerics, this index is the rank of the drawing thread in
the collection. The index of the first drawing thread in the collection is 1,
and the index of the last drawing thread is Count.


Returns:
The retrieved drawing thread
Example:
This example retrieves in ThisDrawingThread the second drawing thread,
in the drawing view collection of the active view in the active sheet, in the
active document supposed to be a drawing document.

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim ThisDrawingThread As DrawingThread
Set ThisDrawingThread = MyView.Threads.Item(2)
Parameters:

i_index (int) –

Return type:

DrawingThread

remove(i_index: int) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub Remove(long iIndex)

Removes a drawing thread from the DrawingThreads
collection.

Parameters:

iIndex
The index of the drawing thread to remove from the collection of
drawing threads. As a numerics, this index is the rank of the drawing thread in
the collection. The index of the first drawing thread in the collection is 1,
and the index of the last drawing thread is Count.


Example:
The following example removes the third drawing thread in the drawing
thread collection of the active view of the active document, supposed to be a
drawing document.

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
MyView.DrawingThreads.Remove(3)
Parameters:

i_index (int) –

Return type:

None