Export (0) Print
Expand All
Expand Minimize

DataGrid.AutoGenerateColumns Property

Gets or sets a value that indicates whether the columns are created automatically.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

Public Property AutoGenerateColumns As Boolean
<object AutoGenerateColumns="bool" .../>

Property Value

Type: System.Boolean
true if columns are created automatically; otherwise, false. The registered default is true. For more information about what can influence the value, see DependencyProperty.

Setting AutoGenerateColumns to true or false creates or removes auto-generated columns. When the AutoGenerateColumns property is set to true, the AutoGeneratingColumn event will be raised for each column that is created. You can change or cancel the column being created in the AutoGeneratingColumn event handler.

When auto-generation of all columns is complete, the AutoGeneratedColumns event is raised.


DataGrid cannot auto-generate columns when the source is XML data. In this case, create a custom Columns collection. For an example, see DataGridTextColumn.

The following example shows how to auto-generate columns and change the columns at creation time in the AutoGeneratingColumn event handler.

<!-- The DataGrid.DataContext is a DataTable that contains a list of customers.  The DataTable columns are  
     Title, FirstName, MiddleName, LastName, Suffix, CompanyName, EmailAddress, and Phone.-->
<DataGrid Name="DG1" ItemsSource="{Binding}" AutoGenerateColumns="True" AutoGeneratingColumn="DG1_AutoGeneratingColumn" />
'Access and update columns during autogeneration 
Private Sub DG1_AutoGeneratingColumn(ByVal sender As Object, ByVal e As DataGridAutoGeneratingColumnEventArgs)
    Dim headername As String = e.Column.Header.ToString()
    'Cancel the column you don't want to generate 
    If headername = "MiddleName" Then
        e.Cancel = True 
    End If 

    'update column details when generating 
    If headername = "FirstName" Then
        e.Column.Header = "First Name" 
    ElseIf headername = "LastName" Then
        e.Column.Header = "Last Name" 
    ElseIf headername = "EmailAddress" Then
        e.Column.Header = "Email" 
    End If 
End Sub

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4
© 2015 Microsoft