QueryMode

Description

Whether the DataWindow is in query mode. In query mode, the user can specify the desired data by entering WHERE criteria in one or more columns.

NoteDataWindow presentation styles You cannot use QueryMode with DataWindow objects that use any of the following presentation styles: N-Up, Label, Crosstab, and Graph.

Applies to

DataWindows

Syntax

Describe and Modify argument:

"DataWindow.QueryMode { = value }"

Parameter

Description

value

Whether the DataWindow is in query mode.

Values are:

  • Yes – Query mode is enabled.

  • No – Query mode is disabled.

Usage

After the user specifies retrieval criteria in query mode, subsequent calls to Retrieve can use the new criteria. To retrieve data based on user selection, change the query mode back to No and use AcceptText to accept the user’s specification before the next call to Retrieve.

Setting QuerySort to Yes also puts the DataWindow into query mode, changing the QueryMode property’s value to Yes.


Query mode and secondary DataWindows

When you are sharing data, you cannot turn on query mode for a secondary DataWindow. Trying to set the QueryMode or QuerySort properties results in an error.


Buffer manipulation and query mode

A DataWindow cannot be in query mode when you call the RowsCopy method.

Examples

Example 1

setting = dw1.Describe("DataWindow.QueryMode")

Example 2

dw1.Modify("DataWindow.QueryMode=yes")