Skip to main content
.NET Framework Class Library
DataGridColumn Class

Represents a DataGrid column.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
Syntax
Public MustInherit Class DataGridColumn _
	Inherits [%$TOPIC/cc672492_en-us_VS_110_3_0_0_0_0%]
public abstract class DataGridColumn : [%$TOPIC/cc672492_en-us_VS_110_3_0_1_0_0%]
public ref class DataGridColumn abstract : public [%$TOPIC/cc672492_en-us_VS_110_3_0_2_0_0%]
[<[%$TOPIC/cc672492_en-us_VS_110_3_0_3_0_0%]>]
type DataGridColumn =  
    class 
        inherit [%$TOPIC/cc672492_en-us_VS_110_3_0_3_0_1%] 
    end

The DataGridColumn type exposes the following members.

Constructors
  NameDescription
Protected method DataGridColumnInitializes a new instance of the DataGridColumn class.
Top
Properties
  NameDescription
Public property ActualWidthGets the current width of the column, in device-independent units (1/96th inch per unit).
Public property CanUserReorderGets or sets a value that indicates whether the user can change the column display position by dragging the column header.
Public property CanUserResizeGets or sets a value that indicates whether the user can adjust the column width by using the mouse.
Public property CanUserSortGets or sets a value that indicates whether the user can sort the column by clicking the column header.
Public property CellStyleGets or sets the style that is used to render cells in the column.
Public property ClipboardContentBindingGets or sets the binding object to use when getting or setting cell content for the clipboard.
Protected property DataGridOwnerGets the DataGrid control that contains this column.
Public property DependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property DispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property DisplayIndexGets or sets the display position of the column relative to the other columns in the DataGrid.
Public property DragIndicatorStyleGets or sets the style object to apply to the column header during a drag operation.
Public property HeaderGets or sets the content of the column header.
Public property HeaderStringFormatGets or sets the format pattern to apply to the content of the column header.
Public property HeaderStyleGets or sets the style that is used when rendering the column header.
Public property HeaderTemplateGets or sets the template that defines the visual representation of the column header.
Public property HeaderTemplateSelectorGets or sets the object that selects which template to use for the column header.
Public property IsAutoGeneratedGets a value that indicates whether the column is auto-generated.
Public property IsFrozenGets a value that indicates whether the column is prevented from scrolling horizontally.
Public property IsReadOnlyGets or sets a value that indicates whether cells in the column can be edited.
Public property IsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property MaxWidthGets or sets the maximum width constraint of the column.
Public property MinWidthGets or sets the minimum width constraint of the column.
Public property SortDirectionGets or sets the sort direction (ascending or descending) of the column.
Public property SortMemberPathGets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.
Public property VisibilityGets or sets the visibility of the column.
Public property WidthGets or sets the column width or automatic sizing mode.
Top
Methods
  NameDescription
Protected method CancelCellEditCauses the cell being edited to revert to the original, unedited value.
Public method CheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public method ClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public method ClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public method CoerceValueCoerces 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 method CommitCellEditPerforms any required validation before exiting cell editing mode.
Public method EqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected method FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GenerateEditingElementWhen overridden in a derived class, gets an editing element that is bound to the Binding property value of the column.
Protected method GenerateElementWhen overridden in a derived class, gets a read-only element that is bound to the Binding property value of the column.
Public method GetCellContent(DataGridRow)Retrieves the Content property value for the cell at the intersection of this column and the specified row.
Public method 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.
Public method GetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public method GetTypeGets the Type of the current instance. (Inherited from Object.)
Public method GetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected method MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected method NotifyPropertyChangedNotifies the DataGrid that contains this column that a column property has changed.
Protected method OnCoerceIsReadOnlyDetermines the value of the IsReadOnly property based on the property rules of the DataGrid that contains this column.
Public method OnCopyingCellClipboardContentRaises the CopyingCellClipboardContent event.
Public method OnPastingCellClipboardContentRaises the PastingCellClipboardContent event.
Protected method OnPropertyChangedInvoked 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 method PrepareCellForEditWhen overridden in a derived class, sets cell content as needed for editing.
Public method ReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected method RefreshCellContentWhen overridden in a derived class, updates the contents of a cell in the column in response to a column property value that changed.
Public method SetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public method SetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public method 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.)
Protected method ShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ToStringReturns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
Events
  NameDescription
Public event CopyingCellClipboardContentOccurs after the cell clipboard content is prepared.
Public event PastingCellClipboardContentOccurs before the clipboard content is moved to the cell.
Top
Fields
  NameDescription
Public field Static member ActualWidthPropertyIdentifies the ActualWidth dependency property.
Public field Static member CanUserReorderPropertyIdentifies the CanUserReorder dependency property.
Public field Static member CanUserResizePropertyIdentifies the CanUserResize dependency property.
Public field Static member CanUserSortPropertyIdentifies the CanUserSort dependency property.
Public field Static member CellStylePropertyIdentifies the CellStyle dependency property.
Public field Static member DisplayIndexPropertyIdentifies the DisplayIndex dependency property.
Public field Static member DragIndicatorStylePropertyIdentifies the DragIndicatorStyle dependency property.
Public field Static member HeaderPropertyIdentifies the Header dependency property.
Public field Static member HeaderStringFormatPropertyIdentifies the HeaderStringFormat dependency property.
Public field Static member HeaderStylePropertyIdentifies the HeaderStyle dependency property.
Public field Static member HeaderTemplatePropertyIdentifies the HeaderTemplate dependency property.
Public field Static member HeaderTemplateSelectorPropertyIdentifies the HeaderTemplateSelector dependency property.
Public field Static member IsAutoGeneratedPropertyIdentifies the IsAutoGenerated dependency property.
Public field Static member IsFrozenPropertyIdentifies the IsFrozen dependency property.
Public field Static member IsReadOnlyPropertyIdentifies the IsReadOnly dependency property.
Public field Static member MaxWidthPropertyIdentifies the MaxWidth dependency property.
Public field Static member MinWidthPropertyIdentifies the MinWidth dependency property.
Public field Static member SortDirectionPropertyIdentifies the SortDirection dependency property.
Public field Static member SortMemberPathPropertyIdentifies the SortMemberPath dependency property.
Public field Static member VisibilityPropertyIdentifies the Visibility dependency property.
Public field Static member WidthPropertyIdentifies the Width dependency property.
Top
Remarks

This abstract class provides the base functionality for all DataGrid columns.

Version Information

.NET Framework

Supported in: 4.6, 4.5, 4

.NET Framework Client Profile

Supported in: 4
Platforms

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

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.