BPS Script API  2.24.4
bps::Margins Class Reference

A wrapper for BpsMargins. More...

Public Member Functions

 Margins ()
 Default constructor.
 
 Margins (Number aTop, Number aRight, Number aBottom, Number aLeft)
 Initializing constructor. More...
 
 Margins (Number aTopBottom, Number aLeftRight)
 Initializing constructor. More...
 
String toString () const
 

Properties

Number bottom
 The bottom margin. More...
 
Number left
 The left margin. More...
 
Number right
 The right margin. More...
 
Number top
 The top margin. More...
 

Detailed Description

A wrapper for BpsMargins.

Example use within a report:

// set top and bottom margins to 30 mm, left and right to 10 mm
report.margins = new bps.Margins(30,10);
A wrapper for BpsMargins.
Definition: bps.Margins.js:13
The bps extension is a namespace assembling general BPS properties and functions.
Definition: bps.AsyncIO.js:1
The report is a static global object which exists only while processing a BPS report.
Definition: report.Item.js:2

Constructor & Destructor Documentation

◆ Margins() [1/2]

bps::Margins::Margins ( Number  aTopBottom,
Number  aLeftRight 
)

Initializing constructor.

Parameters
aTopBottomThe top and bottom margin.
aLeftRightThe left and right margin.

◆ Margins() [2/2]

bps::Margins::Margins ( Number  aTop,
Number  aRight,
Number  aBottom,
Number  aLeft 
)

Initializing constructor.

Parameters
aTopThe top margin.
aRightThe right margin.
aBottomThe bottom margin.
aLeftThe left margin.

Member Function Documentation

◆ toString()

String bps::Margins::toString ( ) const
Returns
Returns "BpsMargins(top,right,bottom,left)"

Property Documentation

◆ bottom

Number bps::Margins::bottom
readwrite

The bottom margin.

 

◆ left

Number bps::Margins::left
readwrite

The left margin.

 

◆ right

Number bps::Margins::right
readwrite

The right margin.

 

◆ top

Number bps::Margins::top
readwrite

The top margin.

 


The documentation for this class was generated from the following file: