Scriptable Reports

BlockControl

Interface to a Block 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:

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:
Name Type Description
sColor CSSColor A CSS color.

setColor(sColor)

Set the control's foreground color.
Parameters:
Name Type Description
sColor CSSColor 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:
Name Type Description
bDisplay Boolean Pass true to display and false to not display the control.
Inherited From:

setHeight(sCssLength, bTransitionopt)

Set the control's height.
Parameters:
Name Type Attributes Default Description
sCssLength CSSLength A CSS length.
bTransition Boolean <optional>
 false Pass true to perform a transition from the current value to the new value.

setVisible(bVisible)

Set the visibility of the control.
Parameters:
Name Type Description
bVisible Boolean Pass true to show and false to hide the control.
Inherited From:

setWidth(sCssLength, bTransitionopt)

Set the control's width.
Parameters:
Name Type Attributes Default Description
sCssLength CSSLength A CSS length.
bTransition Boolean <optional>
 false Pass true to perform a transition from the current value to the new value.

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.
Inherited From: