pycatia.drafting_interfaces.drawing_sheets

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_sheets.DrawingSheets(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
DrawingSheets

A collection of all the drawing sheets currently managed by the drawing
document.

Warning: This interface is not available with 2D Layout for 3D
Design.
property active_sheet: DrawingSheet

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ActiveSheet() As DrawingSheet (Read Only)

Returns the active drawing sheet of the drawing document.
Warning: This method is not available with 2D Layout for 3D
Design.

Example:
The following example retrieves in SheetToWorkIn the active drawing
sheet of the drawing document named CATDrawing1.

Dim MyDrawingDoc As Document
Set MyDrawingDoc = CATIA.Documents.Item(“CATDrawing1”)
Dim SheetToWorkIn As DrawingSheet
Set SheetToWorkIn = MyDrawingDoc.Sheets.ActiveSheet
Return type:

DrawingSheet

add(i_drawing_sheet_name: str) → DrawingSheet

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func Add(CATBSTR iDrawingSheetName) As DrawingSheet

Creates a drawing sheet and adds it to the DrawingSheets collection. This
drawing sheet becomes the active one.
Warning: This method is not available with 2D Layout for 3D
Design.

Parameters:

iDrawingSheetName
The name to assign to the created DrawingSheet object


Returns:
The created drawing sheet
Example:
The following example creates a drawing sheet named FirstSheet and
retrieved in MySheet in the drawing sheet collection of the document named
CATDrawing1.

Dim MyDrawingDoc As Document
Set MyDrawingDoc = CATIA.Documents.Item(“CATDrawing1”)
Dim MySheet As DrawingSheet
Set MySheet = MyDrawingDoc.Sheets.Add(“FirstSheet”)
Parameters:

i_drawing_sheet_name (str) –

Return type:

DrawingSheet

add_detail(i_drawing_sheet_name: str) → DrawingSheet

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Func AddDetail(CATBSTR iDrawingSheetName) As DrawingSheet

Creates a detail drawing sheet and adds it to the DrawingSheets collection.
This detail drawing sheet becomes the active one.
Warning: This method is not available with 2D Layout for 3D
Design.

Parameters:

iDrawingSheetName
The name to assign to the created detail DrawingSheet object


Returns:
The created drawing sheet
Example:
The following example creates a detail drawing sheet named FirstSheet
and retrieved in MySheet in the drawing sheet collection of the document named
CATDrawing1.

Dim MyDrawingDoc As Document
Set MyDrawingDoc = CATIA.Documents.Item(“CATDrawing1”)
Dim MySheet As DrawingSheet
Set MySheet = MyDrawingDoc.Sheets.Add(“FirstSheet”)
Parameters:

i_drawing_sheet_name (str) –

Return type:

DrawingSheet

item(i_index: cat_variant) → DrawingSheet

Note

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

Returns a drawing sheet using its index or its name from the DrawingSheets
collection.
Warning: This method is not available with 2D Layout for 3D
Design.

Parameters:

iIndex
The index or the name of the drawing sheet to retrieve from the
collection of drawing sheets. As a numerics, this index is the rank of the
drawing sheet in the collection. The index of the first drawing sheet in the
collection is 1, and the index of the last drawing sheet is Count. As a string,
it is the name you assigned to the drawing sheet using the


AnyObject.Name property or when creating it using the Add method.

Returns:
The retrieved drawing sheet
Example:
This example retrieves in ThisDrawingSheet the third drawing sheet, and
in ThatDrawingSheet the drawing sheet named MySheet in the drawing sheet
collection of the active document, supposed to be a drawing
document.

Dim ThisDrawingSheet As DrawingSheet
Set ThisDrawingSheet = CATIA.ActiveDocument.Sheets.Item(3)
Dim ThatDrawingSheet As DrawingSheet
Set ThatDrawingSheet = CATIA.ActiveDocument.Sheets.Item(“MySheet”)
Parameters:

i_index (cat_variant) –

Return type:

DrawingSheet

remove(i_index: cat_variant) → None

Note

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

Removes a drawing sheet from the DrawingSheets collection.
Warning: This method is not available with 2D Layout for 3D
Design.

Parameters:

iIndex
The index or the name of the drawing sheet to remove from the
collection of drawing sheets. As a numerics, this index is the rank of the
drawing sheet in the collection. The index of the first drawing sheet in the
collection is 1, and the index of the last drawing sheet is Count. As a string,
it is the name you assigned to the drawing sheet using the


AnyObject.Name property or when creating it using the Add method.

Example:
The following example removes the second drawing sheet and the drawing
sheet named SheetToBeRemoved in the drawing sheet collection of the active
document, supposed to be a drawing document.

CATIA.ActiveDocument.DrawingSheets.Remove(2)
CATIA.ActiveDocument.DrawingSheets.Remove(“SheetToBeRemoved”)
Parameters:

i_index (cat_variant) –

Returns:

None