|
Class TCustomValidator
TCustomValidator class
TCustomValidator performs user-defined validation (either server-side or
client-side or both) on an input component.
To create a server-side validation function, provide a handler for the onServerValidate OnServerValidate event that performs the validation. The data
string of the input control to validate can be accessed by TServerValidateEventParameter::getValue Value of the event parameter. The
result of the validation should be stored in the TServerValidateEventParameter::getIsValid IsValid property of the event
parameter.
To create a client-side validation function, add the client-side validation
javascript function to the page template. The function should have the following
signature:
<script type="text/javascript"><!--
function ValidationFunctionName(sender, parameter)
{
}
--></script>
Use the setClientValidationFunction ClientValidationFunction property
to specify the name of the client-side validation script function associated
with the TCustomValidator.
-
TComponent
-
TApplicationComponent
-
TControl
implements
IRenderable,
IBindable
-
TWebControl
implements
IStyleable
-
TLabel
implements
IDataRenderer
-
TBaseValidator
implements
IValidator
-
TCustomValidator
Methods summary
protected
string
|
#
getClientClassName( )
Gets the name of the javascript class responsible for performing validation
for this control. This method overrides the parent implementation.
Gets the name of the javascript class responsible for performing validation
for this control. This method overrides the parent implementation.
Returns
string the javascript class name
|
public
string
|
#
getClientValidationFunction( )
Returns
string the name of the custom client-side script function used for validation.
|
public
|
#
setClientValidationFunction( string $value )
Sets the name of the custom client-side script function used for
validation.
Sets the name of the custom client-side script function used for
validation.
Parameters
- $value
string the script function name
|
public
boolean
|
|
public
boolean
|
#
onServerValidate( string $value )
This method is invoked when the server side validation happens. It will raise
the OnServerValidate event. The method also allows derived classes to
handle the event without attaching a delegate. Note The derived classes
should call parent implementation to ensure the OnServerValidate event is
raised.
This method is invoked when the server side validation happens. It will raise
the OnServerValidate event. The method also allows derived classes to
handle the event without attaching a delegate. Note The derived classes
should call parent implementation to ensure the OnServerValidate event is
raised.
Parameters
- $value
string the value to be validated
Returns
boolean whether the value is valid
|
public
TControl
|
#
getValidationTarget( )
Returns
TControl
control to be validated. Null if no control is found.
Throws
Overrides
|
protected
array
|
#
getClientScriptOptions( )
Returns an array of javascript validator options.
Returns an array of javascript validator options.
Returns
array javascript validator options.
Overrides
|
protected
|
#
registerClientScriptValidator( )
Only register the client-side validator if setClientValidationFunction
ClientValidationFunction is set.
Only register the client-side validator if setClientValidationFunction
ClientValidationFunction is set.
Overrides
|
Methods inherited from TBaseValidator
__construct(),
addAttributesToRender(),
createClientSide(),
getClientSide(),
getControlCssClass(),
getControlToValidate(),
getDisplay(),
getEnableClientScript(),
getErrorMessage(),
getFocusElementID(),
getFocusOnError(),
getIsValid(),
getValidationGroup(),
getValidationValue(),
onInit(),
onPreRender(),
onUnload(),
onValidate(),
onValidationError(),
onValidationSuccess(),
renderClientControlScript(),
renderContents(),
setControlCssClass(),
setControlToValidate(),
setDisplay(),
setEnableClientScript(),
setEnabled(),
setErrorMessage(),
setFocusElementID(),
setFocusOnError(),
setForControl(),
setIsValid(),
setValidationGroup(),
updateControlCssClass(),
validate()
|
Methods inherited from TWebControl
clearStyle(),
copyBaseAttributes(),
createStyle(),
getAccessKey(),
getBackColor(),
getBorderColor(),
getBorderStyle(),
getBorderWidth(),
getCssClass(),
getDecorator(),
getEnsureId(),
getFont(),
getForeColor(),
getHasStyle(),
getHeight(),
getStyle(),
getTabIndex(),
getToolTip(),
getWidth(),
renderBeginTag(),
renderEndTag(),
setAccessKey(),
setBackColor(),
setBorderColor(),
setBorderStyle(),
setBorderWidth(),
setCssClass(),
setEnsureId(),
setForeColor(),
setHeight(),
setStyle(),
setTabIndex(),
setToolTip(),
setWidth()
|
Methods inherited from TControl
__get(),
addParsedObject(),
addToPostDataLoader(),
addedControl(),
applyStyleSheetSkin(),
autoBindProperty(),
autoDataBindProperties(),
bindProperty(),
broadcastEvent(),
bubbleEvent(),
clearChildState(),
clearControlState(),
clearNamingContainer(),
clearViewState(),
convertUniqueIdToClientId(),
createChildControls(),
createControlCollection(),
dataBind(),
dataBindChildren(),
dataBindProperties(),
ensureChildControls(),
findControl(),
findControlsByID(),
findControlsByType(),
focus(),
getAdapter(),
getAllowChildControls(),
getAttribute(),
getAttributes(),
getChildControlsCreated(),
getClientID(),
getControlStage(),
getControlState(),
getControls(),
getCustomData(),
getEnableTheming(),
getEnableViewState(),
getEnabled(),
getHasAdapter(),
getHasAttributes(),
getHasChildInitialized(),
getHasControls(),
getHasInitialized(),
getHasLoaded(),
getHasLoadedPostData(),
getHasPreRendered(),
getID(),
getIsSkinApplied(),
getNamingContainer(),
getPage(),
getParent(),
getRegisteredObject(),
getSkinID(),
getSourceTemplateControl(),
getTemplateControl(),
getUniqueID(),
getViewState(),
getVisible(),
hasAttribute(),
initRecursive(),
isDescendentOf(),
isObjectRegistered(),
loadRecursive(),
loadState(),
loadStateRecursive(),
onDataBinding(),
onLoad(),
preRenderRecursive(),
raiseBubbleEvent(),
registerObject(),
removeAttribute(),
removedControl(),
renderChildren(),
renderControl(),
saveState(),
saveStateRecursive(),
setAdapter(),
setAttribute(),
setChildControlsCreated(),
setControlStage(),
setControlState(),
setCustomData(),
setEnableTheming(),
setEnableViewState(),
setID(),
setPage(),
setSkinID(),
setTemplateControl(),
setViewState(),
setVisible(),
trackViewState(),
traverseChildControls(),
unbindProperty(),
unloadRecursive(),
unregisterObject()
|
Methods inherited from TComponent
__call(),
__destruct(),
__isset(),
__set(),
__sleep(),
__unset(),
__wakeup(),
asa(),
attachBehavior(),
attachBehaviors(),
attachClassBehavior(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
clearBehaviors(),
createdOnTemplate(),
detachBehavior(),
detachBehaviors(),
detachClassBehavior(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
evaluateStatements(),
fxAttachClassBehavior(),
fxDetachClassBehavior(),
getAutoGlobalListen(),
getBehaviorsEnabled(),
getClassHierarchy(),
getEventHandlers(),
getListeningToGlobalEvents(),
getSubProperty(),
hasEvent(),
hasEventHandler(),
hasProperty(),
isa(),
listen(),
raiseEvent(),
setSubProperty(),
unlisten()
|
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
|
|