Class TClientSideValidationSummaryOptions

TComponent
   |
   --TClientSideOptions
      |
      --TClientSideValidationSummaryOptions

TClientSideValidationSummaryOptions class.

Client-side validation summary events such as OnHideSummary and OnShowSummary can be modified through the TBaseValidator:: property of a validation summary.

The <tt>OnHideSummary</tt> event is raise when the validation summary requests to hide the messages.

The <tt>OnShowSummary</tt> event is raised when the validation summary requests to show the messages.

See the quickstart documentation for further details.

Method Summary
protected string	ensureFunction ( string $javascript) Ensure the string is a valid javascript function. If the string begins with "javascript:" valid javascript function is assumed, otherwise the code block is enclosed with "function(summary, validators){ }" block.
string	getOnHideSummary ()
string	getOnShowSummary ()
void	setOnHideSummary ( string $javascript) Client-side OnHideSummary validation summary event is raise when all the validators are valid. This will override the default client-side validation summary behaviour.
void	setOnShowSummary ( string $javascript) Client-side OnShowSummary event is raise when one or more validators are not valid. This will override the default client-side validation summary behaviour.

Methods Inherited From TClientSideOptions
TClientSideOptions::ensureFunction(), TClientSideOptions::getOption(), TClientSideOptions::getOptions(), TClientSideOptions::setFunction(), TClientSideOptions::setOption()

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

ensureFunction

protected string ensureFunction

(string $javascript )

Ensure the string is a valid javascript function. If the string begins with "javascript:" valid javascript function is assumed, otherwise the code block is enclosed with "function(summary, validators){ }" block.

Input
string	$javascript	javascript code.
Output
string	javascript function code.
Exception

getOnHideSummary

public string getOnHideSummary

()

Output
string	javascript code for client-side OnHideSummary event.
Exception

getOnShowSummary

public string getOnShowSummary

()

Output
string	javascript code for client-side OnShowSummary event.
Exception

setOnHideSummary

public void setOnHideSummary

(string $javascript )

Client-side OnHideSummary validation summary event is raise when all the validators are valid. This will override the default client-side validation summary behaviour.

Input
string	$javascript	javascript code for client-side OnHideSummary event.
Output
Exception

setOnShowSummary

public void setOnShowSummary

(string $javascript )

Client-side OnShowSummary event is raise when one or more validators are not valid. This will override the default client-side validation summary behaviour.

Input
string	$javascript	javascript code for client-side OnShowSummary event.
Output
Exception