Back to Devexpress

HideInUI Enum

expressappframework-devexpress-dot-persistent-dot-base-a00aa62d.md

latest3.5 KB
Original Source

HideInUI Enum

Specifies whether a reference property or enumeration value should be hidden on certain UI views.

Namespace : DevExpress.Persistent.Base

Assembly : DevExpress.ExpressApp.v25.2.dll

NuGet Package : DevExpress.ExpressApp

Declaration

csharp
public enum HideInUI
vb
Public Enum HideInUI

Members

NameDescription
ListViewColumn

Property (column) does not appear in List Views. You can use the Column Chooser’s Customization Form (Object Dialog) to display the property again.

| | ListViewCustomizationForm |

Hides the property on the List View Column Chooser Customization Form (Object Model).

| | DetailViewEditor |

Property does not appear on Detail View editors. You can use the Layout Editor’s Customization Form to display the property again.

| | DetailViewCustomizationForm |

Property does not appear on Detail View Customization Form (Object Model).

| | ReportCustomizationForm |

Property does not appear in the Report Designer.

| | DashboardCustomizationForm |

Property does not appear on the Dashboards Customization Form (Object Model).

| | All |

Property or enumeration value does not appear in UI. Similar in effect to [Browsable(false)].

| | ListView |

Property (column) does not appear in List Views and associated Customization Form and Filter Editor. Enumeration value does not appear in ListView inline editing.

| | DetailView |

Property does not appear on Detail View editors, View Items Customization Form (Object Model), and Criteria Property Editors. Enumeration value does not appear in the items of enumeration property editor.

| | FilterEditor |

Property does not appear in field lists in the List View’s Filter Editor and Criteria Properties.

|

Remarks

You can combine flags to hide a property on select UI views:

csharp
using DevExpress.Persistent.Base;
using DevExpress.Persistent.Base.General;
using System.Collections.ObjectModel;
using System.ComponentModel;

namespace YourSolutionName.Module.BusinessObjects;
[DefaultClassOptions]
public class Category : BaseObject {
   public virtual string Name { get; set; }
   [HideInUI(HideInUI.ListViewColumn | HideInUI.DetailViewEditor)]
   public virtual Guid ParentObjectId { get; set; }
   // ...
}

Note that only the following fields are supported for enumeration values:

  • All
  • DetailView
  • ListView
csharp
using DevExpress.Persistent.Base;
using DevExpress.Persistent.BaseImpl.EF;

namespace YourSolutionName.Module.BusinessObjects; {
    [DefaultClassOptions]
    public class TestObjects : BaseObject {
        public virtual SampleEnum EnumProperty { get; set; } 
    }

    public enum SampleEnum {
        [HideInUI(HideInUI.All)]
        Value1,
        [HideInUI(HideInUI.DetailView)]
        Value2,
        [HideInUI(HideInUI.ListView)]
        Value3,
        Value4
    } 
}

See Also

DevExpress.Persistent.Base Namespace