PivotItem.Visible Property

Gets or sets a value indicating whether the item should be displayed in the report.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v18.2.Core.dll

Declaration

C#

bool Visible { get; set; }

VB.NET

Property Visible As Boolean

Property Value

Type	Description
Boolean	true, if the item is visible; otherwise, false.

Remarks

Use the Visible property to control the visibility of items in a PivotTable field. The following example demonstrates how to hide the first item in the “Product” row field.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/winforms-spreadsheet-pivot-table-api-t298650

PivotTableFilterActions.vb

Dim worksheet As Worksheet = workbook.Worksheets("Report4")
workbook.Worksheets.ActiveWorksheet = worksheet

' Access the pivot table by its name in the collection.
Dim pivotTable As PivotTable = worksheet.PivotTables("PivotTable1")
' Access items of the "Product" field.
Dim pivotFieldItems As PivotItemCollection = pivotTable.Fields(1).Items

' Hide the first item in the "Product" field.
pivotFieldItems(0).Visible = False

PivotTableFilterActions.cs

Worksheet worksheet = workbook.Worksheets["Report4"];
workbook.Worksheets.ActiveWorksheet = worksheet;

// Access the pivot table by its name in the collection.
PivotTable pivotTable = worksheet.PivotTables["PivotTable1"];
// Access items of the "Product" field.
PivotItemCollection pivotFieldItems = pivotTable.Fields[1].Items;

// Hide the first item in the "Product" field.
pivotFieldItems[0].Visible = false;

To hide all items in a PivotTable field except one, use the PivotField.ShowSingleItem method.

To restore the display of all hidden items in a pivot field, call the PivotField.ShowAllItems method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Visible 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#

wpf-spreadsheet-pivot-table-api-t314425/CS/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotTableFilterActions.cs#L36

// Hide the first item in the "Product" field.
pivotFieldItems[0].Visible = false;
#endregion #ItemVisibility

winforms-spreadsheet-pivot-table-api-t298650/CS/SpreadsheetPivotTableExamples/CodeExamples/PivotTableFilterActions.cs#L36

// Hide the first item in the "Product" field.
pivotFieldItems[0].Visible = false;
#endregion #ItemVisibility

spreadsheet-document-api-pivot-table-examples/CS/SpreadsheetDocServerPivotAPI/CodeExamples/PivotTableFilterActions.cs#L36

// Hide the first item in the "Product" field.
pivotFieldItems[0].Visible = false;
#endregion #ItemVisibility

VB.NET

wpf-spreadsheet-pivot-table-api-t314425/VB/SpreadsheetWPFPivotTableExamples/CodeExamples/PivotTableFilterActions.vb#L36

            ' Hide the first item in the "Product" field.
            pivotFieldItems(0).Visible = False
'            #End Region ' #ItemVisibility

winforms-spreadsheet-pivot-table-api-t298650/VB/SpreadsheetPivotTableExamples/CodeExamples/PivotTableFilterActions.vb#L36

            ' Hide the first item in the "Product" field.
            pivotFieldItems(0).Visible = False
'            #End Region ' #ItemVisibility

spreadsheet-document-api-pivot-table-examples/VB/SpreadsheetDocServerPivotAPI/CodeExamples/PivotTableFilterActions.vb#L36

            ' Hide the first item in the "Product" field.
            pivotFieldItems(0).Visible = False
'            #End Region ' #ItemVisibility