CATDibModelerUseItf Interface CATIDibSheetFormat
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDibSheetFormat
Role: CATIDibSheetFormat is an interface dedicated to access the sheet format, orientation, display mode.
- See also:
-
Method Index
- o
GetFormatsManager()
- Retrieves the object used to manage formats available on the sheet.
- 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(CATIDibFormat*)
- Sets the format associated with this sheet to iFormat.
- o
SetSheetFormat(CATUnicodeString&)
- Sets the format associated to this sheet to the format whose name is iFormatName.
- o
SetSheetOrientation(CATSheetOrientation)
- Sets the sheet orientation to iOrient.
Methods
o GetFormatsManager
| public virtual GetFormatsManager( | ) |
-
Retrieves the object used to manage formats available on the sheet.
- Returns:
- The formats manager
o GetSheetDisplayMode
| public virtual GetSheetDisplayMode( | | oDisplayMode) |
-
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 GetSheetFormat( | const | iIID, |
| | oFormat) |
-
Retrieves the format associated with this sheet.
- See also:
- ,
- 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 GetSheetOrientation( | | oOrient) |
-
Retrieves the sheet orientation.
- Parameters:
-
- CATSheetOrientation
- &oOrient
[out] The orientation of the sheet.
- See also:
-
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o GetSheetSize
| public virtual GetSheetSize( | | oWidth, |
| | oHeight) |
-
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 SetSheetDisplayMode( | | iDisplayMode) |
-
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:
-
o SetSheetFormat
| public virtual SetSheetFormat( | | iFormat) |
-
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:
-
- CATIDibFormat
- *iFormat
[in] The format.
- Returns:
- HRESULT
- S_OK
- Success.
- E_FAIL
- Error.
o SetSheetFormat
| public virtual SetSheetFormat( | const | iFormatName) |
-
Sets the format associated to this sheet to the format 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 Rep.
- 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 Rep. The valuation could not be performed.
- E_FAIL
- Error.
o SetSheetOrientation
| public virtual SetSheetOrientation( | | iOrient) |
-
Sets the sheet orientation to iOrient.
Note: The sheet orientation must be compliant with the sheet format orientations type.
- See also:
-
- Parameters:
-
- CATSheetOrientation
- iOrient
[in] The new orientation of the sheet.
- See also:
-
- 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: CATIDibSheetFormat.h
If needed, your Imakefile.mk should include the module: CATDibModelerUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.