Collection of Columns.

Namespace: Dapfor.Net.Ui
Assembly: Dapfor.Net (in Dapfor.Net.dll) Version: 2.10.3.24917 (2.10.3.24917)

Syntax

C#
public sealed class Header : IEnumerable<Column>, 
	IEnumerable, ICloneable
Visual Basic
Public NotInheritable Class Header
	Implements IEnumerable(Of Column), IEnumerable, 
	ICloneable
Visual C++
public ref class Header sealed : IEnumerable<Column^>, 
	IEnumerable, ICloneable
F#
[<SealedAttribute>]
type Header =  
    class
        interface IEnumerable<Column>
        interface IEnumerable
        interface ICloneable
    end

Remarks

A header is a collection of columns that enables displaying data in data grid's cells. A grid supports one or more headers. When a single header is used, the grid has TreeListView control behavior, just like the Microsoft Windows Explorer. Multiple headers enable separate column management for each hierarchical level. At a glance, every header consists of two panels: the grouping panel and the columns panel. These panels aren't related to each other. It means that the same column may be present in both panels simultaneously. Each column carries very important information about width, location, visibility, grouping and data sorting.

In programming, headers can be added to the grid by calling Grid.Headers.Add(Header header) method. When a header is added to Grid.Headers collection, a zero-based index is assigned to it in the hierarchy. When you call Header.Add(Column column) method, additional columns are added to a header. After that columns can be accessed with indexer operator. Every header has the following collections of columns:

The same column can be located in different lists. Almost each of the aforementioned lists has Clear() method, that has a specific action when invoked on a certain collection. Specifically, Header.GroupedColumns.Clear() removes data grouping in header of a grid. To group data you only have to set Column.Grouped property to true. If you set this property to true for multiple columns, it will result in multiple grouping and will fill corresponding collection in the data grid header. Such approach can be used in sorting (Column.SortDirection). The number of fixed columns is defined by Header.FixedColumns.Count.

 Copy imageCopy
public void MultipleHeaderGrid(Grid grid)
{
    //Initialize the grid with two headers
    grid.Headers.Add(new Header());
    grid.Headers[0].Add(new Column("FirstName", "First Name"));
    grid.Headers[0].Add(new Column("LastName", "Last Name"));

    grid.Headers.Add(new Header());
    grid.Headers[1].Add(new Column("BookName", "Name"));
    grid.Headers[1].Add(new Column("BookGenre", "Genre"));


    //Add some data objects to the grid
    Row row = grid.Rows.Add(new Writer("Agata", "Kristi"));
    row.Add(new Book("Second front", "Detective story"));
    row.Add(new Book("Shameful Star", "Detective story"));
}

Inheritance Hierarchy

System..::..Object
  Dapfor.Net.Ui..::..Header

Thread Safety

The class is not thread safe

See Also