SetPageSize

Description

Specifies the number of rows to include in a generated Web page for the Web DataWindow.

Applies to

DataWindow type

Method applies to

Web

Server component

Syntax

Web DataWindow server component

string dwcomponent.SetPageSize ( long pagesize )

Argument

Description

dwcomponent

A reference to a Web DataWindow server component.

pagesize

The number of rows of data to include in a generated Web page. If the Web page does not include all available rows, you can include Button controls in the DataWindow object for navigating other subsets of rows. To include all available rows in the page, specify 0 for PageSize.

Sets the value of the HTMLGen.PageSize 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

This method calls the Modify method of the server component’s DataStore to set the property. It is particularly useful for the XML Web DataWindow where you typically want to limit the number of rows per page.

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

Examples

Example 1

This example specifies that the HTML generated by the webDW component will have 20 rows of data:

webDW.SetPageSize(20);

See also