Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

AFGlobalSettings.CollectionPageSize Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFGlobalSettings.CollectionPageSize Property
The number of items on each page of a paged collection.

Namespace:  OSIsoft.AF
Assembly:  OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public static int CollectionPageSize { get; set; }
Public Shared Property CollectionPageSize As Integer
	Get
	Set

Dim value As Integer

value = AFGlobalSettings.CollectionPageSize

AFGlobalSettings.CollectionPageSize = value
public:
static property int CollectionPageSize {
	int get ();
	void set (int value);
}
static member CollectionPageSize : int with get, set

Property Value

Type: Int32
Returns the number of items on a page of a paged collection. The default value is 1000.

Remarks

This setting determines the number of items on each page of a paged collection. If the number of items is less that this setting, then the entire collection will be loaded. If the number of items is greater than this setting, then the items in the collection are loaded one-page-at-a-time. The only collection in the SDK that supports automatic paging is the AFElements collection.

The default value for this property is read from the SDK's configuration file in the OSI directory under the CommonApplicationData directory. This default value will be the default for all clients executed on the computer. If this property is modified in the client, then it will only affect the current client and the modified value will not be persisted.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5

See Also

In This Topic
TitleResults for “How to create a CRG?”Also Available in