DataGridTemplateColumn Class

 

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

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

System::Object
  System.Windows.Threading::DispatcherObject
    System.Windows::DependencyObject
      System.Windows.Controls::DataGridColumn
        System.Windows.Controls::DataGridTemplateColumn

public ref class DataGridTemplateColumn : DataGridColumn

NameDescription
System_CAPS_pubmethodDataGridTemplateColumn()

Initializes a new instance of the DataGridTemplateColumn class.

NameDescription
System_CAPS_pubpropertyActualWidth

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

System_CAPS_pubpropertyCanUserReorder

Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyCanUserResize

Gets or sets a value that indicates whether the user can adjust the column width by using the mouse.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyCanUserSort

Gets or sets a value that indicates whether the user can sort the column by clicking the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyCellEditingTemplate

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

System_CAPS_pubpropertyCellEditingTemplateSelector

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

System_CAPS_pubpropertyCellStyle

Gets or sets the style that is used to render cells in the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyCellTemplate

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

System_CAPS_pubpropertyCellTemplateSelector

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

System_CAPS_pubpropertyClipboardContentBinding

Gets or sets the binding object to use when getting or setting cell content for the clipboard.(Inherited from DataGridColumn.)

System_CAPS_protpropertyDataGridOwner

Gets the DataGrid control that contains this column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyDependencyObjectType

Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject.)

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyDisplayIndex

Gets or sets the display position of the column relative to the other columns in the DataGrid.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyDragIndicatorStyle

Gets or sets the style object to apply to the column header during a drag operation.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeader

Gets or sets the content of the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderStringFormat

Gets or sets the format pattern to apply to the content of the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderStyle

Gets or sets the style that is used when rendering the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderTemplate

Gets or sets the template that defines the visual representation of the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyHeaderTemplateSelector

Gets or sets the object that selects which template to use for the column header.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyIsAutoGenerated

Gets a value that indicates whether the column is auto-generated.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyIsFrozen

Gets a value that indicates whether the column is prevented from scrolling horizontally.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyIsReadOnly

Gets or sets a value that indicates whether cells in the column can be edited.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyIsSealed

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

System_CAPS_pubpropertyMaxWidth

Gets or sets the maximum width constraint of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyMinWidth

Gets or sets the minimum width constraint of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertySortDirection

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

System_CAPS_pubpropertySortMemberPath

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

System_CAPS_pubpropertyVisibility

Gets or sets the visibility of the column.(Inherited from DataGridColumn.)

System_CAPS_pubpropertyWidth

Gets or sets the column width or automatic sizing mode.(Inherited from DataGridColumn.)

NameDescription
System_CAPS_protmethodCancelCellEdit(FrameworkElement^, Object^)

Causes the cell being edited to revert to the original, unedited value.(Inherited from DataGridColumn.)

System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodClearValue(DependencyProperty^)

Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodClearValue(DependencyPropertyKey^)

Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)

System_CAPS_pubmethodCoerceValue(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.)

System_CAPS_protmethodCommitCellEdit(FrameworkElement^)

Performs any required validation before exiting cell editing mode.(Inherited from DataGridColumn.)

System_CAPS_pubmethodEquals(Object^)

Determines whether a provided DependencyObject is equivalent to the current DependencyObject.(Inherited from DependencyObject.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_protmethodGenerateEditingElement(DataGridCell^, Object^)

Gets an element defined by the CellEditingTemplate that is bound to the column's Binding property value.(Overrides DataGridColumn::GenerateEditingElement(DataGridCell^, Object^).)

System_CAPS_protmethodGenerateElement(DataGridCell^, Object^)

Gets an element defined by the CellTemplate that is bound to the column's Binding property value.(Overrides DataGridColumn::GenerateElement(DataGridCell^, Object^).)

System_CAPS_pubmethodGetCellContent(DataGridRow^)

Retrieves the Content property value for the cell at the intersection of this column and the specified row.(Inherited from DataGridColumn.)

System_CAPS_pubmethodGetCellContent(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.)

System_CAPS_pubmethodGetHashCode()

Gets a hash code for this DependencyObject.(Inherited from DependencyObject.)

System_CAPS_pubmethodGetLocalValueEnumerator()

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

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(DependencyProperty^)

Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)

System_CAPS_pubmethodInvalidateProperty(DependencyProperty^)

Re-evaluates the effective value for the specified dependency property(Inherited from DependencyObject.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodNotifyPropertyChanged(String^)

Notifies the DataGrid that contains this column that a column property has changed.(Inherited from DataGridColumn.)

System_CAPS_protmethodOnCoerceIsReadOnly(Boolean)

Determines the value of the IsReadOnly property based on the property rules of the DataGrid that contains this column.(Inherited from DataGridColumn.)

System_CAPS_pubmethodOnCopyingCellClipboardContent(Object^)

Raises the CopyingCellClipboardContent event.(Inherited from DataGridColumn.)

System_CAPS_pubmethodOnPastingCellClipboardContent(Object^, Object^)

Raises the PastingCellClipboardContent event.(Inherited from DataGridColumn.)

System_CAPS_protmethodOnPropertyChanged(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.)

System_CAPS_protmethodPrepareCellForEdit(FrameworkElement^, RoutedEventArgs^)

When overridden in a derived class, sets cell content as needed for editing.(Inherited from DataGridColumn.)

System_CAPS_pubmethodReadLocalValue(DependencyProperty^)

Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)

System_CAPS_protmethodRefreshCellContent(FrameworkElement^, String^)

Refreshes the contents of a cell in the column in response to a template property value change.(Overrides DataGridColumn::RefreshCellContent(FrameworkElement^, String^).)

System_CAPS_pubmethodSetCurrentValue(DependencyProperty^, Object^)

Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyProperty^, Object^)

Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)

System_CAPS_pubmethodSetValue(DependencyPropertyKey^, Object^)

Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)

System_CAPS_protmethodShouldSerializeProperty(DependencyProperty^)

Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property.(Inherited from DependencyObject.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticCellEditingTemplateProperty

Identifies the CellEditingTemplate dependency property.

System_CAPS_pubfieldSystem_CAPS_staticCellEditingTemplateSelectorProperty

Identifies the CellEditingTemplateSelector dependency property.

System_CAPS_pubfieldSystem_CAPS_staticCellTemplateProperty

Identifies the CellTemplate dependency property.

System_CAPS_pubfieldSystem_CAPS_staticCellTemplateSelectorProperty

Identifies the CellEditingTemplateSelector dependency property.

NameDescription
System_CAPS_pubeventCopyingCellClipboardContent

Occurs after the cell clipboard content is prepared.(Inherited from DataGridColumn.)

System_CAPS_pubeventPastingCellClipboardContent

Occurs before the clipboard content is moved to the cell.(Inherited from DataGridColumn.)

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
Available since 4.0
Silverlight
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: