Skip to content

font.md

Latest commit

 

History

History
54 lines (38 loc) · 1.76 KB

font.md

File metadata and controls

54 lines (38 loc) · 1.76 KB

Font

Extends Node

The Font node class specifies the font to be used by a Label node, or any other nodes that render text.

Nodes that use fonts include a field that stores a Font node. The font to use is specified by creating a Font node, and setting its uri and size fields.

The uri field can be set to any TrueType/OpenType font file. For example, to specify a font in XML markup:

<Label>
  <Font role = "font" uri = "pkg:/fonts/font.ttf" size = "24" />
</Label>

A default system font can also be specified, such as in the following:

<Label id = "myLabel"
  width = "200"
  height = "200"
  text = "Hello Label"
  font = "font:MediumBoldSystemFont" 
  />

Below is the list of all the possible system font values:

  • SmallestSystemFont
  • SmallestBoldSystemFont
  • SmallSystemFont
  • SmallBoldSystemFont
  • MediumSystemFont
  • MediumBoldSystemFont
  • LargeSystemFont
  • LargeBoldSystemFont

The font can also be specified in BrightScript, for example:

label = CreateObject("roSGNode", "Label")
font  = CreateObject("roSGNode", "Font")
font.uri = "pkg:/fonts/font.ttf"
font.size = 24
label.font = font

Fields

Field Type Default Access Permission Description
uri uri "" READ_WRITE Specifies a TrueType or OpenType font file. Currently only font files included in the application can be specified
size integer 1 READ_WRITE Specifies the size of the font in points
fallbackGlyph string "" READ_WRITE String representation of a Unicode character to display when an unsupported glyph is encountered. For example, "u0020" would render a space for any unrenderable characters