YiiBooster - API
\

\TbFormButtonElement

For available attributes and values read {@link TbButton} documentation.

Summary

Methods
Properties
Constants
getOn()
setOn()
render()
$name
No constants found
evaluateVisible()
No protected properties found
N/A
No private methods found
$_on
N/A

Properties

$name

$name : string

Name of this button.

Type

string

$_on

$_on

Methods

getOn()

getOn() : string

Returns a value indicating under which scenarios this button is visible.

If the value is empty, it means the button is visible under all scenarios. Otherwise, only when the model is in the scenario whose name can be found in this value, will the button be visible. See {@link CModel::scenario} for more information about model scenarios.

Returns

string —

scenario names separated by commas. Defaults to null.

setOn()

setOn(string $value)

Parameters

string $value

scenario names separated by commas.

render()

render() : string

Returns

string —

The rendered button.

evaluateVisible()

evaluateVisible() : boolean

Evaluates the visibility of this element.

This method will check the {@link on} property to see if the model is in a scenario that should have this string displayed.

Returns

boolean —

whether this element is visible.