Class TButton
Direct Known Sub-classes:
TButton class
TButton creates a click button on the page. It is mainly used to submit data to a page. TButton raises two server-side events, OnClick and OnCommand, when it is clicked on the client-side. The difference between these two events is that the event OnCommand is bubbled up to the button's ancestor controls. And within the event parameter for OnCommand contains the reference to the CommandName and CommandParameter property values that are set for the button object. This allows you to create multiple TButton components on a Web page and programmatically determine which one is clicked with what parameter. Clicking on button can also trigger form validation, if CausesValidation is true. The validation may be restricted within a certain group of validator controls by setting ValidationGroup property. If validation is successful, the data will be post back to the same page. TButton displays the Text property as the button caption. TButton can be one of three ButtonType: Submit, Button and Reset. By default, it is a Submit button and the form submission uses the browser's default submission capability. If it is Button or Reset, postback may occur if one of the following conditions is met: - an event handler is attached to OnClick event;
- an event handler is attached to OnCommand event;
- the button is in a non-empty validation group.
In addition, clicking on a Reset button will clear up all input fields if the button does not cause a postback.
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 |
protected
void
|
Adds attribute name-value pairs to renderer.
|
protected
boolean
|
|
TButtonType
|
|
boolean
|
|
protected
string
|
Gets the name of the javascript class responsible for performing postback for this control.
|
string
|
|
string
|
|
string
|
Returns the caption of the button.
|
boolean
|
|
boolean
|
|
protected
array
|
Returns postback specifications for the button.
|
protected
string
|
|
string
|
|
string
|
|
protected
boolean
|
|
void
|
This method is invoked when the button is clicked.
|
void
|
This method is invoked when the button is clicked.
|
void
|
Raises the postback event.
|
protected
void
|
Renders the client-script code.
|
void
|
Renders the body content enclosed between the control tag.
|
void
|
|
void
|
|
void
|
|
void
|
|
void
|
Sets the caption of the button.
|
void
|
|
void
|
|
void
|
|
void
|
|
Methods Inherited From TWebControl |
TWebControl::addAttributesToRender(), TWebControl::clearStyle(), TWebControl::copyBaseAttributes(), TWebControl::createStyle(), TWebControl::getAccessKey(), TWebControl::getBackColor(), TWebControl::getBorderColor(), TWebControl::getBorderStyle(), TWebControl::getBorderWidth(), TWebControl::getCssClass(), TWebControl::getDisplay(), TWebControl::getFont(), TWebControl::getForeColor(), TWebControl::getHasStyle(), TWebControl::getHeight(), TWebControl::getStyle(), TWebControl::getTabIndex(), TWebControl::getTagName(), TWebControl::getToolTip(), TWebControl::getWidth(), TWebControl::render(), TWebControl::renderBeginTag(), TWebControl::renderContents(), TWebControl::renderEndTag(), TWebControl::setAccessKey(), TWebControl::setBackColor(), TWebControl::setBorderColor(), TWebControl::setBorderStyle(), TWebControl::setBorderWidth(), TWebControl::setCssClass(), TWebControl::setDisplay(), TWebControl::setForeColor(), TWebControl::setHeight(), TWebControl::setStyle(), TWebControl::setTabIndex(), TWebControl::setToolTip(), TWebControl::setWidth()
|
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 |
addAttributesToRender
protected void addAttributesToRender |
(THtmlWriter $writer ) |
Adds attribute name-value pairs to renderer.
This overrides the parent implementation with additional button specific attributes.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
canCauseValidation
protected boolean canCauseValidation |
() |
Output |
boolean
| whether to perform validation if the button is clicked |
Exception |
|
getButtonType
Output |
TButtonType
| the type of the button. Defaults to TButtonType::Submit. |
Exception |
|
getCausesValidation
public boolean getCausesValidation |
() |
Output |
boolean
| whether postback event trigger by this button will cause input validation, default is true |
Exception |
|
getClientClassName
protected string getClientClassName |
() |
Gets the name of the javascript class responsible for performing postback for this control.
This method overrides the parent implementation.
Output |
string
| the javascript class name |
Exception |
|
getCommandName
public string getCommandName |
() |
Output |
string
| the command name associated with the OnCommand event. |
Exception |
|
getCommandParameter
public string getCommandParameter |
() |
Output |
string
| the parameter associated with the OnCommand event |
Exception |
|
getData
Returns the caption of the button.
This method is required by IDataRenderer. It is the same as getText().
Output |
string
| caption of the button. |
Exception |
|
getEnableClientScript
public boolean getEnableClientScript |
() |
Output |
boolean
| whether to render javascript. |
Exception |
|
getIsDefaultButton
public boolean getIsDefaultButton |
() |
Output |
boolean
| true if this button is registered as a default button for a panel. |
Exception |
|
getPostBackOptions
protected array getPostBackOptions |
() |
Returns postback specifications for the button.
This method is used by framework and control developers.
Output |
array
| parameters about how the button defines its postback behavior. |
Exception |
|
getTagName
protected string getTagName |
() |
Output |
string
| tag name of the button |
Exception |
|
getText
Output |
string
| caption of the button |
Exception |
|
getValidationGroup
public string getValidationGroup |
() |
Output |
string
| the group of validators which the button causes validation upon postback |
Exception |
|
needPostBackScript
protected boolean needPostBackScript |
() |
Output |
boolean
| whether the button needs javascript to do postback |
Exception |
|
onClick
This method is invoked when the button is clicked.
The method raises 'OnClick' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handler can be invoked.
Input |
TEventParameter | $param | event parameter to be passed to the event handlers |
Output |
Exception |
|
onCommand
This method is invoked when the button is clicked.
The method raises 'OnCommand' event to fire up the event handlers. If you override this method, be sure to call the parent implementation so that the event handlers can be invoked.
|
raisePostBackEvent
Raises the postback event.
This method is required by IPostBackEventHandler interface. If CausesValidation is true, it will invoke the page's TPage::validate method first. It will raise OnClick and OnCommand events. This method is mainly used by framework and control developers.
|
renderClientControlScript
protected void renderClientControlScript |
(mixed $writer ) |
Renders the client-script code.
Input |
mixed | $writer | |
Output |
Exception |
|
renderContents
Renders the body content enclosed between the control tag.
This overrides the parent implementation with nothing to be rendered.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
setButtonType
Input |
TButtonType | $value | the type of the button. |
Output |
Exception |
|
setCausesValidation
public void setCausesValidation |
(boolean $value ) |
Input |
boolean | $value | whether postback event trigger by this button will cause input validation |
Output |
Exception |
|
setCommandName
public void setCommandName |
(string $value ) |
Input |
string | $value | the command name associated with the OnCommand event. |
Output |
Exception |
|
setCommandParameter
public void setCommandParameter |
(string $value ) |
Input |
string | $value | the parameter associated with the OnCommand event. |
Output |
Exception |
|
setData
public void setData |
(string $value ) |
Sets the caption of the button.
This method is required by IDataRenderer. It is the same as setText().
Input |
string | $value | caption of the button |
Output |
Exception |
|
setEnableClientScript
public void setEnableClientScript |
(boolean $value ) |
Input |
boolean | $value | whether to render javascript. |
Output |
Exception |
|
setIsDefaultButton
public void setIsDefaultButton |
(boolean $value ) |
Input |
boolean | $value | set by a panel to register this button as the default button for the panel. |
Output |
Exception |
|
setText
public void setText |
(string $value ) |
Input |
string | $value | caption of the button |
Output |
Exception |
|
setValidationGroup
public void setValidationGroup |
(string $value ) |
Input |
string | $value | the group of validators which the button causes validation upon postback |
Output |
Exception |
|
|