DataGridTemplateColumn Class

Represents a DataGrid column that hosts template-specified content in its cells.

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 class DataGridTemplateColumn : DataGridColumn
<DataGridTemplateColumn .../>

The DataGridTemplateColumn type exposes the following members.

  NameDescription
Public methodDataGridTemplateColumnInitializes a new instance of the DataGridTemplateColumn class.
Top

  NameDescription
Public propertyActualWidthGets the current width of the column, in device-independent units (1/96th inch per unit). (Inherited from DataGridColumn.)
Public propertyCanUserReorderGets or sets a value that indicates whether the user can change the column display position by dragging the column header. (Inherited from DataGridColumn.)
Public propertyCanUserResizeGets or sets a value that indicates whether the user can adjust the column width by using the mouse. (Inherited from DataGridColumn.)
Public propertyCanUserSortGets or sets a value that indicates whether the user can sort the column by clicking the column header. (Inherited from DataGridColumn.)
Public propertyCellEditingTemplateGets or sets the template to use to display the contents of a cell that is in editing mode.
Public propertyCellEditingTemplateSelectorGets or sets the object that determines which template to use to display the contents of a cell that is in editing mode.
Public propertyCellStyleGets or sets the style that is used to render cells in the column. (Inherited from DataGridColumn.)
Public propertyCellTemplateGets or sets the template to use to display the contents of a cell that is not in editing mode.
Public propertyCellTemplateSelectorGets or sets the object that determines which template to use to display the contents of a cell that is not in editing mode.
Public propertyClipboardContentBindingGets or sets the binding object to use when getting or setting cell content for the clipboard. (Inherited from DataGridColumn.)
Protected propertyDataGridOwnerGets the DataGrid control that contains this column. (Inherited from DataGridColumn.)
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyDisplayIndexGets or sets the display position of the column relative to the other columns in the DataGrid. (Inherited from DataGridColumn.)
Public propertyDragIndicatorStyleGets or sets the style object to apply to the column header during a drag operation. (Inherited from DataGridColumn.)
Public propertyHeaderGets or sets the content of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderStringFormatGets or sets the format pattern to apply to the content of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderStyleGets or sets the style that is used when rendering the column header. (Inherited from DataGridColumn.)
Public propertyHeaderTemplateGets or sets the template that defines the visual representation of the column header. (Inherited from DataGridColumn.)
Public propertyHeaderTemplateSelectorGets or sets the object that selects which template to use for the column header. (Inherited from DataGridColumn.)
Public propertyIsAutoGeneratedGets a value that indicates whether the column is auto-generated. (Inherited from DataGridColumn.)
Public propertyIsFrozenGets a value that indicates whether the column is prevented from scrolling horizontally. (Inherited from DataGridColumn.)
Public propertyIsReadOnlyGets or sets a value that indicates whether cells in the column can be edited. (Inherited from DataGridColumn.)
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public propertyMaxWidthGets or sets the maximum width constraint of the column. (Inherited from DataGridColumn.)
Public propertyMinWidthGets or sets the minimum width constraint of the column. (Inherited from DataGridColumn.)
Public propertySortDirectionGets or sets the sort direction (ascending or descending) of the column. (Inherited from DataGridColumn.)
Public propertySortMemberPathGets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by. (Inherited from DataGridColumn.)
Public propertyVisibilityGets or sets the visibility of the column. (Inherited from DataGridColumn.)
Public propertyWidthGets or sets the column width or automatic sizing mode. (Inherited from DataGridColumn.)
Top

  NameDescription
Protected methodCancelCellEditCauses the cell being edited to revert to the original, unedited value. (Inherited from DataGridColumn.)
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCoerceValueCoerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject.)
Protected methodCommitCellEditPerforms any required validation before exiting cell editing mode. (Inherited from DataGridColumn.)
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGenerateEditingElementGets an element defined by the CellEditingTemplate that is bound to the column's Binding property value. (Overrides DataGridColumn.GenerateEditingElement(DataGridCell, Object).)
Protected methodGenerateElementGets an element defined by the CellTemplate that is bound to the column's Binding property value. (Overrides DataGridColumn.GenerateElement(DataGridCell, Object).)
Public methodGetCellContent(DataGridRow)Retrieves the Content property value for the cell at the intersection of this column and the specified row. (Inherited from DataGridColumn.)
Public methodGetCellContent(Object)Gets the Content property value for the cell at the intersection of this column and the row that represents the specified data item. (Inherited from DataGridColumn.)
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodNotifyPropertyChangedNotifies the DataGrid that contains this column that a column property has changed. (Inherited from DataGridColumn.)
Protected methodOnCoerceIsReadOnlyDetermines the value of the IsReadOnly property based on the property rules of the DataGrid that contains this column. (Inherited from DataGridColumn.)
Public methodOnCopyingCellClipboardContentRaises the CopyingCellClipboardContent event. (Inherited from DataGridColumn.)
Public methodOnPastingCellClipboardContentRaises the PastingCellClipboardContent event. (Inherited from DataGridColumn.)
Protected methodOnPropertyChangedInvoked whenever the effective value of any dependency property on this DependencyObject has been updated. The specific dependency property that changed is reported in the event data. (Inherited from DependencyObject.)
Protected methodPrepareCellForEditWhen overridden in a derived class, sets cell content as needed for editing. (Inherited from DataGridColumn.)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected methodRefreshCellContentRefreshes the contents of a cell in the column in response to a template property value change. (Overrides DataGridColumn.RefreshCellContent(FrameworkElement, String).)
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventCopyingCellClipboardContentOccurs after the cell clipboard content is prepared. (Inherited from DataGridColumn.)
Public eventPastingCellClipboardContentOccurs before the clipboard content is moved to the cell. (Inherited from DataGridColumn.)
Top

  NameDescription
Public fieldStatic memberCellEditingTemplatePropertyIdentifies the CellEditingTemplate dependency property.
Public fieldStatic memberCellEditingTemplateSelectorPropertyIdentifies the CellEditingTemplateSelector dependency property.
Public fieldStatic memberCellTemplatePropertyIdentifies the CellTemplate dependency property.
Public fieldStatic memberCellTemplateSelectorPropertyIdentifies the CellEditingTemplateSelector dependency property.
Top

The DataGridTemplateColumn type enables you to create your own column types by specifying the cell templates to use when displaying and editing values. To specify the template that is used to display the contents of a cell that is not in editing mode, set the CellTemplate property. To specify the template that is used to display the contents of a cell that is in editing mode, set the CellEditingTemplate property. For more information about templates, see Data Templating Overview and Styling and Templating.

For convenience, DataGrid provides the following pre-defined column types:

Column Type

Data Display

DataGridHyperlinkColumn

Use to display URI data.

DataGridComboBoxColumn

Use to display enumeration data.

DataGridTextColumn

Use to display text.

DataGridCheckBoxColumn

Use to display Boolean data.

The following example shows how to create a DataGridTemplateColumn.


<Grid>
    <Grid.Resources>
        <!--DataTemplate for Published Date column defined in Grid.Resources.  PublishDate is a property on the ItemsSource of type DateTime -->
        <DataTemplate x:Key="DateTemplate" >
            <StackPanel Width="20" Height="30">
                <Border Background="LightBlue" BorderBrush="Black" BorderThickness="1">
                    <TextBlock Text="{Binding PublishDate, StringFormat={}{0:MMM}}" FontSize="8" HorizontalAlignment="Center" />
                </Border>
                <Border Background="White" BorderBrush="Black" BorderThickness="1">
                    <TextBlock Text="{Binding PublishDate, StringFormat={}{0:yyyy}}" FontSize="8" FontWeight="Bold" HorizontalAlignment="Center" />
                </Border>
            </StackPanel>
        </DataTemplate>
        <!--DataTemplate for the Published Date column when in edit mode. -->
        <DataTemplate x:Key="EditingDateTemplate">
            <DatePicker SelectedDate="{Binding PublishDate}"  />
        </DataTemplate>
    </Grid.Resources>
    <DataGrid Name="DG1" ItemsSource="{Binding}" AutoGenerateColumns="False" >
        <DataGrid.Columns>
            <!--Custom column that shows the published date-->
            <DataGridTemplateColumn Header="Publish Date" CellTemplate="{StaticResource DateTemplate}" CellEditingTemplate="{StaticResource EditingDateTemplate}" />
        </DataGrid.Columns>
    </DataGrid>
</Grid>


The following illustration shows the output from the previous XAML.

A column using a DataTemplate

.NET Framework

Supported in: 4

.NET Framework Client Profile

Supported in: 4

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft