Packages
 Comm
 DB
 Input
 Interface
 Module
 Token
 User

Objects
 bitmapwidget
 databasenode
 dragdata
 textwidget
 tokeninstance
 widget
 widgetcontainer

Elements
 buttoncontrol
 categoryselectioncontrol
 chatentry
 chatwindow
 databasecontrol
 diecontrol
 diefield
 formattedtextcontrol
 formattedtextfield
 genericcontrol
 imagecontrol
 numbercontrol
 numberfield
 portraitselectioncontrol
 script
 scrollercontrol
 stringcontrol
 stringfield
 subwindow
 textbasecontrol
 tokenbag
 tokencontrol
 tokenfield
 windowclass
 windowcontrol
 windowinstance
 windowlist
 windowreferencecontrol
 windowreferencefield

Components
 categoryselectionsettings
 characterdbroot
 customdie
 die
 font
 framedef
 desktopframe
 hotkeybar
 icon
 imageupdatefolder
 importinfo
 includefile
 panel
 portraitset
 template
 tokenroot
 tooltip



Inherits windowcontrol
Context windowinstance

A formattedtextcontrol is a window control that contains formatted text and is not bound to a database node. (See also formattedtextfield)

The formatted text is always displayed in a multi-line format.


Shortcut Keys Supported

  • CTRL+1 - Change paragraph containing cursor into normal text block
  • CTRL+2 - Change paragraph containing cursor into header text block
  • CTRL+3 - Change paragraph containing cursor into chat frame text block
  • CTRL+4 - Change paragraph containing cursor into list block
  • CTRL+5 - Change paragraph containing cursor into link list block
  • CTRL+B - Bold selected text.
  • CTRL+I - Italicize selected text.
  • CTRL+U - Underline selected text.
  • CTRL+A - Select all text
  • CTRL+C - Copy selected text to the clipboard.
  • CTRL+J - Join paragraph containing cursor with the following line.
  • CTRL+V - Paste text on the clipboard into the control.
  • CTRL+X - Copy selected text to the clipboard, and delete the selection.

Internal Representation

Internally, the formattedtextcontrol uses the following XML tags to represent formatting embedded within the text:

  • p - Indicates paragraph using normal formatting.
  • h - Indicates a paragraph using header formatting.
  • frame - Indicates a paragraph using chat frame formatting.
  • frameid - Used within the frame tag, immediately following the frame open tag. Indicates the speaker for chat text.
  • list - Indicates a list.
  • li - Used within the list tag. Supports a numerical indent attribute. Indicates an entry in the list, and contains the text to display for this list item.
  • linklist - Indicates a list of shortcut links. (similar to windowreferencecontrols)
  • link - Used within the linklist tag. Supports a numerical indent attribute. Indicates an entry in the link text, and contains the text to display next to the link.
  • b - Used within p, li or link tags. Indicates that the text within the tags should be bold.
  • i - Used within p, li or link tags. Indicates that the text within the tags should be italicized.
  • u - Used within p, li or link tags. Indicates that the text within the tags should be underlined.
  • table - Indicates a table. Tables can not be created or edited, only accessed via modules created outside of FG.
  • tr - Used within the table tag. Indicates a table row.
  • td - Used within the tr tag. Supports a colspan attribute, similar to HTML formatting. Indicates a table cell, and the text to display within the cell.


Definition

<formattedtextcontrol name="..." >
<font > The names of the fonts to use when displaying the formatted text
<normal > ... </normal> The font to use for normal text.
<bold > ... </bold> The font to use for bolded text.
<italic > ... </italic> The font to use for italicized text.
<bolditalic > ... </bolditalic> The font to use for bolded, italicized text.
<title > ... </title> The font to use for header text.
</font>
<linkicon > The names of the icons to use when displaying links.
<link > ... </link> The icon to use when link data exists.
<emptylink > ... </emptylink> The icon to use when link data does not exist.
</linkicon>
<footer > ... </footer> The name of the icon to display beneath the formatted text.
<selectioncolor > ... </selectioncolor> The color to use for text selection, in the form '#aarrggbb'
<empty > ... </empty> The text to display when the underlying formattedtext value is empty.
</formattedtextcontrol>

'Fantasy Grounds' is a trademark of SmiteWorks Ltd. All other trademarks are the property of their respective owners.
© 2004-2010 SmiteWorks Ltd. ALL RIGHTS RESERVED.
Privacy policy