PivotGridFieldBase.DisplayFolder Property

Gets or sets the name of the folder in which the field is located.

Namespace: DevExpress.XtraPivotGrid

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

Declaration

C#

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

VB.NET

<XtraSerializablePropertyId(3)>
<XtraSerializableProperty>
<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

In a regular data binding mode, assign a folder name to the DisplayFolder property to place a field into this folder. In this instance, this field will be displayed within the specified folder in the Customization Form. To learn more, see User Folders.

Note that you do not need to perform specific actions to create a Customization Form folder. This will be done automatically once you specify a new folder name to the DisplayFolder property of a field.

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.

In the OLAP mode, use the DisplayFolder property to obtain the name of a server-defined display folder or measure group to which the field belongs.

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#

how-to-create-user-folders-within-the-customization-form-e4391/CS/XtraPivotGrid_UserFolders/Form1.cs#L19

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

VB.NET

how-to-create-user-folders-within-the-customization-form-e4391/VB/XtraPivotGrid_UserFolders/Form1.vb#L21

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