pycatia.drafting_interfaces.drawing_texts

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_texts.DrawingTexts(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
DrawingTexts

A collection of all the drawing texts currently managed by a drawing view of
drawing sheet in a drawing document.
add(i_drawing_text: str, i_position_x: float, i_position_y: float) → DrawingText

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(CATBSTR iDrawingText,
double iPositionX,
double iPositionY) As DrawingText

Creates a drawing text and adds it to the DrawingTexts
collection.

Parameters:

iDrawingText
The character string that makes up the drawing text to create

iPositionX,iPositionY
The drawing text x and y coordinates, expressed in millimeters,
with respect to the drawing view coordinate system


Returns:
The created drawing text

Example:
The following example creates a drawing text with the string ComplexText
and retrieved in MyText 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 MyText As DrawingText
Set MyText = MyView.Texts.Add(“ComplexText”, 0., 0.)
Parameters:

  • i_drawing_text (str) –

  • i_position_x (float) –

  • i_position_y (float) –

Return type:

DrawingText

item(i_index: int) → DrawingText

Note

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

Returns a drawing text using its index from the DrawingTexts
collection.

Parameters:

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

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

i_index (int) –

Return type:

DrawingText

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 text from the DrawingTexts collection.

Parameters:

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

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

i_index (int) –

Return type:

None