All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftFormat

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

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


interface CATIDftFormat

Role: CATIDftFormat is an interface dedicated to get the generic informations carried by a format that are consequently shared among sheets associated with this format.


Method Index


o GetFormatHeight(double&)
Retrieves the height of the format.
o GetFormatName(CATUnicodeString&)
Retrieves the name of the format.
o GetFormatOrientationsType(CATFormatOrientationsType&)
Retrieves the format orientations type.
o GetFormatWidth(double&)
Retrieves the width of the format.

Methods


o GetFormatHeight
public virtual HRESULT GetFormatHeight(double& oHeight)= 0
Retrieves the height of the format. Note: the height of a format is same as the height of a sheet having a landscape orientation and associated with this format.
Parameters:
double
&oHeight [out] The height of the format.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o GetFormatName
public virtual HRESULT GetFormatName(CATUnicodeString& oName)= 0
Retrieves the name of the format.
Parameters:
CATUnicodeString
&oName [out] The name of the format as an unicode string.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o GetFormatOrientationsType
public virtual HRESULT GetFormatOrientationsType(CATFormatOrientationsType& oOrientsType)= 0
Retrieves the format orientations type. Note: To set the orientations type on a custom format, see CATIDftDrawingFormats#SetOrientationsTypeOnCustomFormat
Parameters:
CATFormatOrientationsType
&oOrientsType [out] The orientations type of the format.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
See also:
CATFormatOrientationsType
o GetFormatWidth
public virtual HRESULT GetFormatWidth(double& oWidth)= 0
Retrieves the width of the format. Note: the width of a format is same as the width of a sheet having a landscape orientation and associated with this format.
Parameters:
double
&oWidth [out] The width of the format.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.

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

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