This topic has not yet been rated - Rate this topic

DataGridColumn Class

Represents a DataGrid column.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
public abstract class DataGridColumn : DependencyObject

The DataGridColumn type exposes the following members.

  Name Description
Protected method DataGridColumn Initializes a new instance of the DataGridColumn class.
Top
  Name Description
Public property ActualWidth Gets the current width of the column, in device-independent units (1/96th inch per unit).
Public property CanUserReorder Gets or sets a value that indicates whether the user can change the column display position by dragging the column header.
Public property CanUserResize Gets or sets a value that indicates whether the user can adjust the column width by using the mouse.
Public property CanUserSort Gets or sets a value that indicates whether the user can sort the column by clicking the column header.
Public property CellStyle Gets or sets the style that is used to render cells in the column.
Public property ClipboardContentBinding Gets or sets the binding object to use when getting or setting cell content for the clipboard.
Protected property DataGridOwner Gets the DataGrid control that contains this column.
Public property DependencyObjectType Gets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property DisplayIndex Gets or sets the display position of the column relative to the other columns in the DataGrid.
Public property DragIndicatorStyle Gets or sets the style object to apply to the column header during a drag operation.
Public property Header Gets or sets the content of the column header.
Public property HeaderStringFormat Gets or sets the format pattern to apply to the content of the column header.
Public property HeaderStyle Gets or sets the style that is used when rendering the column header.
Public property HeaderTemplate Gets or sets the template that defines the visual representation of the column header.
Public property HeaderTemplateSelector Gets or sets the object that selects which template to use for the column header.
Public property IsAutoGenerated Gets a value that indicates whether the column is auto-generated.
Public property IsFrozen Gets a value that indicates whether the column is prevented from scrolling horizontally.
Public property IsReadOnly Gets or sets a value that indicates whether cells in the column can be edited.
Public property IsSealed Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Public property MaxWidth Gets or sets the maximum width constraint of the column.
Public property MinWidth Gets or sets the minimum width constraint of the column.
Public property SortDirection Gets or sets the sort direction (ascending or descending) of the column.
Public property SortMemberPath Gets or sets a property name, or a period-delimited hierarchy of property names, that indicates the member to sort by.
Public property Visibility Gets or sets the visibility of the column.
Public property Width Gets or sets the column width or automatic sizing mode.
Top
  Name Description
Protected method CancelCellEdit Causes the cell being edited to revert to the original, unedited value.
Public method CheckAccess Determines 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 CoerceValue 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.)
Protected method CommitCellEdit Performs any required validation before exiting cell editing mode.
Public method Equals Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GenerateEditingElement When overridden in a derived class, gets an editing element that is bound to the Binding property value of the column.
Protected method GenerateElement When 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 GetHashCode Gets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public method GetLocalValueEnumerator Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public method InvalidateProperty Re-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method NotifyPropertyChanged Notifies the DataGrid that contains this column that a column property has changed.
Protected method OnCoerceIsReadOnly Determines the value of the IsReadOnly property based on the property rules of the DataGrid that contains this column.
Public method OnCopyingCellClipboardContent Raises the CopyingCellClipboardContent event.
Public method OnPastingCellClipboardContent Raises the PastingCellClipboardContent event.
Protected method OnPropertyChanged 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.)
Protected method PrepareCellForEdit When overridden in a derived class, sets cell content as needed for editing.
Public method ReadLocalValue Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Protected method RefreshCellContent When 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 SetCurrentValue Sets 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 ShouldSerializeProperty Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  Name Description
Public event CopyingCellClipboardContent Occurs after the cell clipboard content is prepared.
Public event PastingCellClipboardContent Occurs before the clipboard content is moved to the cell.
Top
  Name Description
Public field Static member ActualWidthProperty Identifies the ActualWidth dependency property.
Public field Static member CanUserReorderProperty Identifies the CanUserReorder dependency property.
Public field Static member CanUserResizeProperty Identifies the CanUserResize dependency property.
Public field Static member CanUserSortProperty Identifies the CanUserSort dependency property.
Public field Static member CellStyleProperty Identifies the CellStyle dependency property.
Public field Static member DisplayIndexProperty Identifies the DisplayIndex dependency property.
Public field Static member DragIndicatorStyleProperty Identifies the DragIndicatorStyle dependency property.
Public field Static member HeaderProperty Identifies the Header dependency property.
Public field Static member HeaderStringFormatProperty Identifies the HeaderStringFormat dependency property.
Public field Static member HeaderStyleProperty Identifies the HeaderStyle dependency property.
Public field Static member HeaderTemplateProperty Identifies the HeaderTemplate dependency property.
Public field Static member HeaderTemplateSelectorProperty Identifies the HeaderTemplateSelector dependency property.
Public field Static member IsAutoGeneratedProperty Identifies the IsAutoGenerated dependency property.
Public field Static member IsFrozenProperty Identifies the IsFrozen dependency property.
Public field Static member IsReadOnlyProperty Identifies the IsReadOnly dependency property.
Public field Static member MaxWidthProperty Identifies the MaxWidth dependency property.
Public field Static member MinWidthProperty Identifies the MinWidth dependency property.
Public field Static member SortDirectionProperty Identifies the SortDirection dependency property.
Public field Static member SortMemberPathProperty Identifies the SortMemberPath dependency property.
Public field Static member VisibilityProperty Identifies the Visibility dependency property.
Public field Static member WidthProperty Identifies the Width dependency property.
Top

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

.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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ