The internal paging size used by the enumerator.

GetPageSize returns the internal paging size used by the enumerator.

SetPageSize sets the internal paging size used by the enumerator. The new size takes effect on the next fetch from the server. Typical use cases for changing the page size are to match the number of displayed elements in a user interface or to improve performance of page retrieval.


Namespace: FileNet.Api.Collection
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Property PageSize As Integer
C#
int PageSize { get; set; }
C++
property int PageSize abstract  {
    int get();
    void set(int value);
}
J#
/** property */
public int get_PageSize();

/** property */
public void set_PageSize(int value);
JScript
public function get PageSize() : int

public function set PageSize(value : int);

Property Value

An integer value for the page size.

Exceptions

Exception TypeCondition
EngineRuntimeException Thrown if the enumerator is positioned before the first page or after the last page, or between pages after a Reset(mark) operation.

See Also