TextItemControl

Interface to a TextItem control.

See Supported controls for a list of controls that support this interface.

Extends

Members

(readonly) element :HTMLElement

The control's HTML element. No assumptions should be made about the element's type (nodeName) or contents.

Type:
  • HTMLElement
Inherited From

(readonly) name :String

The control's authored name.

Type:
  • String
Inherited From

(readonly) nodeName :String

The control's report specification node name.

Type:
  • String
Inherited From

text :String

The control's text content.

Type:
  • String
Examples

Setting a text item's text

oPage.getControlByName( "TextItem1" ).text = "Hello";

Appending to a text item's text

oPage.getControlByName( "TextItem1" ).text += "Text to append";

Methods

getDisplay() → {Boolean}

The display state of the control.

Inherited From
Returns:

true if the control is displayed and false if the control is not displayed.

Type: 
Boolean

getVisible() → {Boolean}

The visibility state of the control.

Inherited From
Returns:

true if the control is visible and false if the control is hidden.

Type: 
Boolean

setBackgroundColor(sColor)

Set the control's background color.

Parameters:
NameTypeDescription
sColorCSSColor

A CSS color.

setColor(sColor)

Set the control's foreground color.

Parameters:
NameTypeDescription
sColorCSSColor

A CSS color.

setDisplay(bDisplay)

Set the display of the control.

WARNING:
If the control is authored to be initially not displayed using the property "Box type" with a value of "None", this is treated like a conditional render so the report output will not contain the control. Use a "Box type" of "None-Block" or "None-Inline" instead.

Parameters:
NameTypeDescription
bDisplayBoolean

Pass true to display and false to not display the control.

Inherited From

setVisible(bVisible)

Set the visibility of the control.

Parameters:
NameTypeDescription
bVisibleBoolean

Pass true to show and false to hide the control.

Inherited From

toggleDisplay()

Toggle the display of the control. See getDisplay and setDisplay for details.

Inherited From

toggleVisibility()

Toggle the visibility of the control. See getVisible and setVisible for details.