Text Output State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Output SV Type Reference
• Text Input State Variable Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
  • val()
  • fmtVal()
• Instance properties
  • Inherited properties
  • allCaps
  • disableHtml
• Component attributes
  • Inherited attributes
• DOM element

Introduction

Text Output state variables represent text outputs. Each rendered component will display according to the format specified in the state variable.

Constructor

• Type string: 'textOutput', class: TextOutputSv

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{type:'textOutput', ...},
	],
})

Parameters

• info
  An object containing the state variable properties. The info object can contain the following properties, but subclasses of StateVar may have additional properties:
  • StateVar info properties.
  • Model SV type info properties.
  • Output SV type info properties.
  • allCaps (optional)
    If true, output will be converted to all capitals.
  • dflt (optional)
    The default value. Default: ''.
  • disableHtml (optional)
    True if any HTML within the text string is to be ignored. Default: false.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• OutputSv methods

val()

Syntax

val(value)
val()

Gets or sets the value. The value must be a string, a template, or an Error; otherwise an assertion fails. If allCaps is true, a string is converted to upper case.

fmtVal()

Returns the current value.

Note: The component() method returns a TextOutputSvCmp.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• OutputSv properties

allCaps

If true, output will be converted to all capitals.

Value

A Boolean.

disableHtml

True if any HTML within the text string is to be ignored..

Value

A Boolean.

Component attributes

Inherited attributes

• Component attributes

DOM element

• The textOutput Component will render an <span> that contains the contents.
• The <span> content will be synchronized witht he state variable value.
• The <span> element will have a className that contains svIo_textOutput