All Frameworks  Object Hierarchy  This Framework  Indexes

PrintArea (Object)

Manages print area of drawing sheet.

This interface is obtained from DrawingSheet.PrintArea method.

Property Index

ActivationState
Activates or deactivates the print area.
AreaHeigth
Valuates the heigth of the print area.
AreaLowX
Valuates the low x coordinate of the print area.
AreaLowY
Valuates the low y coordinate of the print area.
AreaWidth
Valuates the width of the print area.

Method Index

GetArea
Gets the printing area defined on an object.
SetArea
Sets a set of coordinates to define a rectangle print area.

Properties


o Property ActivationState( iActivated)
Activates or deactivates the print area.
Parameters:
in
boolean iActivated [in] The activation state of the print area (TRUE means activated, FALSE means deactivated).
Returns:
Un HRESULT
S_OK
The activation state could be valuated.
E_FAIL
No activation or deactivation possible.
o Property AreaHeigth( iHeigth)
Valuates the heigth of the print area.
Parameters:
in
double iHeigth [in] The heigth of the print area. The value must be strictly positive.
Returns:
Un HRESULT
S_OK
E_FAIL
o Property AreaLowX( iX)
Valuates the low x coordinate of the print area.
Parameters:
in
double iX [in] The low x coordinate.
Returns:
Un HRESULT
S_OK
E_FAIL
o Property AreaLowY( iY)
Valuates the low y coordinate of the print area.
Parameters:
in
double iY [in] The low y coordinate.
Returns:
Un HRESULT
S_OK
E_FAIL
o Property AreaWidth( iWidth)
Valuates the width of the print area.
Parameters:
in
double iWidth [in] The width of the print area. The value must be strictly positive.
Returns:
Un HRESULT
S_OK
E_FAIL

Methods


o Sub GetArea( oX,
oY,
oWidth,
oHeigth,
oActivated)
Gets the printing area defined on an object. Also communicates the activation state of the printing area.
All the values are given in mm.
Parameters:
out
double oX [out] The low x coordinate of the area.
out
double oY [out] The low y coordinate of the area.
out
double oWidth [out] The width of the area.
out
double oHeigth [out] The heigth of the area.
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 was succesfully retrieved.
E_FAIL
No print area could be retrived.
o Sub SetArea( iX,
iY,
iWidth,
iHeigth)
Sets a set of coordinates to define a rectangle print area.
All the values are given in mm.
Parameters:
in
double iX [in] The low x coordinate of the area.
in
double iY [in] The low y coordinate of the area.
in
double iWidth [in] The width of the area. The value must be strictly positive.
in
double iHeigth [in] The heigth of the area. The value must be strictly positive.
Returns:
Un HRESULT
S_OK
The print area was successfully defined.
E_FAIL
No print area could be defined.

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