The hardcopy Class

Valid Parents: None

Valid Children: None

Description

An attribute object which defines the hardcopy setup. The resources for this object are visible in the Print Setup dialog which is available in the Gsharp Professional Edition by selecting File/Print Setup.

New Resources

hardcopy Resource Set

Device (XuNdevice)
The device token as specified in the device definition. Refer to define_device.

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

Orientation (XuNorientation)
The orientation of the output.

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

Origin (XuNorigo)
The origin of the graphics page on the device plotting surface.

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

Placement (XuNplacement)
Controls the placement and scaling of the page onto the device plotting surface. Possible options:

Label Value Description
Center "center" The page is centered over the device plotting surface. The page is not scaled to fit.
Full "full" The page is anisotropically scaled to fill the device plotting surface.
Max "max" The page is isotropically scaled to fit the device plotting surface.
User "user" The page is anisotropically scaled to fill a user­defined rectangle on the plotting surface.
  • Type: string
  • Default: "max"
  • Range: "max" ," center" ," full" ," user"

Command: (XuNplotCommand)
A system command for directing hardcopy output to a physical device.

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

( (XuNplotCommandEnabled)
Toggles use of XuNplotCommand (Command:).

  • Type: float
  • Default: 88
  • Range: 2:255

( (XuNplotFileEnabled)
Toggles use of XuNplotFileName (File:).

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

File: (XuNplotFileName)
The name of a file to contain the hardcopy output.

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

Size (XuNsize)
The size of the resulting page on the plotting surface after it has been positioned and scaled.

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

Units (XuNunit)
The unit of the XuNsize (Size (width, height)) resource.

  • Type: string
  • Default: "mm"
  • Range: "mm" ," pct" ," in"

Inherited Resources

Controls Resource Set

Destroyable (XuNdestroyable)
This resource controls whether the object can be destroyed by a destroy or reset command. Values can be true (On) to set the object as destroyable, or false (Off) to set the object as permanent.

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

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

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

Object Name (XuNname)
The name of the object.

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

Object Enabled (XuNobjectEnabled)
This resource enables or disables the legend. This resource can be set to either true (On) to enable the object or false (Off) to disabled it.

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

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

  • 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 Gsharp Reference Manual