The textoption Class

Valid Parents: None

Valid Children: None

Description

An attribute object which defines the default resources for all text placed on the graph.The resources for this object are visible in the TextOption Editor dialog which is available in the Gsharp Professional Edition by selecting Options->Text.

New Resources

textoption Resource Set

Backspace Character (XuNbackspaceChar)
A character to indicate a backspace in a text string. Once set, the character can only be drawn by preceding it with the backslash character (\).

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

Character Spacing (XuNcharSpacing)
This resource regulates the spacing between adjacent characters. Increasing the value increases the space, decreasing the value reduces the space.

  • Type: float
  • Default: 0
  • Range: ­100:100

Font (XuNfont)
Sets the default character font.

  • Type: string
  • Default: "simp"
  • Range:  " simp" ,"carg" ,"cart" ,"cenb" ,"cobo" ,"comp" ,"coub" ,"couo" ,"cour" ,"cyri" ,"dupl" ,"futu" ,"gote" ,"gotg" ,"goti" ,"gree" ,"hebo" ,"helb" ,"helo" ,"helv" ,"ital" ,"matr" ,"psim" ,"scri" ,"simg" ,"sims" ,"smag" ,"smai" ,"smal" ,"swib" ,"swil" ,"swim" ,"tem", "tibi", "tibo", "tiit", "tiro", "trii", "trip", "utbi", "utob", "utoi", "utor", "vsim"

Font Mode (XuNfontMode)
Sets the source of the font. Possible options:

Label Value Description
Best Fit "bestFit" A device hardware font is used if one exists that fits the description of the currently set font resources, otherwise a software font is used.
Software "software" The font specified by XuNfont (Font) is selected from the UNICLD font library.
Hardware "hardware" The font specified by XuNfont (Font) is selected from the device hardware font library.
  • Type: string
  • Default: "bestFit"
  • Range: "bestFit" ," software" ," hardware"

ISO Index Character (XuNisoIndexChar)
A character to precede an ISO 8859­1 character index number in a text string. Once set, the character can only be drawn by preceding it with the backslash character (\).

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

Multiline Layout (XuNmultilineLayout)
Multiline text is created by including the newline character in the text string. This resource sets the justification of subsequent lines of the multiline text. Possible options:

Label Value Description
Right "right" Insertion point is the right edge of the box.
Left "left" Insertion point is the left edge of the box.
Center "center" Insertion point is the center of the box.
Blocked "blocked" The text is expanded with spaces so that it extends to both the left and right edges of the box.
  • Type: string
  • Default: "centerJustified"
  • Range: "centerJustified" ," leftJustified" ,"rightJustified" ," blocked"

Multiline Spacing (XuNmultilineSpacing)
Set the line spacing for multiline text.Increasing the value increases the space, decreasing the value reduces the space.

  • Type: float
  • Default: 0
  • Range: ­100:100

National Language (XuNnationalLanguage)
Sets an alternative national language translation for conversion of 7­bit ASCII characters to internal numeric ISO8859­1 representation.

  • Type: string
  • Default: "american"
  • Range: "american", " british", " danish", "french", " german", " swedish"

Newline Character (XuNnewlineChar)
A character to indicate a newline in a text string. Once set, the character can only be drawn by preceding it with the backslash character (\).

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

Spacing Mode (XuNspacingMode)
Controls the spacing between characters. Possible options:

Label Value Description
Kerned "kerned" The spacing between characters in minimized to produce typeset­like spacing.
Fixed "fixed" The width of each character is the same.
Proportional "proportional" The width of each character is proportional to the character body.
  • Type: string
  • Default: "proportional"
  • Range: "proportional" ," fixed" ," kerned"

Subscript Character (XuNsubscriptChar)
A character to indicate that the following character in a text string should be drawn in subscript style. Once set, the character can only be drawn by preceding it with the backslash character (\).

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

Superscript Character (XuNsuperscriptChar)
A character to indicate that the following character in a text string should be drawn in superscript style. Once set, the character can only be drawn by preceding it with the backslash character (\).

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

UNICLD Index Character (XuNunicldIndexChar)
A character to precede a UNICLD character index number in a text string. Once set, the character can only be drawn by preceding it with the backslash character (\).

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

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