pycatia.drafting_interfaces.drawing_leaders

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_leaders.DrawingLeaders(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
DrawingLeaders

A collection of all the drawing leaders currently managed by a drawing view of
drawing sheet in a drawing document.
add(i_head_point_x: float, i_head_point_y: float) → DrawingLeader

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(double iHeadPointX,
double iHeadPointY) As DrawingLeader

Creates a drawing leader and adds it to the DrawingLeaders
collection.

Parameters:

iHeadPointX,iHeadPointY
The x and y coordinates of head side of drawing leader


Returns:
The created drawing leader

Example:
The following example creates a drawing leader and retrieved in MyLeader in
the drawing text collection of the MyText drawing text. This text belongs to
the drawing text collection of the drawing view

Dim MyTexts As DrawingTexts
Set MyTexts = MySheet.Views.ActiveView
Dim MyText As DrawingText
Set MyText = MyTexts.Item(1)
Dim MyLeader As DrawingLeader
Set MyLeader = MyText.Leaders.Add(20., 50)
Parameters:

  • i_head_point_x (float) –

  • i_head_point_y (float) –

Return type:

DrawingLeader

item(i_index: int) → DrawingLeader

Note

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

Returns a drawing leader using its index from the DrawingLeaders
collection.

Parameters:

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


Returns:
The retrieved drawing view
Example:
This example retrieves in ThisDrawingLeader the second drawing leader,
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 ThisDrawingLeader As DrawingLeader
Set ThisDrawingLeader = MyView.Leaders.Item(2)
Parameters:

i_index (int) –

Return type:

DrawingLeader

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 leader from the DrawingLeaders
collection.

Parameters:

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


Example:
The following example removes the third drawing leader in the drawing
leader 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.DrawingLeaders.Remove(3)
Parameters:

i_index (int) –

Return type:

None