kw.ProgressDisplay Class

get_Id() – string

Gets the id of the current control.

add_OnProgressUpdate(handler)

Adds an event handler that fires every time updated progress data is recieved

Parameters

• handler (function) – The function to call when this event is triggered.

Remarks

The handler recieves a data parameter with the updated progress data.

get_IsInitializing()

Returns a boolean that specifies whether the ProgressDisplay is in the initializing state.

set_IsInitializing(value)

Sets the ProgressDisplay initializing state.

Parameters

• value (bool) – A boolean that specifies whether the ProgressDisplay is in the initializing state.

get_IsComplete()

Returns a boolean that specifies whether the ProgressDisplay is in the complete state.

set_IsComplete(value)

Sets the ProgressDisplay complete state.

Parameters

• value (bool) – A boolean that specifies whether the ProgressDisplay is in the complete state.

get_IsInSubmit()

Returns a boolean that specifies whether the ProgressDisplay is running while the page is being posted..

set_IsInSubmit(value)

Sets the ProgressDisplay is running while the page is being posted.

Parameters

• value (bool) – A boolean that specifies whether the ProgressDisplay is running while the page is being posted.

set_ProgressUrl(value)

Sets the progress URL to access for progress updates.

Parameters

• value (string) – The progress URL.

start(initialData)

Starts the progress update polling.

Parameters

• initialData (object) – The initial data to display.

kw.ProgressDisplay(id, progressUrl, interval)

Initializes a new instance of the ProgressDisplay class.

Parameters

• id (string) – The id of the control.
• progressUrl (string) – The URL to access to get progress information.
• interval (int) – The interval between polling for progress updates, in milliseconds.