All Frameworks  Class Hierarchy  This Framework  Previous  Indexes

DraftingInterfaces Interface CATIView

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

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


interface CATIView

Interface of the drawing view object.
Role: The view is a workspace containing geometries and annotations. The view may also contain the generative drafting results. The view positionning in a sheet is managed using the view make-up object. The generative drafting specifications are available using the CATIGenerSpec interface.

See also:
CATIDftViewMakeUp
See also:
CATIGenerSpec


Method Index


o AddViewName(int)
Sets a smart name to the view based on the NLS resources.
o GetDoc()
Gets the external document pointed by the view.
o GetDressUp()
Gets the view dressup manager.
o GetGenerSpec()
Gets the generative specifications of the view.
o GetListOfDrwCallout()
Returns the callouts represented in the view.
o GetOleSiteList()
Gets the list of OLE sites of the views.
o GetSheet()
Gets the sheet containing the view representation.
o GetSketch()
Gets the sketch interface of the view.
o GetViewType()
Gets the view type.
o IsCurrent()
Used to know if the view is current.
o SetDoc(CATILinkableObject_var)
Sets the external document pointed by the view.
o SetViewType(CATDrwViewType&)
Sets the view type.
o Update(CATIDomain_var)
Updates the view.

Methods


o AddViewName
public virtual void AddViewName( const int iTxtCreate) = 0
Sets a smart name to the view based on the NLS resources. This name is computed using the identificator, the prefix and suffix.
o GetDoc
public virtual CATILinkableObject_var GetDoc()= 0
Gets the external document pointed by the view. This method returns NULL_var if the view is not a generative one.
Warning: This method is not available with 2D Layout for 3D Design.
Returns:
The pointed document.
o GetDressUp
public virtual CATIDrwDressUp_var GetDressUp()= 0
Gets the view dressup manager. The dressup manages annotations, area-fills, ....
Returns:
The dress up manager interface.
o GetGenerSpec
public virtual CATIGenerSpec_var GetGenerSpec()= 0
Gets the generative specifications of the view. If the view is a detail, this method returns NULL_var.
Warning: This method is not available with 2D Layout for 3D Design.
Returns:
The generative specification interface.
o GetListOfDrwCallout
public virtual CATLISTV(CATISpecObject_var) GetListOfDrwCallout()= 0
Returns the callouts represented in the view.
Warning: This method is not available with 2D Layout for 3D Design.
o GetOleSiteList
public virtual CATLISTV(CATISpecObject_var) GetOleSiteList()= 0
Gets the list of OLE sites of the views.
Returns:
the list of OleSite features
o GetSheet
public virtual CATISheet_var GetSheet()= 0
Gets the sheet containing the view representation. The returned sheet is the sheet containing the view make-up of the view.
Returns:
The sheet containing the view.
o GetSketch
public virtual CATISketch_var GetSketch()= 0
Gets the sketch interface of the view. This method is usefull to create geometries in a view.
Returns:
The view sketch interface.
o GetViewType
public virtual CATDrwViewType GetViewType()= 0
Gets the view type.
Returns:
The view type.
See also:
CATDrwViewType
o IsCurrent
public virtual int IsCurrent()= 0
Used to know if the view is current. The current view of the current sheet is the active one.
Returns:
The status
Legal values:
0
The view is not the current one
1
The view is the current one
o SetDoc
public virtual void SetDoc(CATILinkableObject_var iDoc) = 0
Sets the external document pointed by the view. The view becomes a generative one.
Warning: This method is not available with 2D Layout for 3D Design.
Parameters:
iDoc
The external document.
o SetViewType
public virtual void SetViewType( const CATDrwViewType& iType) = 0
Sets the view type. It is not enough to type the view as a section so that a cut is applied. Use the section operators instead.
Warning: This method is not available with 2D Layout for 3D Design.
See also:
CATIGenerSpec
Parameters:
iType
The new view type.
o Update
public virtual int Update(CATIDomain_var iDomain) =0
Updates the view. All view components will be updated (Annotations, Generative result, ...)

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

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