Page

Valid Parents: Page is the top level.

Valid Children: Logo, Viewport

Description

The Page object's resources allow you to control items such as the background color, the size of the drawing area, the margins, and the orientation. The Gsharp main window and possibly the Print Setup window will change depending on which resources you modify.

Page resource tabs

Page resources

Page Resource Set

Image (XuNbackgroundCGM)
The name of an image file to be used as the background for the page. CGM, TIFF, and PNG formats are supported.

  • Type: string
  • Default: Unset
  • Range: N/A

Color (XuNbackgroundColor)
The color for the page background

  • Type: float
  • Default: 0
  • Range: N/A

Display Mode (XuNdisplayMode)
Controls how the page is scaled to fit the display area canvas. Possible options:

Label Value Description
Relative "relative" The page is scaled down to fit within the canvas while preserving the aspect ratio.
Absolute "absolute" The page is not scaled and may be larger or smaller than the canvas.

This resource is used if XuNformat (Format) is set to anything other than window.

  • Type: string
  • Default: "relative"
  • Range: "relative" ," absolute"

1st Diagonal Point (XuNfirstDiagonalPoint)
The coordinates for a corner of the background.

  • Type: float
  • Default: (0,0)
  • Range:

Format (XuNformat)
Allows you control the format of the page. The horizontal insertion point of the bounding box. Possible options:

Label Value Description
A0 "a0" DIN A0 size 1189 x 841 mm
A1 "a1" DIN A1 size 841 x 594 mm
A2 "a2" DIN A2 size 594 x 420 mm
A3 "a3" DIN A3 size 420 x 297 mm
A4 "a4" DIN A4 size 297 x 210 mm
A5 "a5" DIN A5 size 210 x 148 mm
A(Letter) "a(letter)" ANSI A size 8.5 x 11.0 inches
B(Ledger) "b(ledger)" ANSI B size 11.0 x 17.0 inches
C "c" ANSI C size 17.0 x 22.0 inches
D "d" ANSI D size 22.0 x 34.0 inches
E "e" ANSI E size 34.0 x 44.0 inches
Custom "custom" Size defined by XuNsize (Size)
Éxecutive "executive" Executive size 8.5 x 14.0 inches
Legal "legal" size 7.5 x 10.5 inches
Window "window" The page is mapped to the size of the display window.
  • Type: string
  • Default: "window"
  • Range: "window", " custom", " a0", " a1", "a2", " a3", " a4", " a5", " a(letter)", "b(ledger)", " c", " d", " e", " legal", "executive"

Color (XuNframeColor)
The color for the background frame.

  • Type: float
  • Default: 1
  • Range:

Width (XuNframeWidth)
The width of the frame surrounding the page background.

  • Type: float
  • Default: 0
  • Range: 0:5

Lock to Device (XuNlockToDevice)
When true (On), all page margin­ and size­related resources will always match the output device set by XuNdevice (Device) or in the Print Setup dialog.

  • Type: float
  • Default: false
  • Range: false,true

Bottom (XuNmarginBottom)
Bottom margin size. The default is 5%.

  • Type: float
  • Default: 5
  • Range:

Left (XuNmarginLeft)
Left margin size. The default is 5%.

  • Type: float
  • Default: 5
  • Range:

Right (XuNmarginRight)
Right margin size. The default is 5%.

  • Type: float
  • Default: 5
  • Range:

Top (XuNmarginTop)
Top margin size. The default is 5%.

  • Type: float
  • Default: 5
  • Range:

Orientation (XuNorientation)
The page orientation. Possible options:

Label Value Description
Landscape "landscape" The long edge of the page is horizontal.
Portrait "portrait" The long edge of the page is vertical.

This resource is used if XuNformat (Format) is set to anything other than custom or window.

  • Type: string
  • Default: "landscape"
  • Range: "landscape" ," portrait"

2nd Diagonal Point (XuNsecondDiagonalPoint)
The coordinates for a a background corner diagonally opposed to the 1st point, specified as a percentage of the dimension of the page area.

  • Type: float
  • Default: (100,100)
  • Range:

Visible (XuNshowMargins)
Control the visibility of margins on the display area canvas.

  • Type: float
  • Default: true
  • Range: false,true

Size (XuNsize)
The size of the page when XuNformat (Format) is set to custom.

  • Type: float
  • Default: (Unset
  • Range: Unset)

Inherited Resources

Controls Resource Set

Immutable (XuNimmutable)
This resource controls whether the object can be modified. Values are true (On) for non­modifiable, or false (Off) for modifiable. By default it is set to modifiable. Setting this resource to on locks the currents settings for the object and disables any further changes to the object, including resetting this resource.

  • Type: float
  • Default: true
  • Range: false,true

Object Name (XuNname)
The name of the object. If not explicitly set, a default name with the format <class>_<id> will be generated.

  • Type: string
  • Default: Unset
  • Range: N/A

Include in Saved GSL (XuNsave)
This resource controls whether the object is included in saved GSL. Values are true (On) to include in saved GSL or false (Off) to omit from GSL. By default objects are included in saved GSL.

  • Type: float
  • Default: true
  • Range: false,true

User Data (XuNuserData)
A dataset name or pointer which the user can associate with the object. The dataset is for user use and will not be used by Gsharp.

  • Type: string
  • Default: Unset
  • Range: N/A

Return to Graphic Objects.