pycatia.drafting_interfaces.drawing_tables

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_tables.DrawingTables(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
DrawingTables

A collection of all the drawing tables currently managed by a drawing view of
drawing sheet in a drawing document.
add(i_position_x: float, i_position_y: float, i_number_of_row: int, i_number_of_column: int, i_row_height: float, i_column_width: float) → DrawingTable

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(double iPositionX,
double iPositionY,
long iNumberOfRow,
long iNumberOfColumn,
double iRowHeight,
double iColumnWidth) As DrawingTable

Creates a drawing table and adds it to the DrawingTables
collection.

Parameters:

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

iNumberOfRow,iNumberOfColumn
The drawing table number of rows and columns
iRowHeight,iColumnWidth
The row height and the column width

Returns:
The created drawing table

Example:
The following example creates an empty drawing table and retrieves it in
MyTable in the drawing table collection of the active view MyView of the
drawing sheet MySheet.

Dim MyView As DrawingView
Set MyView = MySheet.Views.ActiveView
Dim MyTable As DrawingTable
Set MyTable = MyView.Tables.Add(100., 100., 2, 2, 20., 50.)
Parameters:

  • i_position_x (float) –

  • i_position_y (float) –

  • i_number_of_row (int) –

  • i_number_of_column (int) –

  • i_row_height (float) –

  • i_column_width (float) –

Return type:

DrawingTable

item(i_index: int) → DrawingTable

Note

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

Returns a drawing table using its index from the DrawingTables
collection.

Parameters:

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

Returns:
The retrieved drawing table
Example:
This example retrieves in ThisDrawingTable the second drawing table, 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 ThisDrawingTable As DrawingTable
Set ThisDrawingTable = MyView.Tables.Item(2)
Parameters:

i_index (int) –

Return type:

DrawingTable

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 table from the DrawingTables collection.

Parameters:

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

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

i_index (int) –

Returns:

None