GridSplitContainer.Initialize() Method

Creates and initializes an internal GridControl, ensuring that it is ready for further customization.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v23.2.dll

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

Declaration

C#

public void Initialize()

VB.NET

Public Sub Initialize

Remarks

The method creates a new GridControl and places it into the current container. The GridControl.ForceInitialize method is called internally to ensure that the created Grid Control is ready for further customization that you can safely perform from code. To access the created Grid Control, use the GridSplitContainer.Grid property.

You need to use the Initialize method if you create a GridSplitContainer in code.

Example

This example demonstrates how to create a GridSplitContainer in code, enable the Split View feature and customize the embedded Grid Controls being split.

View Example

Form1.cs

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Grid;
using DevExpress.XtraGrid.Columns;
using System.Collections;

namespace CreateGridSplitContainer {
    public partial class Form1 : Form {
        public Form1() {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e) {

            IList dataSource = CreateDataSource();

            GridSplitContainer gridSplitContainer = new GridSplitContainer();
            gridSplitContainer.Parent = this;
            gridSplitContainer.Location = new Point(0, 0);
            gridSplitContainer.Size = new Size(350, 300);
            gridSplitContainer.Initialize();
            gridSplitContainer.SplitViewCreated += new EventHandler(gridSplitContainer_SplitViewCreated);

            // Customize the first grid control.
            GridControl grid = gridSplitContainer.Grid;
            GridView view = grid.MainView as GridView;
            // Specify a data source.
            grid.DataSource = dataSource;
            // Resize columns according to their values.
            view.BestFitColumns();
            // Locate a row containing a specific value.
            view.FocusedRowHandle = view.LocateByValue("Country", "UK");

            // Display a splitter and second grid control.
            gridSplitContainer.ShowSplitView();

            // Customize the second grid control.
            GridControl secondGrid = gridSplitContainer.SplitChildGrid;
            GridView secondView = secondGrid.MainView as GridView;
            // Locate a row containing a specific value.
            secondView.FocusedRowHandle = secondView.LocateByValue("Country", "Sweden");
        }

        private void gridSplitContainer_SplitViewCreated(object sender, EventArgs e) {
            // Display the Embedded Navigator for the second grid control 
            // in the horizontally oriented Split View.
            GridSplitContainer gsc = sender as GridSplitContainer;
            if (!gsc.Horizontal)
                gsc.SplitChildGrid.UseEmbeddedNavigator = true;
        }


        private IList CreateDataSource() {
            List<MyRecord> list = new List<MyRecord>();
            list.Add(new MyRecord(1, "Rene Phillips", "USA"));
            list.Add(new MyRecord(2, "Robert McKinsey", "UK"));
            list.Add(new MyRecord(3, "Christina Berglund", "Sweden"));
            list.Add(new MyRecord(4, "Martín Sommer", "Spain"));
            list.Add(new MyRecord(5, "Laurence Lebihan", "France"));
            list.Add(new MyRecord(6, "Elizabeth Lincoln", "Canada"));
            list.Add(new MyRecord(7, "Steven Baum", "USA"));
            return list;
        }


    }

    public class MyRecord {
        public int ID { get; set; }
        public string Country { get; set; }
        public string Name { get; set; }
        public MyRecord(int id, string name, string country) {
            ID = id;
            Name = name;
            Country = country;
        }
    }
}

Form1.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.ComponentModel
Imports System.Data
Imports System.Drawing
Imports System.Linq
Imports System.Text
Imports System.Windows.Forms
Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.Grid
Imports DevExpress.XtraGrid.Columns
Imports System.Collections

Namespace CreateGridSplitContainer
    Partial Public Class Form1
        Inherits Form
        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load

            Dim dataSource As IList = CreateDataSource()

            Dim gridSplitContainer As New GridSplitContainer()
            gridSplitContainer.Parent = Me
            gridSplitContainer.Location = New Point(0, 0)
            gridSplitContainer.Size = New Size(350, 300)
            gridSplitContainer.Initialize()
            AddHandler gridSplitContainer.SplitViewCreated, AddressOf gridSplitContainer_SplitViewCreated

            ' Customize the first grid control.
            Dim grid As GridControl = gridSplitContainer.Grid
            Dim view As GridView = TryCast(grid.MainView, GridView)
            ' Specify a data source.
            grid.DataSource = dataSource
            ' Resize columns according to their values.
            view.BestFitColumns()
            ' Locate a row containing a specific value.
            view.FocusedRowHandle = view.LocateByValue("Country", "UK")

            ' Display a splitter and second grid control.
            gridSplitContainer.ShowSplitView()

            ' Customize the second grid control.
            Dim secondGrid As GridControl = gridSplitContainer.SplitChildGrid
            Dim secondView As GridView = TryCast(secondGrid.MainView, GridView)
            ' Locate a row containing a specific value.
            secondView.FocusedRowHandle = secondView.LocateByValue("Country", "Sweden")
        End Sub

        Private Sub gridSplitContainer_SplitViewCreated(ByVal sender As Object, ByVal e As EventArgs)
            ' Display the Embedded Navigator for the second grid control 
            ' in the horizontally oriented Split View.
            Dim gsc As GridSplitContainer = TryCast(sender, GridSplitContainer)
            If (Not gsc.Horizontal) Then
                gsc.SplitChildGrid.UseEmbeddedNavigator = True
            End If
        End Sub


        Private Function CreateDataSource() As IList
            Dim list As New List(Of MyRecord)()
            list.Add(New MyRecord(1, "Rene Phillips", "USA"))
            list.Add(New MyRecord(2, "Robert McKinsey", "UK"))
            list.Add(New MyRecord(3, "Christina Berglund", "Sweden"))
            list.Add(New MyRecord(4, "Martín Sommer", "Spain"))
            list.Add(New MyRecord(5, "Laurence Lebihan", "France"))
            list.Add(New MyRecord(6, "Elizabeth Lincoln", "Canada"))
            list.Add(New MyRecord(7, "Steven Baum", "USA"))
            Return list
        End Function


    End Class

    Public Class MyRecord
        Private privateID As Integer
        Public Property ID() As Integer
            Get
                Return privateID
            End Get
            Set(ByVal value As Integer)
                privateID = value
            End Set
        End Property
        Private privateCountry As String
        Public Property Country() As String
            Get
                Return privateCountry
            End Get
            Set(ByVal value As String)
                privateCountry = value
            End Set
        End Property
        Private privateName As String
        Public Property Name() As String
            Get
                Return privateName
            End Get
            Set(ByVal value As String)
                privateName = value
            End Set
        End Property
        Public Sub New(ByVal id As Integer, ByVal name As String, ByVal country As String)
            ID = id
            Name = name
            Country = country
        End Sub
    End Class
End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the Initialize() method.

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-grid-split-presentation/CS/Form1.cs#L28

gridSplitContainer.Size = new Size(350, 300);
gridSplitContainer.Initialize();
gridSplitContainer.SplitViewCreated += new EventHandler(gridSplitContainer_SplitViewCreated);

VB.NET

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

gridSplitContainer.Size = New Size(350, 300)
gridSplitContainer.Initialize()
AddHandler gridSplitContainer.SplitViewCreated, AddressOf gridSplitContainer_SplitViewCreated