PivotGridFieldBase.AutoPopulatedProperties Property

Get or set a collection of OLAP member properties.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v24.1.Core.dll

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.Win.Navigation

Declaration

C#

[PivotAPIMemberCategory(APICategory.OLAPSource)]
[XtraSerializableProperty(0)]
[XtraSerializablePropertyId(2)]
public string[] AutoPopulatedProperties { get; set; }

VB.NET

<PivotAPIMemberCategory(APICategory.OLAPSource)>
<XtraSerializableProperty(0)>
<XtraSerializablePropertyId(2)>
Public Property AutoPopulatedProperties As String()

Property Value

Type	Description
String[]	System.String objects, containing property names.

Remarks

In OLAP mode, when you get the IOLAPMember.Properties property, the PivotGridControl sends a query to server every time for each member. While sorting data using the CustomServerModeSort event, you can use the AutoPopulatedProperties to specify the list of OLAP member properties, which should be returned with a data query from the server. Create a new collection of OLAP member attributes using the AutoPopulatedProperties property to improve performance.

To get the OLAP member property values, use the IOLAPMember.AutoPopulatedProperties property.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AutoPopulatedProperties property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-pivot-grid-sort-data-by-olap-member-properties/CS/WinFormsPivotGridCustomOLAPSort/Form1.cs#L14

// Creates a new collection of OLAP member properties.
fieldProduct.AutoPopulatedProperties = new string[] { "Color", "Class", "List Price" };
//Sets a field's sort mode to Custom to raise the CustomServerModeSort event.

VB.NET

winforms-pivot-grid-sort-data-by-olap-member-properties/VB/WinFormsPivotGridCustomOLAPSort/Form1.vb#L14

' Creates a new collection of OLAP member properties.
fieldProduct.AutoPopulatedProperties = New String() {"Color", "Class", "List Price"}
'Sets a field's sort mode to Custom to raise the CustomServerModeSort event.