DataGridTemplateColumn DataGridTemplateColumn DataGridTemplateColumn DataGridTemplateColumn Class

Definition

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

public ref class DataGridTemplateColumn : System::Windows::Controls::DataGridColumn
public class DataGridTemplateColumn : System.Windows.Controls.DataGridColumn
type DataGridTemplateColumn = class
    inherit DataGridColumn
Public Class DataGridTemplateColumn
Inherits DataGridColumn
Inheritance

Examples

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

Remarks

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.

Constructors

DataGridTemplateColumn() DataGridTemplateColumn() DataGridTemplateColumn() DataGridTemplateColumn()

Initializes a new instance of the DataGridTemplateColumn class.

Fields

CellEditingTemplateProperty CellEditingTemplateProperty CellEditingTemplateProperty CellEditingTemplateProperty

Identifies the CellEditingTemplate dependency property.

CellEditingTemplateSelectorProperty CellEditingTemplateSelectorProperty CellEditingTemplateSelectorProperty CellEditingTemplateSelectorProperty

Identifies the CellEditingTemplateSelector dependency property.

CellTemplateProperty CellTemplateProperty CellTemplateProperty CellTemplateProperty

Identifies the CellTemplate dependency property.

CellTemplateSelectorProperty CellTemplateSelectorProperty CellTemplateSelectorProperty CellTemplateSelectorProperty

Identifies the CellEditingTemplateSelector dependency property.

Properties

ActualWidth ActualWidth ActualWidth ActualWidth

Gets the current width of the column, in device-independent units (1/96th inch per unit).

(Inherited from DataGridColumn)
CanUserReorder CanUserReorder CanUserReorder CanUserReorder

Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.

(Inherited from DataGridColumn)
CanUserResize CanUserResize CanUserResize CanUserResize

Gets or sets a value that indicates whether the user can adjust the column width by using the mouse.

(Inherited from DataGridColumn)
CanUserSort CanUserSort CanUserSort CanUserSort

Gets or sets a value that indicates whether the user can sort the column by clicking the column header.

(Inherited from DataGridColumn)
CellEditingTemplate CellEditingTemplate CellEditingTemplate CellEditingTemplate

Gets or sets the template to use to display the contents of a cell that is in editing mode.

CellEditingTemplateSelector CellEditingTemplateSelector CellEditingTemplateSelector CellEditingTemplateSelector

Gets or sets the object that determines which template to use to display the contents of a cell that is in editing mode.

CellStyle CellStyle CellStyle CellStyle

Gets or sets the style that is used to render cells in the column.

(Inherited from DataGridColumn)
CellTemplate CellTemplate CellTemplate CellTemplate

Gets or sets the template to use to display the contents of a cell that is not in editing mode.

CellTemplateSelector CellTemplateSelector CellTemplateSelector CellTemplateSelector

Gets or sets the object that determines which template to use to display the contents of a cell that is not in editing mode.

ClipboardContentBinding ClipboardContentBinding ClipboardContentBinding ClipboardContentBinding

Gets or sets the binding object to use when getting or setting cell content for the clipboard.

(Inherited from DataGridColumn)
DataGridOwner DataGridOwner DataGridOwner DataGridOwner

Gets the DataGrid control that contains this column.

(Inherited from DataGridColumn)
DependencyObjectType DependencyObjectType DependencyObjectType DependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance.

(Inherited from DependencyObject)
Dispatcher Dispatcher Dispatcher Dispatcher

Gets the Dispatcher this DispatcherObject is associated with.

(Inherited from DispatcherObject)
DisplayIndex DisplayIndex DisplayIndex DisplayIndex

Gets or sets the display position of the column relative to the other columns in the DataGrid.

(Inherited from DataGridColumn)
DragIndicatorStyle DragIndicatorStyle DragIndicatorStyle DragIndicatorStyle

Gets or sets the style object to apply to the column header during a drag operation.

(Inherited from DataGridColumn)
Header Header Header Header

Gets or sets the content of the column header.

(Inherited from DataGridColumn)
HeaderStringFormat HeaderStringFormat HeaderStringFormat HeaderStringFormat

Gets or sets the format pattern to apply to the content of the column header.

(Inherited from DataGridColumn)
HeaderStyle HeaderStyle HeaderStyle HeaderStyle

Gets or sets the style that is used when rendering the column header.

(Inherited from DataGridColumn)
HeaderTemplate HeaderTemplate HeaderTemplate HeaderTemplate

Gets or sets the template that defines the visual representation of the column header.

(Inherited from DataGridColumn)
HeaderTemplateSelector HeaderTemplateSelector HeaderTemplateSelector HeaderTemplateSelector

Gets or sets the object that selects which template to use for the column header.

(Inherited from DataGridColumn)
IsAutoGenerated IsAutoGenerated IsAutoGenerated IsAutoGenerated

Gets a value that indicates whether the column is auto-generated.

(Inherited from DataGridColumn)
IsFrozen IsFrozen IsFrozen IsFrozen

Gets a value that indicates whether the column is prevented from scrolling horizontally.

(Inherited from DataGridColumn)
IsReadOnly IsReadOnly IsReadOnly IsReadOnly

Gets or sets a value that indicates whether cells in the column can be edited.

(Inherited from DataGridColumn)
IsSealed IsSealed IsSealed IsSealed

Gets a value that indicates whether this instance is currently sealed (read-only).

(Inherited from DependencyObject)
MaxWidth MaxWidth MaxWidth MaxWidth

Gets or sets the maximum width constraint of the column.

(Inherited from DataGridColumn)
MinWidth MinWidth MinWidth MinWidth

Gets or sets the minimum width constraint of the column.

(Inherited from DataGridColumn)
SortDirection SortDirection SortDirection SortDirection

Gets or sets the sort direction (ascending or descending) of the column.

(Inherited from DataGridColumn)
SortMemberPath SortMemberPath SortMemberPath SortMemberPath

Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.

(Inherited from DataGridColumn)
Visibility Visibility Visibility Visibility

Gets or sets the visibility of the column.

(Inherited from DataGridColumn)
Width Width Width Width

Gets or sets the column width or automatic sizing mode.

(Inherited from DataGridColumn)

Methods

CancelCellEdit(FrameworkElement, Object) CancelCellEdit(FrameworkElement, Object) CancelCellEdit(FrameworkElement, Object) CancelCellEdit(FrameworkElement, Object)

Causes the cell being edited to revert to the original, unedited value.

(Inherited from DataGridColumn)
CheckAccess() CheckAccess() CheckAccess() CheckAccess()

Determines whether the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)
ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.

(Inherited from DependencyObject)
ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey) ClearValue(DependencyPropertyKey)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.

(Inherited from DependencyObject)
CoerceValue(DependencyProperty) CoerceValue(DependencyProperty) CoerceValue(DependencyProperty) CoerceValue(DependencyProperty)

Coerces 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)
CommitCellEdit(FrameworkElement) CommitCellEdit(FrameworkElement) CommitCellEdit(FrameworkElement) CommitCellEdit(FrameworkElement)

Performs any required validation before exiting cell editing mode.

(Inherited from DataGridColumn)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.

(Inherited from DependencyObject)
GenerateEditingElement(DataGridCell, Object) GenerateEditingElement(DataGridCell, Object) GenerateEditingElement(DataGridCell, Object) GenerateEditingElement(DataGridCell, Object)

Gets an element defined by the CellEditingTemplate that is bound to the column's Binding property value.

GenerateElement(DataGridCell, Object) GenerateElement(DataGridCell, Object) GenerateElement(DataGridCell, Object) GenerateElement(DataGridCell, Object)

Gets an element defined by the CellTemplate that is bound to the column's Binding property value.

GetCellContent(DataGridRow) GetCellContent(DataGridRow) GetCellContent(DataGridRow) GetCellContent(DataGridRow)

Retrieves the Content property value for the cell at the intersection of this column and the specified row.

(Inherited from DataGridColumn)
GetCellContent(Object) GetCellContent(Object) GetCellContent(Object) GetCellContent(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)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gets a hash code for this DependencyObject.

(Inherited from DependencyObject)
GetLocalValueEnumerator() GetLocalValueEnumerator() GetLocalValueEnumerator() GetLocalValueEnumerator()

Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.

(Inherited from DependencyObject)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property on this instance of a DependencyObject.

(Inherited from DependencyObject)
InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty) InvalidateProperty(DependencyProperty)

Re-evaluates the effective value for the specified dependency property

(Inherited from DependencyObject)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
NotifyPropertyChanged(String) NotifyPropertyChanged(String) NotifyPropertyChanged(String) NotifyPropertyChanged(String)

Notifies the DataGrid that contains this column that a column property has changed.

(Inherited from DataGridColumn)
OnCoerceIsReadOnly(Boolean) OnCoerceIsReadOnly(Boolean) OnCoerceIsReadOnly(Boolean) OnCoerceIsReadOnly(Boolean)

Determines the value of the IsReadOnly property based on the property rules of the DataGrid that contains this column.

(Inherited from DataGridColumn)
OnCopyingCellClipboardContent(Object) OnCopyingCellClipboardContent(Object) OnCopyingCellClipboardContent(Object) OnCopyingCellClipboardContent(Object)

Raises the CopyingCellClipboardContent event.

(Inherited from DataGridColumn)
OnPastingCellClipboardContent(Object, Object) OnPastingCellClipboardContent(Object, Object) OnPastingCellClipboardContent(Object, Object) OnPastingCellClipboardContent(Object, Object)

Raises the PastingCellClipboardContent event.

(Inherited from DataGridColumn)
OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs) OnPropertyChanged(DependencyPropertyChangedEventArgs)

Invoked 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)
PrepareCellForEdit(FrameworkElement, RoutedEventArgs) PrepareCellForEdit(FrameworkElement, RoutedEventArgs) PrepareCellForEdit(FrameworkElement, RoutedEventArgs) PrepareCellForEdit(FrameworkElement, RoutedEventArgs)

When overridden in a derived class, sets cell content as needed for editing.

(Inherited from DataGridColumn)
ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if it exists.

(Inherited from DependencyObject)
RefreshCellContent(FrameworkElement, String) RefreshCellContent(FrameworkElement, String) RefreshCellContent(FrameworkElement, String) RefreshCellContent(FrameworkElement, String)

Refreshes the contents of a cell in the column in response to a template property value change.

SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object) SetCurrentValue(DependencyProperty, Object)

Sets the value of a dependency property without changing its value source.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object) SetValue(DependencyProperty, Object)

Sets the local value of a dependency property, specified by its dependency property identifier.

(Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object) SetValue(DependencyPropertyKey, Object)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.

(Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty) ShouldSerializeProperty(DependencyProperty)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.

(Inherited from DependencyObject)
ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)
VerifyAccess() VerifyAccess() VerifyAccess() VerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.

(Inherited from DispatcherObject)

Events

CopyingCellClipboardContent CopyingCellClipboardContent CopyingCellClipboardContent CopyingCellClipboardContent

Occurs after the cell clipboard content is prepared.

(Inherited from DataGridColumn)
PastingCellClipboardContent PastingCellClipboardContent PastingCellClipboardContent PastingCellClipboardContent

Occurs before the clipboard content is moved to the cell.

(Inherited from DataGridColumn)

Applies to

See Also