Class THiddenField
Direct Known Sub-classes:
THiddenField class
THiddenField displays a hidden input field on a Web page. The value of the input field can be accessed via Value property. If upon postback the value is changed, a OnValueChanged event will be raised.
Constants Inherited From TControl |
AUTOMATIC_ID_PREFIX,
CLIENT_ID_SEPARATOR,
CS_CHILD_INITIALIZED,
CS_CONSTRUCTED,
CS_INITIALIZED,
CS_LOADED,
CS_PRERENDERED,
CS_STATE_LOADED,
ID_FORMAT,
ID_SEPARATOR,
IS_CHILD_CREATED,
IS_CREATING_CHILD,
IS_DISABLE_THEMING,
IS_DISABLE_VIEWSTATE,
IS_ID_SET,
IS_SKIN_APPLIED,
IS_STYLESHEET_APPLIED,
RF_ADAPTER,
RF_AUTO_BINDINGS,
RF_CHILD_STATE,
RF_CONTROLS,
RF_CONTROLSTATE,
RF_DATA_BINDINGS,
RF_EVENTS,
RF_NAMED_CONTROLS,
RF_NAMED_CONTROLS_ID,
RF_NAMED_OBJECTS,
RF_SKIN_ID,
|
Method Summary |
void
|
Sets focus to this control.
|
string
|
Returns the value of the hidden field.
|
boolean
|
Returns a value indicating whether postback has caused the control data change.
|
boolean
|
|
bool
|
Returns true if this control validated successfully.
|
protected
string
|
|
mixed
|
Returns the value to be validated.
|
string
|
|
boolean
|
Loads hidden field data.
|
void
|
This method is invoked when the value of the getValue property changes between posts to the server.
|
void
|
Raises postdata changed event.
|
void
|
Renders the control.
|
void
|
Sets the value of the hidden field.
|
void
|
|
void
|
|
void
|
|
void
|
Sets the value of the THiddenField
|
Methods Inherited From TControl |
TControl::addedControl(), TControl::addParsedObject(), TControl::addToPostDataLoader(), TControl::applyStyleSheetSkin(), TControl::autoBindProperty(), TControl::autoDataBindProperties(), TControl::bindProperty(), TControl::broadcastEvent(), TControl::bubbleEvent(), TControl::clearChildState(), TControl::clearControlState(), TControl::clearNamingContainer(), TControl::clearViewState(), TControl::convertUniqueIdToClientId(), TControl::createChildControls(), TControl::createControlCollection(), TControl::dataBind(), TControl::dataBindChildren(), TControl::dataBindProperties(), TControl::ensureChildControls(), TControl::findControl(), TControl::findControlsByID(), TControl::findControlsByType(), TControl::focus(), TControl::getAdapter(), TControl::getAllowChildControls(), TControl::getAttribute(), TControl::getAttributes(), TControl::getChildControlsCreated(), TControl::getClientID(), TControl::getControls(), TControl::getControlStage(), TControl::getControlState(), TControl::getCustomData(), TControl::getEnabled(), TControl::getEnableTheming(), TControl::getEnableViewState(), TControl::getHasAdapter(), TControl::getHasAttributes(), TControl::getHasChildInitialized(), TControl::getHasControls(), TControl::getHasInitialized(), TControl::getHasLoaded(), TControl::getHasLoadedPostData(), TControl::getHasPreRendered(), TControl::getID(), TControl::getNamingContainer(), TControl::getPage(), TControl::getParent(), TControl::getRegisteredObject(), TControl::getSkinID(), TControl::getSourceTemplateControl(), TControl::getTemplateControl(), TControl::getUniqueID(), TControl::getViewState(), TControl::getVisible(), TControl::hasAttribute(), TControl::initRecursive(), TControl::isDescendentOf(), TControl::isObjectRegistered(), TControl::loadRecursive(), TControl::loadState(), TControl::loadStateRecursive(), TControl::onDataBinding(), TControl::onInit(), TControl::onLoad(), TControl::onPreRender(), TControl::onUnload(), TControl::preRenderRecursive(), TControl::raiseBubbleEvent(), TControl::registerObject(), TControl::removeAttribute(), TControl::removedControl(), TControl::render(), TControl::renderChildren(), TControl::renderControl(), TControl::saveState(), TControl::saveStateRecursive(), TControl::setAdapter(), TControl::setAttribute(), TControl::setChildControlsCreated(), TControl::setControlStage(), TControl::setControlState(), TControl::setCustomData(), TControl::setEnabled(), TControl::setEnableTheming(), TControl::setEnableViewState(), TControl::setID(), TControl::setPage(), TControl::setSkinID(), TControl::setTemplateControl(), TControl::setViewState(), TControl::setVisible(), TControl::trackViewState(), TControl::traverseChildControls(), TControl::unbindProperty(), TControl::unloadRecursive(), TControl::unregisterObject(), TControl::__get()
|
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Method Details |
focus
Sets focus to this control.
This method overrides the parent implementation by forbidding setting focus to this control.
|
getData
Returns the value of the hidden field.
This method is required by IDataRenderer. It is the same as getValue().
Output |
string
| value of the hidden field |
Exception |
|
getDataChanged
public boolean getDataChanged |
() |
Returns a value indicating whether postback has caused the control data change.
This method is required by the IPostBackDataHandler interface.
Output |
boolean
| whether postback has caused the control data change. False if the page is not in postback mode. |
Exception |
|
getEnableTheming
public boolean getEnableTheming |
() |
Output |
boolean
| whether theming is enabled for this control. Defaults to false. |
Exception |
|
getIsValid
public bool getIsValid |
() |
Returns true if this control validated successfully.
Defaults to true.
Output |
bool
| wether this control validated successfully. |
Exception |
|
getTagName
protected string getTagName |
() |
Output |
string
| tag name of the hidden field. |
Exception |
|
getValidationPropertyValue
public mixed getValidationPropertyValue |
() |
Returns the value to be validated.
This methid is required by IValidatable interface.
Output |
mixed
| the value of the property to be validated. |
Exception |
|
getValue
public string getValue |
() |
Output |
string
| the value of the THiddenField |
Exception |
|
loadPostData
public boolean loadPostData |
(string $key , array $values ) |
Loads hidden field data.
This method is primarly used by framework developers.
Input |
string | $key | the key that can be used to retrieve data from the input data collection |
array | $values | the input data collection |
Output |
boolean
| whether the data of the component has been changed |
Exception |
|
onValueChanged
This method is invoked when the value of the getValue property changes between posts to the server.
The method raises 'OnValueChanged' event to fire up the event delegates. If you override this method, be sure to call the parent implementation so that the attached event handlers can be invoked.
Input |
TEventParameter | $param | event parameter to be passed to the event handlers |
Output |
Exception |
|
raisePostDataChangedEvent
public void raisePostDataChangedEvent |
() |
Raises postdata changed event.
This method calls onValueChanged method. This method is primarly used by framework developers.
|
render
Renders the control.
This method overrides the parent implementation by rendering the hidden field input element.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
setData
public void setData |
(string $value ) |
Sets the value of the hidden field.
This method is required by IDataRenderer. It is the same as setValue().
Input |
string | $value | value of the hidden field |
Output |
Exception |
|
setEnableTheming
public void setEnableTheming |
(boolean $value ) |
Input |
boolean | $value | whether theming is enabled for this control. |
Output |
Exception |
throws | TNotSupportedException This method is always thrown when calling this method. |
|
setIsValid
public void setIsValid |
(bool $value ) |
Input |
bool | $value | wether this control is valid. |
Output |
Exception |
|
setSkinID
public void setSkinID |
(string $value ) |
Input |
string | $value | Skin ID |
Output |
Exception |
throws | TNotSupportedException This method is always thrown when calling this method. |
|
setValue
public void setValue |
(string $value ) |
Sets the value of the THiddenField
Input |
string | $value | the value to be set |
Output |
Exception |
|
|