SetHTMLAction method (DataWindows)
Description
Accepts action
and context information about user interaction with the Web DataWindow
client control in a Web browser so that newly generated HTML can
reflect any requested changes.
Controls
|
DataWindow type |
Method applies to |
|---|---|
|
PowerBuilder |
DataWindow control, DataStore object |
Syntax
[PowerBuilder]
|
1 |
integer <span>dwcontrol</span>.<span>SetHTMLAction</span> ( string <span>action</span>, string <span>context</span> ) |
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control or |
|
action |
A string describing an action associated |
|
context |
A string describing the context of action in The format is not documented and subject to change. |
Return Values
Returns 1 if it succeeds and one of these negative values
if an error occurs:
-
-1
Reloading the current context failed.
-
-2
The action was attempted but it failed.
-
-3
The action could not be performed (for example, the action
was InsertRow but the DataWindow has no editable fields for entering new
data). -
-4
The action was aborted by the HTMLContextApplied event.
-
-5
The action is invalid.
Usage
SetHTMLAction triggers the HTMLContextApplied event after
restraining the context but before performing the action. You can
use the event to perform data validation using methods of a server
component.
If you write your own server component in PowerBuilder instead
of using the generic Web DataWindow server component, you use this
method to update the generated HTML to reflect user actions.
For information about building your own server component,
see the DataWindow Programmers Guide.