All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrawing

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIDrawing
 

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATIDrawing

Interface of the drawing object.
Role: The drawing is the root feature of a CATDrawing Document. It manages the sheets.


Method Index


o AppendSheet(CATISheet_var&,DfsSheetType,DfsSheetParam)
Add a sheet into the drawing.
o GetCurrentSheet()
Gets the current sheet.
o GetSheetList()
Returns the sheets referenced by the drawing.
o RemoveSheet(CATISheet_var)
This method is used to remove a sheet from the drawing.
o ReorderSheets(CATLISTV(CATISpecObject_var)&)
Change the positions of the sheets in a drawing according to the given ordered list.
o SetCurrentSheet(CATISheet_var)
Sets a sheet as the current sheet.
o ValidateSheetOrder(CATLISTV(CATISpecObject_var)&)
Validates that the given ordered list can be used as an input for ReorderSheet.

Enumerated Type Index


o DfsSheetParam
o DfsSheetType

Methods


o AppendSheet
public virtual HRESULT AppendSheet( const CATISheet_var& iSheet,
DfsSheetType iType=Design,
DfsSheetParam iParam=NoCurrent) = 0
Add a sheet into the drawing. It will be placed at the end of the tab index that corresponds to its type (Design or Detail)
Parameters:
const
CATISheet_var & iSheet [in] The sheet to add
CATDfsSheetType
iType=Design [in] Tells the type of the sheet : Design sheet or Detail Sheet
CATDfsSheetParam
iParam=NoCurrent [in] Tells whether or not the sheet must be current after having been added
Returns:
A HRESULT
S_OK
Sheet was successfully added into drawing.
S_FALSE
Sheet was already in drawing, so nothing was executed.
E_FAIL
Any internal error, method failed.
o GetCurrentSheet
public virtual CATISheet_var GetCurrentSheet()const = 0
Gets the current sheet. The current sheet is the sheet containing the view in edition.
Returns:
The current sheet.
o GetSheetList
public virtual CATLISTV(CATISpecObject_var) GetSheetList()const = 0
Returns the sheets referenced by the drawing.
Returns:
The drawing sheet list.
o RemoveSheet
public virtual void RemoveSheet(CATISheet_var iSheet) = 0
This method is used to remove a sheet from the drawing.
Parameters:
iSheet
The sheet to be removed
o ReorderSheets
public virtual HRESULT ReorderSheets( const CATLISTV(CATISpecObject_var)& iOrderedSheets)=0
Change the positions of the sheets in a drawing according to the given ordered list.
Parameters:
const
CATLISTV(CATISpecObject_var) &iOrderedSheets [in] The ordered list of the sheets in this drawing. Preconditions:
ValidateSheetOrder(iOrderedSheets) must succeed. @see ValidateSheetOrder.
Returns:
A HRESULT
S_OK
Sheets were reordered.
E_UNEXPECTED
Preconditions not met.
E_FAIL
Internal error.
o SetCurrentSheet
public virtual void SetCurrentSheet(CATISheet_var iSheet) = 0
Sets a sheet as the current sheet. The sheet have to be added to the drawing before calling this method. The current view of this sheet will become the view in edition..
Parameters:
iSheet
The sheet to be current.
o ValidateSheetOrder
public virtual HRESULT ValidateSheetOrder( const CATLISTV(CATISpecObject_var)& iOrderedSheets)=0
Validates that the given ordered list can be used as an input for ReorderSheet. i.e. validates that: iOrderedSheets is the result of a permutation applied to the list of all the sheets of this drawing, with the following constraint: for every non-detail sheet, there isnt any detail sheet appearing before in iOrderedSheets.
Parameters:
iOrderedSheets
The list of sheets to validate.
Returns:
An HRESULT value.
Legal values:
S_OK
iOrderedSheets is a valid input.
E_XXX
iOrderedSheet is not a valid input.

Enumerated Types


o DfsSheetParam
enum DfsSheetParam {
  Current,
  NoCurrent
}
o DfsSheetType
enum DfsSheetType {
  Design,
  Detail
}

This object is included in the file: CATIDrawing.h
If needed, your Imakefile.mk should include the module: CATDraftingInterfaces

Copyright © 2003, Dassault Systèmes. All rights reserved.