This documentation is archived and is not being maintained.

GridView Class

Represents a view mode that displays data items in columns for a ListView control.

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

[StyleTypedPropertyAttribute(Property = "ColumnHeaderContainerStyle", StyleTargetType = typeof(GridViewColumnHeader))]
public class GridView : ViewBase, IAddChild

The GridView type exposes the following members.

Public methodGridViewInitializes a new instance of the GridView class.

Public propertyAllowsColumnReorderGets or sets whether columns in a GridView can be reordered by a drag-and-drop operation.
Public propertyColumnHeaderContainerStyleGets or sets the style to apply to column headers.
Public propertyColumnHeaderContextMenuGets or sets a ContextMenu for the GridView.
Public propertyColumnHeaderStringFormatGets or sets a composite string that specifies how to format the column headers of the GridView if they are displayed as strings.
Public propertyColumnHeaderTemplateGets or sets a template to use to display the column headers.
Public propertyColumnHeaderTemplateSelectorGets or sets the selector object that provides logic for selecting a template to use for each column header.
Public propertyColumnHeaderToolTipGets or sets the content of a tooltip that appears when the mouse pointer pauses over one of the column headers.
Public propertyColumnsGets the collection of GridViewColumn objects that is defined for this GridView.
Protected propertyDefaultStyleKeyGets the reference for the default style for the GridView. (Overrides ViewBase.DefaultStyleKey.)
Public propertyDependencyObjectTypeGets the DependencyObjectType that wraps the CLR type of this instance.  (Inherited from DependencyObject.)
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyStatic memberGridViewItemContainerStyleKeyGets the key that references the style that is defined for each ListViewItem in a GridView.
Public propertyStatic memberGridViewScrollViewerStyleKeyGets the key that references the style that is defined for the ScrollViewer control that encloses the content that is displayed by a GridView.
Public propertyStatic memberGridViewStyleKeyGets the key that references the style that is defined for the GridView.
Public propertyIsSealedGets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject.)
Protected propertyItemContainerDefaultStyleKeyGets the reference to the default style for the container of the data items in the GridView. (Overrides ViewBase.ItemContainerDefaultStyleKey.)

Public attached propertyColumnCollectionGets or sets the attached property that contains the GridViewColumnCollection.

Protected methodAddChildInfrastructure. Adds a GridViewColumn object to a GridView.
Protected methodAddTextInfrastructure. Not supported.
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Protected methodClearItemRemoves all settings, bindings, and styling from a ListViewItem. (Overrides ViewBase.ClearItem(ListViewItem).)
Public methodClearValue(DependencyProperty)Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject.)
Public methodCoerceValueCoerces 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.)
Public methodEqualsDetermines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected methodGetAutomationPeerGets the AutomationPeer implementation for this GridView object. (Overrides ViewBase.GetAutomationPeer(ListView).)
Public methodStatic memberGetColumnCollectionGets the contents of the ColumnCollection attached property.
Public methodGetHashCodeGets a hash code for this DependencyObject. (Inherited from DependencyObject.)
Public methodGetLocalValueEnumeratorCreates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValueReturns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject.)
Public methodInvalidatePropertyRe-evaluates the effective value for the specified dependency property (Inherited from DependencyObject.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnPropertyChangedInvoked 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 methodPrepareItemPrepares a ListViewItem for display according to the definition of this GridView object. (Overrides ViewBase.PrepareItem(ListViewItem).)
Public methodReadLocalValueReturns the local value of a dependency property, if it exists. (Inherited from DependencyObject.)
Public methodStatic memberSetColumnCollectionSets the contents of the ColumnCollection attached property.
Public methodSetCurrentValueSets the value of a dependency property without changing its value source. (Inherited from DependencyObject.)
Public methodSetValue(DependencyProperty, Object)Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject.)
Public methodStatic memberShouldSerializeColumnCollectionDetermines whether to serialize the ColumnCollection attached property.
Protected methodShouldSerializePropertyReturns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject.)
Public methodToStringReturns the string representation of the GridView object. (Overrides Object.ToString().)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)

Public fieldStatic memberAllowsColumnReorderPropertyIdentifies the AllowsColumnReorder dependency property.
Public fieldStatic memberColumnCollectionPropertyIdentifies the ColumnCollectionProperty attachedproperty.
Public fieldStatic memberColumnHeaderContainerStylePropertyIdentifies the ColumnHeaderContainerStyle dependency property.
Public fieldStatic memberColumnHeaderContextMenuPropertyIdentifies the ColumnHeaderContextMenu dependency property.
Public fieldStatic memberColumnHeaderStringFormatPropertyIdentifies the ColumnHeaderStringFormat dependency property.
Public fieldStatic memberColumnHeaderTemplatePropertyIdentifies the ColumnHeaderTemplate dependency property.
Public fieldStatic memberColumnHeaderTemplateSelectorPropertyIdentifies the ColumnHeaderTemplateSelector dependency property.
Public fieldStatic memberColumnHeaderToolTipPropertyIdentifies the ColumnHeaderToolTip dependency property.

Explicit interface implemetationPrivate methodIAddChild.AddChildInfrastructure. Adds a child object.
Explicit interface implemetationPrivate methodIAddChild.AddTextInfrastructure. Adds the text content of a node to the object.

The GridView class and its supporting classes provide the infrastructure to display data items that are specified for a ListView control in a series of columns. The columns have column headers, which are buttons that are derived from ButtonBase, and you can reorder the columns by using drag-and-drop operations. Note that the columns of a GridView display data and do not provide direct access to the source of the data.

To specify a GridView as the view mode for a ListView, set the View property to a GridView object.

The GridView class is derived from ViewBase. You can define custom views by inheriting from the ViewBase class that provides the supporting elements for a view. For more information, see How to: Create a Custom View Mode for a ListView.

The following illustration shows an example of a ListView that uses a GridView.

ListView with GridView output

The columns in a GridView are defined as GridViewColumn objects. In Extensible Application Markup Language (XAML), you can define GridViewColumn objects as child elements of the GridView. In code, you can add a GridViewColumn to the GridView by using the Columns property and the Add method that is defined for the Collection<T> class. Similarly, you can use other Collection<T> methods such as Remove and Insert to modify the columns in a GridView.

The following example shows how to define the columns of a GridView.

            GridView myGridView = new GridView();
            myGridView.AllowsColumnReorder = true; 
            myGridView.ColumnHeaderToolTip = "Employee Information";

            GridViewColumn gvc1 = new GridViewColumn();
            gvc1.DisplayMemberBinding = new Binding("FirstName");
            gvc1.Header = "FirstName";
            gvc1.Width = 100;
            GridViewColumn gvc2 = new GridViewColumn();
            gvc2.DisplayMemberBinding = new Binding("LastName");
            gvc2.Header = "Last Name";
            gvc2.Width = 100;
            GridViewColumn gvc3 = new GridViewColumn();
            gvc3.DisplayMemberBinding = new Binding("EmployeeNumber");
            gvc3.Header = "Employee No.";
            gvc3.Width = 100;

          <GridView AllowsColumnReorder="true"
                    ColumnHeaderToolTip="Employee Information">

            <GridViewColumn DisplayMemberBinding=
                                "{Binding Path=FirstName}" 
                            Header="First Name" Width="100"/>

                        <GridViewColumn DisplayMemberBinding=
                                "{Binding Path=LastName}" 
                            <GridViewColumnHeader>Last Name
                                <ContextMenu  MenuItem.Click="LastNameCM_Click"  
                                    <MenuItem Header="Ascending" />
                                    <MenuItem Header="Descending" />

                        <GridViewColumn DisplayMemberBinding=
                                "{Binding Path=EmployeeNumber}" 
                            Header="Employee No." Width="100"/>

To style the rows in a GridView, define a style for the ListViewItem controls in the ListView.

To add visual elements, such as a CheckBox or Button control, to a GridView, use templates or styles. For an example, see How to: Create ListViewItems with a CheckBox.

The following example shows how to define a ListView control that implements a GridView as its View.

  <ListView ItemsSource="{Binding Source={StaticResource EmployeeData}, 
      <GridViewColumn Header="First Name" 
                      DisplayMemberBinding="{Binding XPath=FirstName}" />
      <GridViewColumn Header="Last Name" 
                      DisplayMemberBinding="{Binding XPath=LastName}" />
      <GridViewColumn Header="Favorite City"
                      DisplayMemberBinding="{Binding XPath=FavoriteCity}"/>

More Code

How to: Display ListView Contents by Using a GridViewThis example shows how to define a GridView view mode for a ListView control.
How to: Use Templates to Style a ListView That Uses GridViewThis example shows how to use the DataTemplate and Style objects to specify the appearance of a ListView control that uses a GridView view mode.
How to: Sort a GridView Column When a Header Is ClickedThis example shows how to create a ListView control that implements a GridView view mode and sorts the data content when a user clicks a column header.
How to: Create a Custom View Mode for a ListViewThis example shows how to create a custom View mode for a ListView control.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.