Class TValidationSummary
TValidationSummary class
TValidationSummary displays a summary of validation errors inline on a Web page, in a message box, or both. By default, a validation summary will collect TBaseValidator::getErrorMessage of all failed validators on the page. If ValidationGroup is not empty, only those validators who belong to the group will show their error messages in the summary. The summary can be displayed as a list, as a bulleted list, or as a single paragraph based on the DisplayMode property. The messages shown can be prefixed with HeaderText. The summary can be displayed on the Web page and in a message box by setting the ShowSummary and ShowMessageBox properties, respectively. Note, the latter is only effective when EnableClientScript is true.
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,
|
Constructor Summary |
public |
Constructor.
|
Method Summary |
protected
void
|
|
protected
TClientSideValidationSummaryOptions
|
|
boolean
|
Gets the auto-update for this summary.
|
protected
array
|
Get a list of options for the client-side javascript validation summary.
|
TClientSideValidationSummaryOptions
|
|
TValidationSummaryDisplayStyle
|
|
TValidationSummaryDisplayMode
|
|
boolean
|
|
protected
array
|
Get the list of validation error messages.
|
string
|
|
boolean
|
|
boolean
|
|
boolean
|
|
string
|
|
protected
string
|
Render the validation summary as a bullet list.
|
string
|
Overrides parent implementation by rendering TValidationSummary-specific presentation.
|
protected
void
|
Render the validation summary header text only.
|
protected
void
|
Render the javascript for validation summary.
|
protected
string
|
Render the validation summary as a simple list.
|
protected
string
|
Render the validation summary as a paragraph.
|
void
|
Sets the summary to auto-update on the client-side
|
void
|
|
void
|
|
void
|
|
void
|
Sets the header text to be displayed at the top of the summary
|
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()
|
Constructor Details |
__construct
Constructor.
This method sets the foreground color to red.
|
Method Details |
addAttributesToRender
protected void addAttributesToRender |
(mixed $writer ) |
Input |
mixed | $writer | |
Output |
Exception |
|
createClientScript
|
getAutoUpdate
public boolean getAutoUpdate |
() |
Gets the auto-update for this summary.
Output |
boolean
| automatic client-side summary updates. Defaults to true. |
Exception |
|
getClientScriptOptions
protected array getClientScriptOptions |
() |
Get a list of options for the client-side javascript validation summary.
Output |
array
| list of options for the summary |
Exception |
|
getClientSide
|
getDisplay
|
getDisplayMode
|
getEnableClientScript
public boolean getEnableClientScript |
() |
Output |
boolean
| whether the TValidationSummary component updates itself using client-side script. Defaults to true. |
Exception |
|
getErrorMessages
protected array getErrorMessages |
() |
Get the list of validation error messages.
Output |
array
| list of validator error messages. |
Exception |
|
getHeaderText
public string getHeaderText |
() |
Output |
string
| the header text displayed at the top of the summary |
Exception |
|
getShowAnchor
public boolean getShowAnchor |
() |
Output |
boolean
| whether the validation summary should be anchored. Defaults to false. |
Exception |
|
getShowMessageBox
public boolean getShowMessageBox |
() |
Output |
boolean
| whether the validation summary is displayed in a message box. Defaults to false. |
Exception |
|
getShowSummary
public boolean getShowSummary |
() |
Output |
boolean
| whether the validation summary is displayed inline. Defaults to true. |
Exception |
|
getValidationGroup
public string getValidationGroup |
() |
Output |
string
| the group which this validator belongs to |
Exception |
|
renderBulletList
protected string renderBulletList |
(array $writer , string 1 ) |
Render the validation summary as a bullet list.
Input |
array | $writer | list of messages |
string | 1 | the header text |
Output |
string
| summary bullet list |
Exception |
|
renderContents
public string renderContents |
(mixed $writer ) |
Overrides parent implementation by rendering TValidationSummary-specific presentation.
Input |
mixed | $writer | |
Output |
string
| the rendering result |
Exception |
|
renderHeaderOnly
Render the validation summary header text only.
Input |
THtmlWriter | $writer | the writer used for the rendering purpose |
Output |
Exception |
|
renderJsSummary
protected void renderJsSummary |
(array 0 ) |
Render the javascript for validation summary.
Input |
array | 0 | list of options for validation summary. |
Output |
Exception |
|
renderList
protected string renderList |
(array $writer , string 1 ) |
Render the validation summary as a simple list.
Input |
array | $writer | list of messages |
string | 1 | the header text |
Output |
string
| summary list |
Exception |
|
renderSingleParagraph
protected string renderSingleParagraph |
(array $writer , string 1 ) |
Render the validation summary as a paragraph.
Input |
array | $writer | list of messages |
string | 1 | the header text |
Output |
string
| summary paragraph |
Exception |
|
setAutoUpdate
public void setAutoUpdate |
(boolean $value ) |
Sets the summary to auto-update on the client-side
Input |
boolean | $value | true for automatic summary updates. |
Output |
Exception |
|
setDisplay
|
setDisplayMode
|
setEnableClientScript
public void setEnableClientScript |
(boolean $value ) |
Input |
boolean | $value | whether the TValidationSummary component updates itself using client-side script. |
Output |
Exception |
|
setHeaderText
public void setHeaderText |
(string $value ) |
Sets the header text to be displayed at the top of the summary
Input |
string | $value | the header text |
Output |
Exception |
|
setShowAnchor
public void setShowAnchor |
(boolean $value ) |
Input |
boolean | $value | whether the validation summary should be anchored. |
Output |
Exception |
|
setShowMessageBox
public void setShowMessageBox |
(boolean $value ) |
Input |
boolean | $value | whether the validation summary is displayed in a message box. |
Output |
Exception |
|
setShowSummary
public void setShowSummary |
(boolean $value ) |
Input |
boolean | $value | whether the validation summary is displayed inline. |
Output |
Exception |
|
setValidationGroup
public void setValidationGroup |
(string $value ) |
Input |
string | $value | the group which this validator belongs to |
Output |
Exception |
|
|