Format.Title |
This template takes care of all the details involved in formatting a title block.
Parameters:text - Text to display. id - Id for linking to this title (such as from the table of contents). font - Font size to use. image - Image to show as a bullet. The auto value tries to determine an image based on the current element. |
Format.FigureTitle |
This template takes care of all the details involved in formatting a figure title block.
Parameters: title - Title text. description - Description text. |
Format.OutputTextArea |
Formats parameter information returned from a text area control that can contain HTML tags. If there is no HTML prefix, then line breaks are inserted.
Parameters: value - Value of the textarea to output. |
Format.EnabledStatus |
Shows enabled image if value is True, disabled image shows only when parameter showDisabled is set to True. Parameters: value - Enabled, True/False. showDisabled - Set to True if the disabled image should show when the value is False. The default value is False. |
Format.Chechbox |
Shows a check box image if the value is True, or an empty check box image otherwise.
Parameters: value - Checked, True/False. default - Default value if "", False or some other value besides True exists The default value is False. |
Format.PropertyRow |
Shows a table property row with two columns, one for the name and one for the value.
Parameters: propertyName - The property name. propertyValue - The property value. border - Border used for table. The default value is 0.5pt solid black. disable-output-escaping - Disable output escaping on the output value, used so you can pass escaped FO content. The default value is False. showEmpty - Show empty values. The default value is False. |
Format.ContextRow |
Shows a contextual row with related attribute. Use this inside a table.
Parameters: text - Text to display. level - Level or indent. The default value is 1. href - Href value to link to another portion of the document. image - Image to show as a bullet. The auto value will try to determine an image based on the current element. show-page-ref - Show page reference; True/False. The default value is True. |
Format.ShowBulletImage |
Show a bullet image.
Parameters: image - Image to show as a bullet. The auto value will try to determine an image based on the current element. |
Format.XMLFigure |
This template takes care of all the details involved in formatting a figure that shows XML content.
Parameters: title - Title text. description - Description text. xml - XML data to show in the figure in text. You can also use a "." to get the current node and children simple-format - If True, this shows the XML without text selecting. This can also be preferred if name space attributes need to be included or if the XML is not well-formed. The default value is False. |
match "node()" mode "xml-to-text" |
XML-to-text formatting function.
Parameters: attr-name-color, attr-value-color |
match "@*" mode "xml-to-text" |
XML-to-text formatting function.
Parameters: attr-name-color, attr-value-color |
match "text()" mode "xml-to-text" |
XML-to-text formatting function. |
match "comment()" mode "xml-to-text" |
XML-to-text formatting function.
Parameters: comment-color |
Format.ImageFigure |
This template formats a figure that shows an image for its content.
Parameters: title - Title text. description - Description text. |
Format.PageBreak |
Inserts a page break. |
Format.BasicLink |
Creates a basic link to the given href using the given text. If the href is empty, it only outputs the text value.
Parameters: text - Link text href - Link href |
Format.BasicLinkToReferencedItem |
Creates a basic link to the XSI referenced item. This uses the @guid attribute to build the link. If no @guid is available, only the text label is rendered.
Parameters: xsiHref - XSI value of referenced node. |
Format.Uppercase |
Used to convert a string to uppercase text.
Parameters: value - The value you want to convert to upper-case. |
Format.SmartSpace |
Used to convert a string to smart-spaced text.
Parameters: value - The value you want to smart-space. |
Format.OutputDebugParameters |
Outputs the debug parameters for a section when the attribute DEBUG_PARAMS is enabled. |
Format.Debug |
Outputs the specified text in a debug format when attribute DEBUG is enabled.
Parameters: text - Debug text. |