DataGridAutoGeneratingColumnEventArgs Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Provides data for the DataGrid.AutoGeneratingColumn event.
Inheritance Hierarchy
System.Object
System.EventArgs
System.ComponentModel.CancelEventArgs
System.Windows.Controls.DataGridAutoGeneratingColumnEventArgs
Namespace: System.Windows.Controls
Assembly: System.Windows.Controls.Data (in System.Windows.Controls.Data.dll)
Syntax
'Declaration
Public Class DataGridAutoGeneratingColumnEventArgs _
Inherits CancelEventArgs
public class DataGridAutoGeneratingColumnEventArgs : CancelEventArgs
The DataGridAutoGeneratingColumnEventArgs type exposes the following members.
Constructors
Name | Description | |
---|---|---|
DataGridAutoGeneratingColumnEventArgs | Initializes a new instance of the DataGridAutoGeneratingColumnEventArgs class. |
Top
Properties
Name | Description | |
---|---|---|
Cancel | Gets or sets a value that indicates whether the operation should be canceled. (Inherited from CancelEventArgs.) | |
Column | Gets the generated column. | |
PropertyName | Gets the name of the property bound to the generated column. | |
PropertyType | Gets the Type of the property bound to the generated column. |
Top
Methods
Name | Description | |
---|---|---|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Remarks
The DataGridAutoGeneratingColumnEventArgs are used in the DataGrid.AutoGeneratingColumn event handler. The DataGridAutoGeneratingColumnEventArgs are used to access properties of the column that is being generated and to access information about the data item that the column is being generated from.
Examples
The following code example demonstrates how to use the DataGridAutoGeneratingColumnEventArgs. This example is part of a larger example available in the How to: Customize Auto-Generated Columns in the DataGrid Control topic.
Private Sub dataGrid1_AutoGeneratingColumn(ByVal sender As System.Object, ByVal e As System.Windows.Controls.DataGridAutoGeneratingColumnEventArgs)
' Modify the header of the Name column.
If e.Column.Header.ToString() = "Name" Then
e.Column.Header = "Task"
End If
' Replace the DueDate column with a custom template column.
If e.PropertyName = "DueDate" Then
' Create a new template column.
Dim templateColumn As New DataGridTemplateColumn
templateColumn.Header = "Due Date"
templateColumn.CellTemplate = Me.Resources("dueDateCellTemplate")
templateColumn.CellEditingTemplate = Me.Resources("dueDateCellEditingTemplate")
templateColumn.SortMemberPath = "DueDate"
' ...
' Replace the auto-generated column with the templateColumn.
e.Column = templateColumn
End If
' Cancel AutoGeneration of all boolean columns.
If e.PropertyType Is GetType(Boolean) Then
e.Cancel = True
End If
End Sub
private void dataGrid1_AutoGeneratingColumn(object sender, DataGridAutoGeneratingColumnEventArgs e)
{
// Modify the header of the Name column.
if (e.Column.Header.ToString() == "Name")
e.Column.Header = "Task";
// Replace the DueDate column with a custom template column.
if (e.PropertyName == "DueDate")
{
// Create a new template column.
DataGridTemplateColumn templateColumn = new DataGridTemplateColumn();
templateColumn.Header = "Due Date";
templateColumn.CellTemplate = (DataTemplate)Resources["dueDateCellTemplate"];
templateColumn.CellEditingTemplate = (DataTemplate)Resources["dueDateCellEditingTemplate"];
templateColumn.SortMemberPath = "DueDate";
// ...
// Replace the auto-generated column with the templateColumn.
e.Column = templateColumn;
}
// Cancel AutoGeneration of all boolean columns.
if (e.PropertyType == typeof(bool))
e.Cancel = true;
}
Version Information
Silverlight
Supported in: 5, 4, 3
Platforms
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also