SetHTMLObjectName

Description

Specifies a name for the Web DataWindow client control.

Applies to

DataWindow type

Method applies to

Web

Server component

Syntax

Web DataWindow server component

string dwcomponent.SetHTMLObjectName ( string objectname )

Argument

Description

dwcomponent

A reference to a Web DataWindow server component.

objectname

A string specifying a name used in generated code for the Web DataWindow client control, page parameters, and client side events.

Sets the value of the HTMLGen.ObjectName property for the DataWindow object associated with the server component.

Returns

Returns an empty string if successful and the syntax error message from the Modify method if it fails.

Usage

You must specify a unique object name when there will be more than one Web DataWindow on a Web page so names will not conflict.

This method calls the Modify method of the server component’s DataStore to set the property.

For information about using the Web DataWindow, see the DataWindow Programmers Guide.

Examples

Example 1

This example specifies a name to be used in generated HTML for the server component called webDW:

webDW.SetHTMLObjectName ("dwMine");

See also