DraftingUseItf Interface CATIDft2DPrintArea
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface CATIDft2DPrintArea
Interface used to manage a print area.
Interface designed to:
define a rectangle print area.
(de)activate the print area.
Method Index
- o
GetActivationState(boolean&)
- Returns the activation state of the print area.
- o
GetArea(double*)
- Gets the printing area defined on an object.
Methods
o GetActivationState
| public virtual GetActivationState( | | oActivated) |
-
Returns the activation state of the print area.
- Parameters:
-
- out
- boolean oActivated
[out] The activation state of the print area (TRUE means activated, FALSE means deactivated).
- Returns:
- Un HRESULT
- S_OK
- The print area activation state was succesfully retrieved.
- E_FAIL
- No activation state available.
o GetArea
| public virtual GetArea( | | oAreaData) |
-
Gets the printing area defined on an object. Fills a table allocated by the caller.
Also communicates the activation state of the printing area.
- Parameters:
-
- double
- * oAreaData
[out] A four double table describing the parameter of the area box:
- oAreaData[0] as the low x coordinate of the area.
- oAreaData[1] as the low y coordinate of the area.
- oAreaData[2] as the width of the area.
- oAreaData[3] as the heigth of the area.
- All the values in the table are given in mm.
- All the values in the table are given in mm.
- Returns:
- Un HRESULT
- S_OK
- A print area is defined on the sheet and it is currently activated. The data were successfully retrieved.
- S_FALSE
- A print area is defined on the sheet and it is currently de-activated. The data were successfully retrieved.
- E_FAIL
- No print area is defined on this sheet.
This object is included in the file: CATIDft2DPrintArea.h
If needed, your Imakefile.mk should include the module: CATDraftingUseItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.