All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDrwAnnotationComponent

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---DraftingInterfaces.CATIDrwAnnotation
        |
        +---CATIDrwAnnotationComponent
 

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


interface CATIDrwAnnotationComponent

Interfaces to handle global aspects of annotation object.


Method Index


o GetOrientationReference()
Returns the orientation reference of an annotation.
o GetTextBox(CATMathPoint2D&,CATMathPoint2D&,CATMathPoint2D&,CATMathPoint2D&)
Returns characteristic points of the text included in a AnnotationComponent.
o GetTextBoxDisplay(CATDftTextBoxDisplay&)
Used to read the display mode of the annotation value.
o SetOrientationReference(int)
Set the orientation reference of an annotation.
o SetTextBoxDisplay(CATDftTextBoxDisplay)
Used to manage the display mode of the annotation value.

Methods


o GetOrientationReference
public virtual int GetOrientationReference()= 0
Returns the orientation reference of an annotation.
Returns:

0 : Sheet orientation
1 : View orientation
o GetTextBox
public virtual void GetTextBox(CATMathPoint2D& oPt1,
CATMathPoint2D& oPt2,
CATMathPoint2D& oPt3,
CATMathPoint2D& oPt4) = 0
Returns characteristic points of the text included in a AnnotationComponent.
Note :
 oPt3 -------------- oPt4
      !  T e x t   !
 oPt1 -------------- oPt2
 
The points are computed without leaders but the Frame is included
o GetTextBoxDisplay
public virtual HRESULT GetTextBoxDisplay(CATDftTextBoxDisplay& oModeDisplay) = 0
Used to read the display mode of the annotation value.
Parameters:
oModeDisplay
See also:
CATDftTextBoxDisplay
o SetOrientationReference
public virtual void SetOrientationReference(int OrientReference) = 0
Set the orientation reference of an annotation.
Parameters:
OrientReference

0 : Sheet orientation
1 : View orientation
o SetTextBoxDisplay
public virtual HRESULT SetTextBoxDisplay(CATDftTextBoxDisplay iModeDisplay) = 0
Used to manage the display mode of the annotation value.
Parameters:
iModeDisplay
See also:
CATDftTextBoxDisplay

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

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