Class: TValidationSummary

Source Location: /Web/UI/WebControls/TValidationSummary.php

Class Overview

TComponent
   |
   --TControl
      |
      --TWebControl
         |
         --TValidationSummary

TValidationSummary class

Class Details

[line 50]
TValidationSummary class

TValidationSummary displays a summary of all validation errors inline on a Web page, in a message box, or both. The summary can be displayed as a list, as a bulleted list, or as a single paragraph based on the DisplayMode property. The summary can be displayed on the Web page and in a message box by setting the ShowSummary and ShowMessageBox properties, respectively.

Namespace: System.Web.UI.WebControls

Properties

DisplayMode, string, default=BulletList, kept in viewstate
Gets or sets the display mode (BulletList, List, SingleParagraph) of the validation summary.
HeaderText, string, kept in viewstate
Gets or sets the header text displayed at the top of the summary.
EnableClientScript, boolean, default=true, kept in viewstate
Gets or sets a value indicating whether the TValidationSummary component updates itself using client-side script.
ShowMessageBox, boolean, default=false, kept in viewstate
Gets or sets a value indicating whether the validation summary is displayed in a message box. If EnableClientScript is false, this property has no effect.
ShowSummary, boolean, default=true, kept in viewstate
Gets or sets a value indicating whether the validation summary is displayed inline.
Group, string, kept in viewstate
Gets or sets the validation group ID.

version:	v1.0, last update on 2004/08/13 21:44:52
author:	Qiang Xue <qiang.xue@gmail.com>

[ Top ]

Methods

Inherited Variables

Class: TComponent

TComponent::$children

Inherited Methods

Class: TWebControl

TWebControl::appendJavascriptEvent(): Append a javascript statement to a particular attribute, e.g. "onclick".
TWebControl::getAccessKey()
TWebControl::getAttributesToRender(): This overrides the parent implementation by rendering more TWebControl-specific attributes.
TWebControl::getBackColor()
TWebControl::getBorderColor()
TWebControl::getBorderStyle()
TWebControl::getBorderWidth()
TWebControl::getCssClass()
TWebControl::getForeColor()
TWebControl::getHeight()
TWebControl::getJavascriptEvents(): Get the list of all the javascript statements.
TWebControl::getStyle()
TWebControl::getTabIndex()
TWebControl::getToolTip()
TWebControl::getWidth()
TWebControl::isEnabled()
TWebControl::parseStyle(): Parses a CSS style string into an array representation.
TWebControl::removeJavascriptEvent(): Remove all or a particular javascript statements.
TWebControl::setAccessKey(): Sets the access key of the control.
TWebControl::setBackColor(): Sets the background color of the control
TWebControl::setBorderColor(): Sets the border color of the control
TWebControl::setBorderStyle(): Sets the border style of the control
TWebControl::setBorderWidth(): Sets the border width of the control
TWebControl::setCssClass(): Sets the CSS class name of the control
TWebControl::setEnabled(): Enables or disables a control.
TWebControl::setForeColor(): Sets the foreground color of the control
TWebControl::setHeight(): Sets the height of the control
TWebControl::setStyle(): Sets the CSS style of the control.
TWebControl::setTabIndex(): Sets the tab index of the control.
TWebControl::setToolTip(): Sets the tooltip of the control.
TWebControl::setWidth(): Sets the width of the control

Class: TControl

TControl::__construct(): Constructor.
TControl::addBody(): Appends an object into the body collection of this control.
TControl::addParsedObject(): Adds the object parsed in template as a body of the component.
TControl::allowBody(): Determines whether the control can add the object as a body.
TControl::clearViewState(): Clears viewstate
TControl::findBodyControl()
TControl::getAttribute()
TControl::getAttributes(): Returns the attribute list object.
TControl::getAttributesToRender(): Returns attributes to be rendered.
TControl::getBodies()
TControl::getClientID(): Returns the client ID of the component.
TControl::getContainer(): Returns the container of this component.
TControl::getSkinName()
TControl::getTagName()
TControl::getViewState(): Returns a viewstate value.
TControl::initSkin(): Initializes a skin for the control. If a skin name is provided then that skin will be loaded.
TControl::isViewStateEnabled()
TControl::isVisible(): This method checks whether a control is visible.
TControl::loadViewState(): Loads viewstate into this component and its children.
TControl::onBubbleEvent(): This method responds to a bubbled event.
TControl::onInit(): This method is invoked when the control enters 'Init' stage.
TControl::onInitRecursive(): Calls onInit of this control and its children recursively.
TControl::onLoad(): This method is invoked when the control enters 'Load' stage.
TControl::onLoadRecursive(): Calls onLoad of this control and its children recursively.
TControl::onPreRender(): This method is invoked when the control enters 'PreRender' stage.
TControl::onPreRenderRecursive(): Calls onPreRender of this control and its children recursively.
TControl::onUnload(): This method is invoked when the control enters 'Unload' stage.
TControl::onUnloadRecursive(): Calls onUnload of this control and its children recursively.
TControl::raiseBubbleEvent(): Invokes the parent's onBubbleEvent method.
TControl::removeBodies(): Removes all body content.
TControl::render(): Renders this control.
TControl::renderAttributes(): Renders the attributes.
TControl::renderBody(): Renders the body content.
TControl::saveViewState(): Returns the viewstate of this component and its children.
TControl::setAttribute(): Sets an attribute.
TControl::setContainer(): Sets the container of this component
TControl::setEnableViewState()
TControl::setSkinName(): Sets the skin to use for this control
TControl::setTagName(): Sets the tag name.
TControl::setViewState(): Sets a viewstate value.
TControl::setVisible()
TControl::synchronizeControl(): This method should only be used by framework developer.

Class: TComponent

TComponent::__construct(): Constructor.
TComponent::addChild(): Adds a child component.
TComponent::addParsedObject(): Handles a component or string met in template.
TComponent::attachEventHandler(): Attaches a handler function to an event.
TComponent::bindProperty(): Sets up the binding between a property and an expression.
TComponent::canGetProperty(): Determines whether a property can be read.
TComponent::canSetProperty(): Determines whether a property can be written.
TComponent::createComponent(): Creates a child component.
TComponent::dataBind(): Performs the databinding for this component.
TComponent::evaluateExpression(): Evaluates a PHP expression.
TComponent::evaluateStatements(): Evaluates a list of PHP statements.
TComponent::findObject(): Finds an object by its ID path.
TComponent::getApplication()
TComponent::getChild()
TComponent::getChildren()
TComponent::getDefinition(): Returns or builds a component definition.
TComponent::getGlobalization(): Returns the Globalization instance for the application.
TComponent::getID()
TComponent::getModule(): Returns the module object that contains the component or the page containing the component.
TComponent::getPage()
TComponent::getParent()
TComponent::getPropertyInitValue(): Gets the initial value of a property.
TComponent::getPropertyType(): Returns the type of a property
TComponent::getRequest(): Returns the request object associated with application.
TComponent::getServiceManager(): Returns the service manager for this application.
TComponent::getSession(): Returns the session object associated with the application.
TComponent::getSessionState(): Returns a session variable.
TComponent::getUniqueID(): Returns the unique ID of the component.
TComponent::getUser(): Returns the user object associated with the application.
TComponent::hasChildren()
TComponent::hasEvent(): Determines whether an event is defined.
TComponent::hasProperty(): Determines whether a property is defined.
TComponent::initProperties(): Initializes the property values.
TComponent::instantiateTemplate(): Parses a template string and instantiates the content.
TComponent::onDataBinding(): This method is invoked when dataBind is invoked for the component.
TComponent::raiseEvent(): Invokes all attached event handler functions for a particular event.
TComponent::removeChild(): Removes a child component.
TComponent::removeChildren(): Removes all child components.
TComponent::setAttribute(): Sets an attribute.
TComponent::setDefinition(): Sets a component definition.
TComponent::setID(): Sets a component ID.
TComponent::setParent(): Sets the parent of this component.
TComponent::setPropertyInitValue(): Sets the initial value of a property.
TComponent::setRoot(): Sets the root component in the component hierarchy.
TComponent::setSessionState(): Sets a session variable.
TComponent::unbindProperty(): Breaks the binding between a property and an expression.
TComponent::__get(): Returns a property value by name or a child component by ID.
TComponent::__set(): Sets value of a component property.

Class Methods

method allowBody [line 57]

boolean allowBody(
mixed
$object)

Overrides parent implementation to disable body addition.

access:

public

Overrides TControl::allowBody() (Determines whether the control can add the object as a body.)

Parameters:

mixed

$object

the object to be added

[ Top ]

method enableClientScript [line 110]

void enableClientScript(
boolean
$value)

Sets the value whether the TValidationSummary component updates itself using client-side script.

access:

public

Parameters:

boolean

$value

whether the TValidationSummary component updates itself using client-side script.

[ Top ]

method escapeJS [line 254]

void escapeJS(
mixed
$string)

Escape javascript strings.

access:

protected

[ Top ]

method getDisplayMode [line 82]

string getDisplayMode(
)

return:	the display mode (BulletList, List, SingleParagraph) of the validation summary.
access:	public

[ Top ]

method getGroup [line 170]

void getGroup(
string
0)

Gets the valiation group.

access:

public

Parameters:

string

validation group ID.

[ Top ]

method getHeaderText [line 65]

string getHeaderText(
)

return:	the header text displayed at the top of the summary
access:	public

[ Top ]

method getJsOptions [line 263]

array getJsOptions(
)

Get a list of options for the client-side javascript validation summary.

return:	list of options for the summary
access:	protected

[ Top ]

method getMessages [line 289]

array getMessages(
)

Get the list of validation error messages.

return:	list of validator error messages.
access:	protected

[ Top ]

method getValidators [line 206]

array getValidators(
)

Get a list of validators considering the validation groups.

return:	list of validators.
access:	protected

[ Top ]

method isAutoUpdate [line 197]

boolean isAutoUpdate(
)

Gets the auto-update for this summary.

return:	automatic client-side summary updates.
access:	public

[ Top ]

method isClientScriptEnabled [line 101]

boolean isClientScriptEnabled(
)

return:	whether the TValidationSummary component updates itself using client-side script.
access:	public

[ Top ]

method isShowAnchor [line 152]

boolean isShowAnchor(
)

return:	whether the validation summary should be anchored.
access:	public

[ Top ]

method isShowMessageBox [line 118]

boolean isShowMessageBox(
)

return:	whether the validation summary is displayed in a message box.
access:	public

[ Top ]

method isShowSummary [line 135]

boolean isShowSummary(
)

return:	whether the validation summary is displayed inline.
access:	public

[ Top ]

method render [line 309]

string render(
)

Overrides parent implementation by rendering TValidationSummary-specific presentation.

return:	the rendering result
access:	public

Overrides TControl::render() (Renders this control.)

[ Top ]

method renderBulletList [line 377]

string renderBulletList(
array
$messages, string
$header)

Render the validation summary as a bullet list.

return:	summary bullet list
access:	protected

Parameters:

array	$messages	list of messages
string	$header	the header text

[ Top ]

method renderJsOptions [line 243]

string renderJsOptions(
array
$options)

Render the array as javascript list.

return:	array as javascript list.
access:	protected

Parameters:

array

$options

list of options.

[ Top ]

method renderJsSummary [line 229]

void renderJsSummary(
array
$options)

Render the javascript for validation summary.

access:

protected

Parameters:

array

$options

list of options for validation summary.

[ Top ]

method renderList [line 347]

string renderList(
array
$messages, string
$header)

Render the validation summary as a simple list.

return:	summary list
access:	protected

Parameters:

array	$messages	list of messages
string	$header	the header text

[ Top ]

method renderSingleParagraph [line 363]

string renderSingleParagraph(
array
$messages, string
$header)

Render the validation summary as a paragraph.

return:	summary paragraph
access:	protected

Parameters:

array	$messages	list of messages
string	$header	the header text

[ Top ]

method setAutoUpdate [line 188]

void setAutoUpdate(
boolean
$value)

Sets the summary to auto-update on the client-side

access:

public

Parameters:

boolean

$value

true for automatic summary updates.

[ Top ]

method setDisplayMode [line 91]

void setDisplayMode(
string
$value)

Sets the display mode (BulletList, List, SingleParagraph) of the validation summary.

access:

public

Parameters:

string

$value

the display mode (BulletList, List, SingleParagraph)

[ Top ]

method setGroup [line 179]

void setGroup(
string
$value)

Sets the validation group.

access:

public

Parameters:

string

$value

ID of the validation group.

[ Top ]

method setHeaderText [line 74]

void setHeaderText(
string
$value)

Sets the header text to be displayed at the top of the summary

access:

public

Parameters:

string

$value

the header text

[ Top ]

method setShowAnchor [line 161]

void setShowAnchor(
boolean
$value)

Sets the value whether the validation summary should be anchored.

access:

public

Parameters:

boolean

$value

whether the validation summary should be anchored.

[ Top ]

method setShowMessageBox [line 127]

void setShowMessageBox(
boolean
$value)

Sets the value whether the validation summary is displayed in a message box.

access:

public

Parameters:

boolean

$value

whether the validation summary is displayed in a message box.

[ Top ]

method setShowSummary [line 144]

void setShowSummary(
boolean
$value)

Sets the value whether the validation summary is displayed inline.

access:

public

Parameters:

boolean

$value

whether the validation summary is displayed inline.

[ Top ]