PivotGridFieldBase.DisplayFolder Property

Gets or sets the name of the folder containing the field.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.PivotGrid.v23.2.Core.dll

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

Declaration

C#

[DefaultValue("")]
public string DisplayFolder { get; set; }

VB.NET

<DefaultValue("")>
Public Property DisplayFolder As String

Property Value

Type	Default	Description
String	String.Empty	A String that specifies the name of the folder in which the field is located.

Remarks

Regular data binding mode

Assign a folder name to the DisplayFolder property to place a field into this folder displayed in the Customization Form.

Note

For a Pivot Grid, user-defined folders can be displayed only in Excel-style Customization Form.

You can also create folder hierarchies by nesting folders inside one another. In this instance, use the “" symbol as a delimiter when specifying folder names.

To enable displaying user folders, set the PivotGridOptionsViewBase.GroupFieldsInCustomizationWindow property to true.

OLAP data binding mode

Use the DisplayFolder property to obtain the name of a server-defined display folder or measure group to which the field belongs.

If a field is not retrieved from an OLAP server and obtains its data using the expression assigned to the PivotGridFieldBase.OLAPExpression property, you can use the DisplayFolder property to specify the name of the folder that contains the field. The PivotGridFieldBase.OLAPDimensionCaption property specifies the root name and allows you to group data fields created in the application.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DisplayFolder 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-create-user-folders-within-the-customization-form/CS/XtraPivotGrid_UserFolders/Form1.cs#L21

// Specify the name of the folder that contains the Employees field.
fieldSalesPerson1.DisplayFolder = "Employees";
fieldSalesPerson1.Visible = false;

VB.NET

winforms-pivot-create-user-folders-within-the-customization-form/VB/XtraPivotGrid_UserFolders/Form1.vb#L23

' Specify the name of the folder that contains the Employees field.
fieldSalesPerson1.DisplayFolder = "Employees"
fieldSalesPerson1.Visible = False