DataGridTextColumn Class

 

Represents a DataGrid column that hosts textual 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.DataGridBoundColumn
          System.Windows.Controls.DataGridTextColumn

public class DataGridTextColumn : DataGridBoundColumn

NameDescription
System_CAPS_pubmethodDataGridTextColumn()

Initializes a new instance of the DataGridTextColumn 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_pubpropertyBinding

Gets or sets the binding that associates the column with a property in the data source.(Inherited from DataGridBoundColumn.)

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_pubpropertyCellStyle

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

System_CAPS_pubpropertyClipboardContentBinding

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

System_CAPS_protpropertyDataGridOwner

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

System_CAPS_pubpropertySystem_CAPS_staticDefaultEditingElementStyle

The default value of the EditingElementStyle property.

System_CAPS_pubpropertySystem_CAPS_staticDefaultElementStyle

The default value of the ElementStyle property.

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_pubpropertyEditingElementStyle

Gets or sets the style that is used when rendering the element that the column displays for a cell in editing mode.(Inherited from DataGridBoundColumn.)

System_CAPS_pubpropertyElementStyle

Gets or sets the style that is used when rendering the element that the column displays for a cell that is not in editing mode.(Inherited from DataGridBoundColumn.)

System_CAPS_pubpropertyFontFamily

Gets or sets the font family for the content of cells in the column.

System_CAPS_pubpropertyFontSize

Gets or sets the font size for the content of cells in the column.

System_CAPS_pubpropertyFontStyle

Gets or sets the font style for the content of cells in the column.

System_CAPS_pubpropertyFontWeight

Gets or sets the font weight for the content of cells in the column.

System_CAPS_pubpropertyForeground

Gets or sets the Brush that is used to paint the text contents of cells in the column.

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 column cell being edited to revert to the specified value.(Overrides DataGridColumn.CancelCellEdit(FrameworkElement, Object).)

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 the edit mode.(Overrides DataGridColumn.CommitCellEdit(FrameworkElement).)

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 a TextBox control that is bound to the column's Binding property value.(Overrides DataGridColumn.GenerateEditingElement(DataGridCell, Object).)

System_CAPS_protmethodGenerateElement(DataGridCell, Object)

Gets a read-only TextBlock control 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_protmethodOnBindingChanged(BindingBase, BindingBase)

Notifies the DataGrid when the value of the Binding property changes.(Inherited from DataGridBoundColumn.)

System_CAPS_protmethodOnCoerceIsReadOnly(Boolean)

Determines the value of the IsReadOnly property based on property rules from the data grid that contains this column.(Inherited from DataGridBoundColumn.)

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)

Called when a cell in the column enters editing mode.(Overrides DataGridColumn.PrepareCellForEdit(FrameworkElement, RoutedEventArgs).)

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 column property value change.(Overrides DataGridBoundColumn.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_staticFontFamilyProperty

Identifies the FontFamily dependency property.

System_CAPS_pubfieldSystem_CAPS_staticFontSizeProperty

Identifies the FontSize dependency property.

System_CAPS_pubfieldSystem_CAPS_staticFontStyleProperty

Identifies the FontStyle dependency property.

System_CAPS_pubfieldSystem_CAPS_staticFontWeightProperty

Identifies the FontWeight dependency property.

System_CAPS_pubfieldSystem_CAPS_staticForegroundProperty

Identifies the Foreground 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.)

Use DataGridTextColumn to display columns of data as text. The following illustration shows an example of two DataGridTextColumn types.

Two DataGridTextColumns

To create a column, add it to the Columns collection. To populate the column, bind the column to the data by using the Binding property. The Binding property is applied to the TextBlock or TextBox element created in the column. The DataContext for the element in each cell is the data item for the row the cell is in. Therefore, to set up the binding you only have to set the Binding.Path. Optionally, you can specify a Binding.Converter if you want to convert the data or the StringFormat. For more information about data binding, see Data Binding (WPF).

Note   DataGridTextColumn creates a TextBlock element in the non-editing mode and a TextBox element in the editing mode.

You can customize the DataGridTextColumn by setting properties, such as Width, Header, FontSize, and IsReadOnly.

If you want to display other types of data, DataGrid provides the following column types:

Column Type

Data Display

DataGridHyperlinkColumn

Use to display URI data.

DataGridComboBoxColumn

Use to display enumeration data.

DataGridCheckBoxColumn

Use to display Boolean data.

If you want to use other controls in your DataGrid, you can create your own column types by using DataGridTemplateColumn.

The following example creates a DataGrid that has customized text columns and uses XML data as the source. The illustration earlier in this topic shows how this code is displayed. For more information about binding to XML data, see How to: Bind to XML Data Using an XMLDataProvider and XPath Queries.

<Window.Resources>
    <XmlDataProvider x:Key="customerdata" Source="customers.xml" XPath="Data" />
</Window.Resources>
<Grid>
    <DataGrid AutoGenerateColumns="False" ItemsSource="{Binding Source={StaticResource customerdata}, XPath=Customer}">
        <DataGrid.Columns>
            <DataGridTextColumn Header="First Name" Binding="{Binding XPath=@FirstName}" FontFamily="Arial" FontStyle="Italic" />
            <DataGridTextColumn Header="Last Name" Binding="{Binding XPath=@LastName}" FontFamily="Arial" FontWeight="Bold" />
        </DataGrid.Columns>
    </DataGrid>
</Grid>

.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: