PivotGridFieldBase.Visible Property

Gets or sets whether the field is visible.

Namespace: DevExpress.XtraPivotGrid

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

NuGet Packages: DevExpress.PivotGrid.Core, DevExpress.WindowsDesktop.PivotGrid.Core

Declaration

C#

[DefaultValue(true)]
public virtual bool Visible { get; set; }

VB.NET

<DefaultValue(True)>
Public Overridable Property Visible As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if the field is visible; false otherwise.

Remarks

If a field is hidden it can still be accessed via the Customization form. To prevent a hidden field from being displayed within the Customization form set its PivotGridFieldOptions.ShowInCustomizationForm property to false.

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#

winforms-pivot-grid-connect-to-an-olap-datasource/CS/WinOlapRetrieveFieldsExample/Form1.cs#L35

pivotGridControl1.Fields["[Customer].[Country].[Country]"].OLAPDimensionCaption = "TEST";
pivotGridControl1.Fields["[Customer].[Country].[Country]"].Visible = true;
pivotGridControl1.Fields["[Customer].[City].[City]"].Area = PivotArea.RowArea;

winforms-pivot-create-user-folders-within-the-customization-form/CS/XtraPivotGrid_UserFolders/Form1.cs#L22

fieldSalesPerson.DisplayFolder = "Employees";
fieldSalesPerson.Visible = false;

aspxpivotgrid-how-to-change-the-summary-display-mode-t590012/CS/SummaryDisplayMode/Default.aspx.cs#L42

if(SourceDataField != null)
    cbShowRawValues.Checked = SourceDataField.Visible;
ConfigureSummaryDisplayTypeComboBox(SelectedGroup);

how-to-modify-fields-properties-at-runtime-and-show-customization-form-within-a-panel-e2353/CS/WindowsApplication32/Form1.cs#L29

pivot.Fields["ProductAmount"].Area = PivotArea.DataArea;
pivot.Fields["ProductAmount"].Visible = true;
pivot.Fields["CompanyName"].Area = PivotArea.RowArea;

winforms-pivot-totals-visibility/CS/Form1.cs#L33

for(int i = 0; i < pivotGridControl.Fields.Count; i++) {
    if(pivotGridControl.Fields[i].Visible && pivotGridControl.Fields[i].Area == field.Area
        && pivotGridControl.Fields[i].AreaIndex > field.AreaIndex)

VB.NET

winforms-pivot-grid-connect-to-an-olap-datasource/VB/WinOlapRetrieveFieldsExample/Form1.vb#L31

pivotGridControl1.Fields("[Customer].[Country].[Country]").OLAPDimensionCaption = "TEST"
pivotGridControl1.Fields("[Customer].[Country].[Country]").Visible = True
pivotGridControl1.Fields("[Customer].[City].[City]").Area = PivotArea.RowArea

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

fieldSalesPerson.DisplayFolder = "Employees"
fieldSalesPerson.Visible = False

aspxpivotgrid-how-to-change-the-summary-display-mode-t590012/VB/SummaryDisplayMode/Default.aspx.vb#L60

If SourceDataField IsNot Nothing Then
    cbShowRawValues.Checked = SourceDataField.Visible
End If

how-to-modify-fields-properties-at-runtime-and-show-customization-form-within-a-panel-e2353/VB/WindowsApplication32/Form1.vb#L26

pivot.Fields("ProductAmount").Area = PivotArea.DataArea
pivot.Fields("ProductAmount").Visible = True
pivot.Fields("CompanyName").Area = PivotArea.RowArea

winforms-pivot-totals-visibility/VB/Form1.vb#L34

For i As Integer = 0 To pivotGridControl.Fields.Count - 1
    If pivotGridControl.Fields(i).Visible AndAlso pivotGridControl.Fields(i).Area = field.Area AndAlso pivotGridControl.Fields(i).AreaIndex > field.AreaIndex Then
        Return False