pycatia.drafting_interfaces.print_area

Module initially auto generated using V5Automation files from CATIA V5 R28 on 2020-06-11 12:40:47.360445

Warning

The notes denoted “CAA V5 Visual Basic Help” are to be used as reference only. They are there as a guide as to how the visual basic / catscript functions work and thus help debugging in pycatia.

class pycatia.drafting_interfaces.print_area.PrintArea(com_object)

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)

System.IUnknown
System.IDispatch
System.CATBaseUnknown
System.CATBaseDispatch
System.AnyObject
PrintArea

Manages print area of drawing sheet.

This interface is obtained from DrawingSheet.PrintArea method.
property activation_state: bool

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property ActivationState(boolean 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.
Return type:

bool

property area_height: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property AreaHeigth(double iHeigth)

Valuates the height of the print area.

Parameters:

in
double iHeigth [in] The height of the print area. The value must be
strictly positive.

Returns:
Un HRESULT

S_OK
E_FAIL
Return type:

float

property area_low_x: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property AreaLowX(double 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
Return type:

float

property area_low_y: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property AreaLowY(double 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
Return type:

float

property area_width: float

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445)
o Property AreaWidth(double 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
Return type:

float

get_area(o_x: float, o_y: float, o_width: float, o_height: float, o_activated: bool) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub GetArea(double oX,
double oY,
double oWidth,
double oHeigth,
boolean 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 height 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.
Return type:

None

set_area(i_x: float, i_y: float, i_width: float, i_height: float) → None

Note

CAA V5 Visual Basic Help (2020-06-11 12:40:47.360445))
o Sub SetArea(double iX,
double iY,
double iWidth,
double 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 height 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.
Parameters:

  • i_x (float) –

  • i_y (float) –

  • i_width (float) –

  • i_height (float) –

Return type:

None