All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

CATSchPlatformInterfaces Interface CATISchFrameInfo

System.IUnknown
  |
  +---CATISchFrameInfo
 

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


interface CATISchFrameInfo

Interface to manage Schematic platform drafting frame information.
Role: To get and set frame information.


Method Index


o GetLabelCode(CATUnicodeString&,CATBoolean&)
Get the frame label code.
o GetOriginCornerCode(CATUnicodeString&)
Get the frame origin corner code.
o GetSpacingCode(CATUnicodeString&,CATBoolean&)
Get the frame spacing code.
o SetLabelCode(CATUnicodeString&,CATBoolean&)
Set the frame label code.
o SetOriginCornerCode(CATUnicodeString&)
Set the frame origin corner code.
o SetSpacingCode(CATUnicodeString&,CATBoolean&)
Set the frame spacing code.

Methods


o GetLabelCode
public virtual HRESULT GetLabelCode(CATUnicodeString& oLabel,
const CATBoolean& iBHoriz=TRUE) =0
Get the frame label code.
Parameters:
oLabel
Label code.
iBHoriz
If TRUE, then the labels are for horizontal spacing, else, they are for vertical spacing.
o GetOriginCornerCode
public virtual HRESULT GetOriginCornerCode(CATUnicodeString& oOriginCorner) =0
Get the frame origin corner code.
Parameters:
oOriginCorner
Origin corner code.
o GetSpacingCode
public virtual HRESULT GetSpacingCode(CATUnicodeString& oSpacing,
const CATBoolean& iBHoriz=TRUE) =0
Get the frame spacing code.
Parameters:
oSpacing
Spacing code.
iBHoriz
If TRUE, then the spacing is for horizontal, else, the spacing is for vertical.
o SetLabelCode
public virtual HRESULT SetLabelCode( const CATUnicodeString& iLabel,
const CATBoolean& iBHoriz=TRUE) =0
Set the frame label code.
Parameters:
iLabel
Label code.
iBHoriz
If TRUE, then the labels are for horizontal spacing, else, they are for vertical spacing.
o SetOriginCornerCode
public virtual HRESULT SetOriginCornerCode( const CATUnicodeString& iOriginCorner) =0
Set the frame origin corner code.
Parameters:
iOriginCorner
Origin corner code.
o SetSpacingCode
public virtual HRESULT SetSpacingCode( const CATUnicodeString& iSpacing,
const CATBoolean& iBHoriz=TRUE) =0
Set the frame spacing code.
Parameters:
iSpacing
Spacing code.
iBHoriz
If TRUE, then the spacing is for horizontal, else, the spacing is for vertical.

This object is included in the file: CATISchFrameInfo.h

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