DynamicPopulateExtender (demo)

DynamicPopulate is an extender that replaces the control content with the result of the Web service or a page method call.

Properties

Name	Description
CacheDynamicResults	Determines if the dynamic population result should be cached and not fetched again after the first load. The default is false
ClearContentsDuringUpdate	Determines if HTML content of a target element should be cleared when the update begins.
ContextKey	A key that you can pass to the Web service call, such as an ID. This is optional.
CustomScript	CustomScript can be used to evaluate a JavaScript function that will return a string to populate the control. This script method must return a string and will be called instead of the Service or Page method.
PopulateTriggerControlID	A control's ID to trigger the target population. The population will be triggered by this control's Click event.
ServiceMethod	A name of a Web service or page method to call
ServicePath	A path of the web service to call. If it is blank, a page method will be called instead.
UpdatingCssClass	A CSS style to apply while the update is in progress

Client properties

Name	Description
cacheDynamicResults	A Boolean value that specifies whether or not the results of the target element population should be cached and not fetched again after the first load.
clearContentsDuringUpdate	A Boolean value that specifies whether or the target content should be cleared when the update begins.
contextKey	A string to pass to the Web method.
customScript	The script to invoke instead of calling a Web service or page method.
populateTriggerID	TA name of an element that can be clicked to trigger the target element population.
serviceMethod	The method name to call on the Web service or a page.
servicePath	The Web service URL to call.
updatingCssClass	The name of the CSS class to apply to the target during asynchronous calls.

Client methods

Name	Description
populate(contextKey)	Uses dymanic content to populate the target element.
setStyle(updating)	Sets the dislpayed style.

Client events

Name	Description
populated	Fires when populating ends.
populating	Fires when populating starts.

Client properties

clearContentsDuringUpdate

A Boolean value that specifies whether or the target content should be cleared when the update begins.

Getter name: get_clearContentsDuringUpdate()Setter name: set_clearContentsDuringUpdate(value)

contextKey

A string to pass to the Web method.

Getter name: get_contextKey()Setter name: set_contextKey(value)

populateTriggerID

TA name of an element that can be clicked to trigger the target element population.

Getter name: get_populateTriggerID()Setter name: set_populateTriggerID(value)

servicePath

The Web service URL to call.

Remarks: This property is optional. If the ServicePath property is not set, a page method is invoked instead of a Web service.

Getter name: get_servicePath()Setter name: set_servicePath(value)

serviceMethod

The method name to call on the Web service or a page.

Getter name: get_serviceMethod()Setter name: set_serviceMethod(value)

cacheDynamicResults

A Boolean value that specifies whether or not the results of the target element population should be cached and not fetched again after the first load.

Getter name: get_cacheDynamicResults()Setter name: set_cacheDynamicResults(value)

updatingCssClass

The name of the CSS class to apply to the target during asynchronous calls.

Getter name: get_updatingCssClass()Setter name: set_updatingCssClass(value)

customScript

The script to invoke instead of calling a Web service or page method.

Getter name: get_customScript()Setter name: set_customScript(value)

Client methods

populate(contextKey)

Uses dymanic content to populate the target element.

Remarks: If an element to populate is in a data-bound repeating control, the contextKey parameter can be an ID of the current row.

Params:

• contextKey
  • Type: String
  • Description: A string to pass to the Web service method or page method.

setStyle(updating)

Sets the dislpayed style.

Params:

• updating
  • Type: Boolean
  • Description: A Boolean value that specifies whether the display is being updated.

Client events

populating

Fires when populating starts.

Add event handler method: add_populating(handler)Remove event handler method: remove_populating(handler)Raise event method: raise_populating()

populated

Fires when populating ends.

Add event handler method: add_populated(handler)Remove event handler method: remove_populated(handler)Raise event method: raise_populated()