AFGlobalSettings.CollectionPageSize Property
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
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: Int32Returns 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.