WebDataWindowControl properties

This section lists the properties for the WebDataWindowControl that are specific to the control (some properties are inherited from the System.Web.UI.WebControls.WebControl class). Table 9-2 lists the properties you can set in the Properties view. Table 9-3 lists the properties you can use in code to get information about the DataWindow object or control.

For more detailed information about each property, see the Sybase DataWindow online Help in the development environment or the DataWindow Reference compiled Help file (dwref20.chm).

Understanding how properties interact

Some properties that you can set in the Properties window in Visual Studio .NET can also be set for the DataWindow object in DataWindow Designer. If a property is set in DataWindow Designer, it is respected in DataWindow .NET. However, the properties you set in the painter are not reflected in the Properties view, which displays default values for most properties.

See Table 10-5 for a comparison of properties set in the two environments.

If you have set a property in DataWindow Designer, change the default for its equivalent in the Properties window only if you want to override the value set in the painter. If default values are changed in the Properties view, they override the values set in the painter. If default values are not changed, properties set in DataWindow Designer are used. For example:

Table 9-2: Properties that can be set for the WebDataWindowControl

Property

Description

AutoRestoreContext, AutoRestoreDataCache, AutoSaveDataCacheAfterRetrieve, EnableDataState

Properties used to customize context management and data caching. See “Maintaining state”.

ClientEventButtonClicked, ClientEventButtonClicking, ClientEventClicked, ClientEventItemChanged, ClientEventItemError, ClientEventItemFocusChanged, ClientEventRowFocusChanged, ClientEventRowFocusChanging

Properties used to specify event handlers for events on the Web DataWindow client control. See Chapter 12, “Writing Scripts for the Web DataWindow Client Control.”

ClientEvents

Specifies whether client events can be fired. You can reduce the size of the generated Web DataWindow control by setting the ClientEvents, ClientFormatting, ClientScriptable, and ClientValidation properties to false. See “Controlling the size of generated code”.

ClientFormatting

Specifies whether display formatting should be performed on the client in the browser.

ClientScriptable

Specifies whether client-side JavaScript can interact with the control.

ClientValidation

Specifies whether validation is performed on the client in the browser.

DataWindowObject

Specifies the name of the DataWindow object to load in the control (set the LibraryList property before setting DataWindowObject).

DisplayOnly

Specifies that the DataWindow object cannot be used for data entry.

GenerateDDDWFrames

Specifies whether drop-down DataWindows are generated using IFrames or HTML SELECT elements. See “Using a drop-down DataWindow”.

GraphConfigurations

Specifies how graphs are rendered in a WebDataWindowControl. See “Rendering graphs”.

HorizontalScrollBar, VerticalScrollBar

Specifies whether scroll bars display on the WebDataWindowControl. For more information, see “RowsPerPage and scroll bars”.

JavaScriptConfigurations

Specifies whether JavaScript for common tasks is embedded in the rendered DataWindow or associated internal files, or deployed in separate static files. See “Generating JavaScript for common management tasks”.

LibraryList

Specifies the list of libraries in which the control searches for DataWindow objects.

ObjectLinks

Specifies generated hyperlinks for objects in the DataWindow object. See “Creating hyperlinks”.

PageNavigationBarSettings

Specifies the type of navigation bar to display (with next and previous buttons, numbered pages, or an edit box or drop-down list) and other properties of the page navigation bar. See “Page navigation bars”.

PagingMethod

Specifies how paging is handled. See “Paging methods”.

RenderFormat

Specifies the format—XML, XHTML, or HTML—in which the DataWindow object is rendered. For which format to use, see “XML, XHTML, and HTML formats”.

RowsPerPage

Specifies how many rows display on each page. For more information, see “RowsPerPage and scroll bars”.

XmlConfigurations

Specifies the XHTML template to use for XML and XHTML Web DataWindows, the path where automatically generated files are saved, and optional SessionSpecific and SecurelyInline properties. For more information, see “Configuring XML”.

Table 9-3: Properties that return information about the WebDataWindowControl

Property

Description

ClientObjectName

Read-only property that specifies the name of the client-side Web DataWindow control.

ColumnCount

Returns the number of columns in the DataWindow object, excluding computed columns.

CurrentPage

Returns the number of the current page in the DataWindow object.

CurrentRow

Returns the number of the current row in the DataWindow object.

DataSourceType

Returns the type of the data source of the DataWindow object (SQL SELECT, stored procedure, external, or unbound).

DataWindowStyle

Returns the presentation style of the DataWindow object.

DeletedCount

Returns the number of rows that have been marked for deletion in the DataWindow object.

FilteredCount

Returns the number of rows not included in the primary buffer because of the application of filter criteria.

ModifiedCount

Returns the number of rows that have been modified in the DataWindow object.

PageCount

Returns the total number of pages in the DataWindow object.

PrintProperties

Returns an instance of the PrintProperties class that describes properties associated with printing the DataWindow object.

RowCount

Returns the number of rows in the DataWindow object.

Syntax

Returns the syntax that describes the DataWindow object.