All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

DraftingInterfaces Interface CATIDftSheetFormat

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

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


interface CATIDftSheetFormat

Role: CATIDftSheetFormat is an interface dedicated to access the sheet format, orientation, display mode.

See also:
CATIDftFormat


Method Index


o GetSheetDisplayMode(CATBoolean&)
Retrieves the sheet display mode.
o GetSheetFormat(IID&,IUnknown**)
Retrieves the format associated with this sheet.
o GetSheetOrientation(CATSheetOrientation&)
Retrieves the sheet orientation.
o GetSheetSize(double&,double&)
Retrieves the sheet size according to the current sheet orientation.
o SetSheetDisplayMode(CATBoolean)
Sets the sheet display mode to iDisplayMode.
o SetSheetFormat(CATIDftFormat*)
Sets the format associated with this sheet to iFormat.
o SetSheetFormat(CATUnicodeString&)
Sets the format associated to this sheet to the format in the drawing whose name is iFormatName.
o SetSheetOrientation(CATSheetOrientation)
Sets the sheet orientation to iOrient.

Methods


o GetSheetDisplayMode
public virtual HRESULT GetSheetDisplayMode(CATBoolean& oDisplayMode)= 0
Retrieves the sheet display mode.
Parameters:
CATBoolean
&oDisplayMode [out] The sheet display mode. This parameter is used in order to check whether the sheet format frame should be displayed or not.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o GetSheetFormat
public virtual HRESULT GetSheetFormat( const IID& iIID,
IUnknown** oFormat)= 0
Retrieves the format associated with this sheet.
See also:
CATIDftFormat, CATIDftCustomFormat
Parameters:
const
IID &iIID [in] the IID of the interface by which the format will be retrieved.
IUnknown
**oFormat [out, IUnknown#Release] the interface.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o GetSheetOrientation
public virtual HRESULT GetSheetOrientation(CATSheetOrientation& oOrient)= 0
Retrieves the sheet orientation.
Parameters:
CATSheetOrientation
&oOrient [out] The orientation of the sheet.
See also:
CATSheetOrientation
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o GetSheetSize
public virtual HRESULT GetSheetSize(double& oWidth,
double& oHeight)= 0
Retrieves the sheet size according to the current sheet orientation. Note: The sheet size is based on its format and its orientation.
Parameters:
double
&oWidth [out] The width of the sheet.
double
&oHeight [out] The height of the sheet.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o SetSheetDisplayMode
public virtual HRESULT SetSheetDisplayMode(CATBoolean iDisplayMode)= 0
Sets the sheet display mode to iDisplayMode.
Parameters:
CATBoolean
iDisplayMode [in] The new sheet display mode. This parameter is used in order to check whether the sheet format frame should be displayed or not.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
See also:
CATIDftSheetFormat.GetSheetDisplayMode
o SetSheetFormat
public virtual HRESULT SetSheetFormat(CATIDftFormat* iFormat)= 0
Sets the format associated with this sheet to iFormat. Note: The sheet orientation will be modified (if necessary) to be compliant with the format orientations type. Note: iFormat must be a format in the drawing.
Parameters:
CATIDftFormat
*iFormat [in] The format.
Returns:
HRESULT
S_OK
Success.
E_FAIL
Error.
o SetSheetFormat
public virtual HRESULT SetSheetFormat( const CATUnicodeString& iFormatName)= 0
Sets the format associated to this sheet to the format in the drawing whose name is iFormatName. Note: The sheet orientation will be modified (if necessary) to be compliant with the format orientations type. Note: iFormat must be a format in the drawing.
Parameters:
const
CATUnicodeString &iFormatName [in] The name of the format.
Returns:
HRESULT
S_OK
Success.
E_INVALIDARG
The given format is not available in the drawing. The valuation could not be performed.
E_FAIL
Error.
o SetSheetOrientation
public virtual HRESULT SetSheetOrientation(CATSheetOrientation iOrient)= 0
Sets the sheet orientation to iOrient. Note: The sheet orientation must be compliant with the sheet format orientations type.
See also:
CATIDftFormat
Parameters:
CATSheetOrientation
iOrient [in] The new orientation of the sheet.
See also:
CATSheetOrientation
Returns:
HRESULT
S_OK
Success.
S_FALSE
The requested orientation is not compliant with the sheet format, therefore the sheet is unchanged.
E_FAIL
Error.

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

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