Back to Devexpress

GridControl.MainView Property

windowsforms-devexpress-dot-xtragrid-dot-gridcontrol-d3f9a20e.md

latest22.9 KB
Original Source

GridControl.MainView Property

Gets or sets the View that displays data at the top hierarchy level.

Namespace : DevExpress.XtraGrid

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
[DefaultValue(null)]
public BaseView MainView { get; set; }
vb
<Browsable(False)>
<DefaultValue(Nothing)>
Public Property MainView As BaseView

Property Value

TypeDefaultDescription
BaseViewnull

A BaseView descendant representing the View that displays data at the top hierarchy level.

|

Remarks

When the grid control doesn’t display master-detail data, the View specified by the MainView property is the only View that displays data. By default, when the grid control is created, it initializes the MainView property with a GridView object with default settings. Thus, if you need to display data using a Card View, create a new CardView object and assign it to the MainView property.

When using the grid control to display master-detail relationships, the MainView property specifies the View that will represent the top level data. This is the data specified by the grid control’s GridControl.DataSource and GridControl.DataMember properties. Detail data is represented by Views stored within the GridControl.LevelTree tree or supplied by the master View’s GridView.MasterRowGetLevelDefaultView event handler.

All Views currently displayed are stored within the GridControl.Views collection. The first element in the collection is the MainView property value. Other elements are added or removed dynamically when detail clones are expanded and collapsed respectively.

Note

Do not set the MainView property while wrapping the setter with the GridControl.BeginUpdate and GridControl.EndUpdate method pair. Instead, set the MainView property outside the BeginUpdate / EndUpdate block.

Example

The following example creates a GridControl at runtime and shows how to perform basic customization tasks:

  • Bind the grid to a data source
  • Access the View that displays the underlying data
  • Access columns
  • Assign an in-place editor (a combo box editor) to a column
  • Sort and group data
  • Calculate total and group summaries
  • Create a filter
  • Hide columns and calculate column “best” widths
  • Expand group rows
  • Focus a specific cell
  • Specify DataAnnotation attributes (column display names and data formats) at the data source level

Note

Add the corresponding assemblies to your Windows Forms project.

Read the following topic for information: Redistribution and Deployment of .NET Framework Apps.

csharp
using System;
using DevExpress.ClipboardSource.SpreadsheetML;
using DevExpress.Data;
using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Repository;
using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Columns;
using DevExpress.XtraGrid.Views.Grid;
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using System.Runtime.CompilerServices;
using System.Windows.Forms;

namespace DXApplication {
    public partial class Form1 : XtraForm {
        public Form1() {
            InitializeComponent();
            this.Load += Form1_Load;
        }
        private void Form1_Load(object sender, EventArgs e) {
            GridControl gridControl1 = new GridControl() {
                Name = "gridControl1",
                Parent = this,
                Dock = DockStyle.Fill
            };
            gridControl1.DataSource = DataHelper.GetData(30);
            // The grid automatically creates columns for the public fields found in the data source. 
            // Calling the gridView1.PopulateColumns method is not required unless gridView1.OptionsBehavior.AutoPopulateColumns is disabled.

            // The grid automatically creates a GridView that displays the underlying data as a two-dimensional table.
            GridView gridView1 = gridControl1.MainView as GridView;

            // Obtain created columns.
            GridColumn colCompany = gridView1.Columns["CompanyName"];
            GridColumn colID = gridView1.Columns["ID"];
            GridColumn colDate = gridView1.Columns["RequiredDate"];
            GridColumn colPayment = gridView1.Columns["Value"];
            GridColumn colProcessed = gridView1.Columns["Processed"];

            // The Company column uses a ComboBox in-place editor that shows a list of available companies.
            RepositoryItemComboBox riComboBox = new RepositoryItemComboBox();
            riComboBox.Items.AddRange(DataHelper.companies);
            gridControl1.RepositoryItems.Add(riComboBox);
            colCompany.ColumnEdit = riComboBox;

            // Hide a column.
            colID.Visible = false;

            // Group and sort data.
            colCompany.GroupIndex = 0;
            colDate.SortIndex = 0;
            colDate.SortOrder = DevExpress.Data.ColumnSortOrder.Descending;

            // Show group columns in the table.
            gridView1.OptionsView.ShowGroupedColumns = true;

            // Expand group rows.
            gridView1.ExpandAllGroups();

            // Apply a filter.
            gridView1.ActiveFilterString = "[RequiredDate]>= #" + DateTime.Today.ToString() + "#";

            // Calculate two total summaries.
            colDate.Summary.Add(SummaryItemType.Count, colDate.FieldName, "Count={0}");
            colDate.Summary.Add(SummaryItemType.Max, colDate.FieldName, "Max={0:d}");
            gridView1.OptionsView.ShowFooter = true;

            // Calculate group summaries.
            GridGroupSummaryItem item = new GridGroupSummaryItem();
            item.FieldName = colCompany.FieldName;
            item.SummaryType = DevExpress.Data.SummaryItemType.Count;
            gridView1.GroupSummary.Add(item);

            GridGroupSummaryItem item1 = new GridGroupSummaryItem();
            item1.FieldName = colPayment.FieldName;
            item1.SummaryType = SummaryItemType.Sum;
            item1.DisplayFormat = "group total={0:c2}";
            item1.ShowInGroupColumnFooter = colPayment;
            gridView1.GroupSummary.Add(item1);

            // Forcibly move group footer summaries to positions in group rows under corresponding column headers. 
            gridView1.OptionsBehavior.AlignGroupSummaryInGroupRow = DevExpress.Utils.DefaultBoolean.True;

            // Focus a specific cell.
            gridView1.FocusedRowHandle = 1;
            gridView1.FocusedColumn = colCompany;

            // Optimize column widths.
            colDate.BestFit();
            colProcessed.BestFit();
        }
    }

    public class Record : INotifyPropertyChanged {
        public Record() {
        }
        int id;
        public int ID {
            get { return id; }
            set {
                if(id != value) {
                    id = value;
                    OnPropertyChanged();
                }
            }
        }

        string text;
        [DisplayName("Company")]
        public string CompanyName {
            get { return text; }
            set {
                if(text != value) {
                    if(string.IsNullOrEmpty(value))
                        throw new Exception();
                    text = value;
                    OnPropertyChanged();
                }
            }
        }
        Nullable<decimal> val;
        [DataType(System.ComponentModel.DataAnnotations.DataType.Currency)]
        [DisplayName("Payment")]
        public Nullable<decimal> Value {
            get { return val; }
            set {
                if(val != value) {
                    val = value;
                    OnPropertyChanged();
                }
            }
        }
        DateTime dt;
        [DisplayFormat(DataFormatString = "d")]
        public DateTime RequiredDate {
            get { return dt; }
            set {
                if(dt != value) {
                    dt = value;
                    OnPropertyChanged();
                }
            }
        }
        bool state;
        public bool Processed {
            get { return state; }
            set {
                if(state != value) {
                    state = value;
                    OnPropertyChanged();
                }
            }
        }

        public override string ToString() {
            return string.Format("ID = {0}, Text = {1}", ID, CompanyName);
        }

        public event PropertyChangedEventHandler PropertyChanged;
        protected void OnPropertyChanged([CallerMemberName] string propertyName = "") {
            if(PropertyChanged != null)
                PropertyChanged(this, new PropertyChangedEventArgs(propertyName));
        }
    }

    public class DataHelper {

        public static string[] companies = new string[] { "Hanari Carnes", "Que Delícia", "Romero y tomillo", "Mère Paillarde",
            "Comércio Mineiro", "Reggiani Caseifici", "Maison Dewey" };
        public static BindingList<Record> GetData(int count) {
            BindingList<Record> records = new BindingList<Record>();
            Random rnd = new Random();
            for(int i = 0; i < count; i++) {
                int n = rnd.Next(10);
                records.Add(new Record() {
                    ID = i + 100,
                    CompanyName = companies[i % companies.Length],
                    RequiredDate = DateTime.Today.AddDays(n - 5),
                    Value = i % 2 == 0 ? (i + 1) * 123 : i * 231,
                    Processed = i % 2 == 0,
                });
            };
            return records;
        }
    }

}
vb
Imports System
Imports DevExpress.ClipboardSource.SpreadsheetML
Imports DevExpress.Data
Imports DevExpress.XtraEditors
Imports DevExpress.XtraEditors.Repository
Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Columns
Imports DevExpress.XtraGrid.Views.Grid
Imports System.ComponentModel
Imports System.ComponentModel.DataAnnotations
Imports System.Runtime.CompilerServices
Imports System.Windows.Forms

Namespace DXApplication
    Partial Public Class Form1
        Inherits XtraForm

        Public Sub New()
            InitializeComponent()
            AddHandler Me.Load, AddressOf Form1_Load
        End Sub
        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs)
            Dim gridControl1 As New GridControl() With {.Name = "gridControl1", .Parent = Me, .Dock = DockStyle.Fill}
            gridControl1.DataSource = DataHelper.GetData(30)
            ' The grid automatically creates columns for the public fields found in the data source. 
            ' Calling the gridView1.PopulateColumns method is not required unless gridView1.OptionsBehavior.AutoPopulateColumns is disabled.

            ' The grid automatically creates a GridView that displays the underlying data as a two-dimensional table.
            Dim gridView1 As GridView = TryCast(gridControl1.MainView, GridView)

            ' Obtain created columns.
            Dim colCompany As GridColumn = gridView1.Columns("CompanyName")
            Dim colID As GridColumn = gridView1.Columns("ID")
            Dim colDate As GridColumn = gridView1.Columns("RequiredDate")
            Dim colPayment As GridColumn = gridView1.Columns("Value")
            Dim colProcessed As GridColumn = gridView1.Columns("Processed")

            ' The Company column uses a ComboBox in-place editor that shows a list of available companies.
            Dim riComboBox As New RepositoryItemComboBox()
            riComboBox.Items.AddRange(DataHelper.companies)
            gridControl1.RepositoryItems.Add(riComboBox)
            colCompany.ColumnEdit = riComboBox

            ' Hide a column.
            colID.Visible = False

            ' Group and sort data.
            colCompany.GroupIndex = 0
            colDate.SortIndex = 0
            colDate.SortOrder = DevExpress.Data.ColumnSortOrder.Descending

            ' Show group columns in the table.
            gridView1.OptionsView.ShowGroupedColumns = True

            ' Expand group rows.
            gridView1.ExpandAllGroups()

            ' Apply a filter.
            gridView1.ActiveFilterString = "[RequiredDate]>= #" & Date.Today.ToString() & "#"

            ' Calculate two total summaries.
            colDate.Summary.Add(SummaryItemType.Count, colDate.FieldName, "Count={0}")
            colDate.Summary.Add(SummaryItemType.Max, colDate.FieldName, "Max={0:d}")
            gridView1.OptionsView.ShowFooter = True

            ' Calculate group summaries.
            Dim item As New GridGroupSummaryItem()
            item.FieldName = colCompany.FieldName
            item.SummaryType = DevExpress.Data.SummaryItemType.Count
            gridView1.GroupSummary.Add(item)

            Dim item1 As New GridGroupSummaryItem()
            item1.FieldName = colPayment.FieldName
            item1.SummaryType = SummaryItemType.Sum
            item1.DisplayFormat = "group total={0:c2}"
            item1.ShowInGroupColumnFooter = colPayment
            gridView1.GroupSummary.Add(item1)

            ' Forcibly move group footer summaries to positions in group rows under corresponding column headers. 
            gridView1.OptionsBehavior.AlignGroupSummaryInGroupRow = DevExpress.Utils.DefaultBoolean.True

            ' Focus a specific cell.
            gridView1.FocusedRowHandle = 1
            gridView1.FocusedColumn = colCompany

            ' Optimize column widths.
            colDate.BestFit()
            colProcessed.BestFit()
        End Sub
    End Class

    Public Class Record
        Implements INotifyPropertyChanged

        Public Sub New()
        End Sub

        Private id_Renamed As Integer
        Public Property ID() As Integer
            Get
                Return id_Renamed
            End Get
            Set(ByVal value As Integer)
                If id_Renamed <> value Then
                    id_Renamed = value
                    OnPropertyChanged()
                End If
            End Set
        End Property

        Private text As String
        <DisplayName("Company")>
        Public Property CompanyName() As String
            Get
                Return text
            End Get
            Set(ByVal value As String)
                If text <> value Then
                    If String.IsNullOrEmpty(value) Then
                        Throw New Exception()
                    End If
                    text = value
                    OnPropertyChanged()
                End If
            End Set
        End Property
        Private val? As Decimal
        <DataType(System.ComponentModel.DataAnnotations.DataType.Currency), DisplayName("Payment")>
        Public Property Value() As Decimal?
            Get
                Return val
            End Get
            Set(ByVal value? As Decimal)
                If Not val.Equals(value) Then
                    val = value
                    OnPropertyChanged()
                End If
            End Set
        End Property
        Private dt As Date
        <DisplayFormat(DataFormatString := "d")>
        Public Property RequiredDate() As Date
            Get
                Return dt
            End Get
            Set(ByVal value As Date)
                If dt <> value Then
                    dt = value
                    OnPropertyChanged()
                End If
            End Set
        End Property
        Private state As Boolean
        Public Property Processed() As Boolean
            Get
                Return state
            End Get
            Set(ByVal value As Boolean)
                If state <> value Then
                    state = value
                    OnPropertyChanged()
                End If
            End Set
        End Property

        Public Overrides Function ToString() As String
            Return String.Format("ID = {0}, Text = {1}", ID, CompanyName)
        End Function

        Public Event PropertyChanged As PropertyChangedEventHandler Implements INotifyPropertyChanged.PropertyChanged
        Protected Sub OnPropertyChanged(Optional <CallerMemberName> ByVal propertyName As String = "")
            RaiseEvent PropertyChanged(Me, New PropertyChangedEventArgs(propertyName))
        End Sub
    End Class

    Public Class DataHelper

        Public Shared companies() As String = { "Hanari Carnes", "Que Delícia", "Romero y tomillo", "Mère Paillarde", "Comércio Mineiro", "Reggiani Caseifici", "Maison Dewey" }
        Public Shared Function GetData(ByVal count As Integer) As BindingList(Of Record)
            Dim records As New BindingList(Of Record)()
            Dim rnd As New Random()
            For i As Integer = 0 To count - 1
                Dim n As Integer = rnd.Next(10)
                records.Add(New Record() With {.ID = i + 100, .CompanyName = companies(i Mod companies.Length), .RequiredDate = Date.Today.AddDays(n - 5), .Value = If(i Mod 2 = 0, (i + 1) * 123, i * 231), .Processed = i Mod 2 = 0})
            Next i
            Return records
        End Function
    End Class

End Namespace

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

winforms-grid-use-layoutview-as-master-view/CS/WindowsApplication3/MasterDetailHelper.cs#L37

csharp
detailGrid = CreateGrid();
    detailGrid.MainView = DetailView;
}

winforms-grid-change-height-to-match-height-of-rows/CS/GridControlAutoSize/Form1.cs#L34

csharp
gridControl1.Size = gridControl1.CalcBestSize(maxSize, false);
gridControl1.MainView?.LayoutChanged();
gridControl1.Size = gridControl1.CalcBestSize(maxSize, true);

why-data-bound-controls-properties-work-incorrectly-until-a-control-become-visible-e2582/CS/WindowsApplication1/Form1.cs#L45

csharp
}
_GridControl.MainView = new GridView(_GridControl);
_GridControl.DataSource = tbl;

winforms-grid-split-presentation/CS/Form1.cs#L33

csharp
GridControl grid = gridSplitContainer.Grid;
GridView view = grid.MainView as GridView;
// Specify a data source.

winforms-grid-display-icons-in-data-cells/CS/Form1.cs#L77

csharp
this.gridControl1.Location = new System.Drawing.Point(0, 0);
this.gridControl1.MainView = this.gridView1;
this.gridControl1.Name = "gridControl1";

winforms-grid-use-layoutview-as-master-view/VB/WindowsApplication3/MasterDetailHelper.vb#L44

vb
detailGrid_Renamed = CreateGrid()
    detailGrid_Renamed.MainView = DetailView
End If

winforms-grid-change-height-to-match-height-of-rows/VB/GridControlAutoSize/Form1.vb#L36

vb
gridControl1.Size = gridControl1.CalcBestSize(maxSize, False)
gridControl1.MainView?.LayoutChanged()
gridControl1.Size = gridControl1.CalcBestSize(maxSize, True)

why-data-bound-controls-properties-work-incorrectly-until-a-control-become-visible-e2582/VB/WindowsApplication1/Form1.vb#L42

vb
_GridControl.MainView = New GridView(_GridControl)
_GridControl.DataSource = tbl

winforms-grid-split-presentation/VB/Form1.vb#L35

vb
Dim grid As GridControl = gridSplitContainer.Grid
Dim view As GridView = TryCast(grid.MainView, GridView)
' Specify a data source.

winforms-grid-display-icons-in-data-cells/VB/Form1.vb#L71

vb
gridControl1.Location = New System.Drawing.Point(0, 0)
gridControl1.MainView = gridView1
gridControl1.Name = "gridControl1"

See Also

DataSource

DataMember

Views

LevelTree

GridControl Class

GridControl Members

DevExpress.XtraGrid Namespace