Class CFormStringElement

CFormStringElement represents a string in a form.

CComponent

CFormElement

CFormStringElement

Package: system\web\form
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.1
Located at x2engine/framework/web/form/CFormStringElement.php

Methods summary
`public string`	# `getOn( )` Returns a value indicating under which scenarios this string is visible. If the value is empty, it means the string is visible under all scenarios. Otherwise, only when the model is in the scenario whose name can be found in this value, will the string be visible. See CModel::scenario for more information about model scenarios. Returns a value indicating under which scenarios this string is visible. If the value is empty, it means the string is visible under all scenarios. Otherwise, only when the model is in the scenario whose name can be found in this value, will the string be visible. See CModel::scenario for more information about model scenarios. Returns `string` scenario names separated by commas. Defaults to null.
`public`	# `setOn( string $value )` Parameters `$value` `string` $value scenario names separated by commas.
`public string`	# `render( )` Renders this element. The default implementation simply returns `CFormStringElement::$content`. Renders this element. The default implementation simply returns `CFormStringElement::$content`. Returns `string` the string content
`protected boolean`	# `evaluateVisible( )` Evaluates the visibility of this element. This method will check the on property to see if the model is in a scenario that should have this string displayed. Evaluates the visibility of this element. This method will check the on property to see if the model is in a scenario that should have this string displayed. Returns `boolean` whether this element is visible. Overrides `CFormElement::evaluateVisible()`

Methods inherited from CFormElement
`__construct(), __get(), __isset(), __set(), __toString(), configure(), getParent(), getVisible(), setVisible()`

Methods inherited from CComponent
`__call(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Properties summary
`public string`	`$content`		# the string content the string content

Properties inherited from CFormElement
`$attributes`

Magic properties summary
`public string`	`$on`	# Scenario names separated by commas. Defaults to null. Scenario names separated by commas. Defaults to null.

Magic properties inherited from CFormElement
`$parent, $visible`

Packages

Classes

Class CFormStringElement

Returns

Parameters

Returns

Returns

Overrides