DataGridContext Class

In This Topic

Class that the provides contextual information on, and access to, items contained in a grid or detail.

Syntax

Visual Basic
C#

'Declaration
 
<TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
<NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
Public NotInheritable Class DataGridContext 
   Inherits System.Windows.DependencyObject

'Usage
 
Dim instance As DataGridContext

[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
public sealed class DataGridContext : System.Windows.DependencyObject

Remarks

The data-grid context of a grid always exists; however, detail contexts are created and exist only when they are expanded and will be destroyed when a detail is collapsed. A data-grid context's HasDetails property can be queried to determine if it has details; however, it does not indicate whether the details are expanded and consequently have a context. To know if the details of a specific data item are expanded and therefore have a context, the AreDetailsExpanded method can be used.

Example

All examples in this topic assume that the grid is bound to the Employees table of the Northwind database, unless stated otherwise.

The following example demonstrates how to provide a default detail configuration that will be applied to all details in a grid and any descendant details for which an explicit detail configuration has not been provided.The following example demonstrates how to retrieve the child contexts of the master data items and collapse any expanded details using the CollapseDetail method.The next example provides the implementation of the button's Click event.The next example provides the implementation of the button's Click event.

XAML
XAML
Visual Basic
C#

<Grid>
  <Grid.Resources>
     <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                        Source="{Binding Source={x:Static Application.Current}, Path=Employees}" />
   
     <xcdg:IndexToOddConverter x:Key="rowIndexConverter" />
   
     <Style x:Key="alternatingDataRowStyle"
            TargetType="{x:Type xcdg:DataRow}">
        <Style.Triggers>
           <DataTrigger Binding="{Binding RelativeSource={RelativeSource Self},
                             Path=(xcdg:DataGridVirtualizingPanel.ItemIndex),
                             Converter={StaticResource rowIndexConverter}}"
                        Value="True">
              <Setter Property="Background"
                      Value="AliceBlue" />
           </DataTrigger>
        </Style.Triggers>
     </Style>
 
  </Grid.Resources>
  <xcdg:DataGridControl x:Name="EmployeesGrid"
                      ItemsSource="{Binding Source={StaticResource cvs_employees}}"
                      ItemsSourceName="Employee Information"
                      AutoCreateDetailConfigurations="True">
    <xcdg:DataGridControl.DefaultDetailConfiguration>
       <xcdg:DefaultDetailConfiguration UseDefaultHeadersFooters="False"
                                        ItemContainerStyle="{StaticResource alternatingDataRowStyle}"
                                        xcdg:TableView.ShowFixedColumnSplitter="False">
          <xcdg:DefaultDetailConfiguration.DefaultGroupConfiguration>
             <xcdg:GroupConfiguration InitiallyExpanded="False" />
          </xcdg:DefaultDetailConfiguration.DefaultGroupConfiguration>
          <xcdg:DefaultDetailConfiguration.Headers>
             <DataTemplate>
                <DockPanel>
                   <xcdg:HierarchicalGroupLevelIndicatorPane  xcdg:GroupLevelIndicatorPane.ShowIndicators="False"
                                                              xcdg:TableView.CanScrollHorizontally="False"
                                                              DockPanel.Dock="Left" />
                   <ContentPresenter Content="{Binding RelativeSource={RelativeSource Self},
                                     Path=(xcdg:DataGridControl.DataGridContext).SourceDetailConfiguration.Title}"
                             ContentTemplate="{Binding RelativeSource={RelativeSource Self},
                             Path=(xcdg:DataGridControl.DataGridContext).SourceDetailConfiguration.TitleTemplate}" />
                </DockPanel>
             </DataTemplate>
             <DataTemplate>
                <xcdg:ColumnManagerRow AllowColumnReorder="False"
                                       AllowSort="False" />
             </DataTemplate>
          </xcdg:DefaultDetailConfiguration.Headers>
          <xcdg:DefaultDetailConfiguration.Footers>
             <DataTemplate>
                <xcdg:InsertionRow Background="Cornsilk" />
             </DataTemplate>
          </xcdg:DefaultDetailConfiguration.Footers>
          <xcdg:DefaultDetailConfiguration.DetailIndicatorStyle>
             <Style TargetType="{x:Type xcdg:DetailIndicator}">
                <Setter Property="Background"
                        Value="AliceBlue" />
             </Style>
          </xcdg:DefaultDetailConfiguration.DetailIndicatorStyle>
       </xcdg:DefaultDetailConfiguration>
    </xcdg:DataGridControl.DefaultDetailConfiguration>
 </xcdg:DataGridControl>
</Grid>

<Grid>
  <Grid.Resources>
     <xcdg:DataGridCollectionViewSource x:Key="cvs_employees"
                                        Source="{Binding Source={x:Static Application.Current},
                                                         Path=Employees}"/>
 
  </Grid.Resources>
 
  <DockPanel>
     <Button Content="Collapse All Details"
             Click="Button_Click"
             DockPanel.Dock="Top"/>
     <xcdg:DataGridControl x:Name="EmployeesGrid"
                           ItemsSource="{Binding Source={StaticResource cvs_employees}}"
                           ItemsSourceName="Order Information"
                           AutoCreateDetailConfigurations="True"/>
  </DockPanel>
</Grid>

Private Sub Button_Click( ByVal sender As Object, ByVal e As RoutedEventArgs )
  DataGridContext rootContext = DataGridControl.GetDataGridContext( this.EmployeesGrid );

  Dim childContexts As New List( Of DataGridContext)( Me.EmployeesGrid.GetChildContexts() )

  Dim context As DataGridContext
  For Each context In childContexts
    context.ParentDataGridContext.CollapseDetails( context.ParentItem )
  Next context
End Sub

private void Button_Click( object sender, RoutedEventArgs e )
{
 DataGridContext rootContext = DataGridControl.GetDataGridContext( this.EmployeesGrid );

 List<DataGridContext> childContexts = new List<DataGridContext>( this.EmployeesGrid.GetChildContexts() );

 foreach( DataGridContext context in childContexts )
 {
   context.ParentDataGridContext.CollapseDetails( context.ParentItem );
 }     
}

Inheritance Hierarchy

System.Object
   System.Windows.Threading.DispatcherObject
      System.Windows.DependencyObject
         Xceed.Wpf.DataGrid.DataGridContext

Public Properties

	Name	Description
	AllowDetailToggle	Gets a value indicating whether the end user can toggle the expansion state of details in the context.
	AutoFilterValues	Gets a dictionary that contains a list of the context's DataGridItemProperty objects with their corresponding auto-filter values.
	ColumnChooserColumns	Gets a collection of the columns whose titles are displayed in the column-chooser context menu.
	Columns	Gets a list of the columns contained in the context.
	CurrentColumn	Gets or sets the context's current column.
	CurrentItem	Gets or sets the context's current data item.
	CurrentItemIndex	Gets or sets the index of the context's current data item.
	DataGridControl	Gets the context's parent DataGridControl.
	DefaultGroupConfiguration	Gets the default configuration that will be used by any groups in the context for which an explicit group configuration is not provided.
	DependencyObjectType	(Inherited from System.Windows.DependencyObject)
	DetailConfigurations	Gets a list of the configurations that will be applied to their corresponding details.
	Dispatcher	(Inherited from System.Windows.Threading.DispatcherObject)
	DistinctValues	Gets a dictionary that contains a list of the context's DataGridItemProperty objects with their corresponding distinct values.
	Footers	Gets a collection that contains the items that are located in the footer section of the context.
	GroupConfigurationSelector	Gets a group-configuration selector that will be used to select the appropriate configuration for a group in the context based on its information and/or content.
	GroupLevelDescriptions	Gets a collection of GroupLevelDescription objects that contain information on each group level contained in the context.
	HasDetails	Gets a value indicating whether the context has details.
	Headers	Gets a collection that contains the items that are located in the header section of the context.
	IsCurrent	Gets a value indicating whether the context is current.
	IsSealed	(Inherited from System.Windows.DependencyObject)
	ItemContainerStyle	Gets the style that is applied to the container element (DataRow) generated for each item in the context.
	ItemContainerStyleSelector	Gets a style selector that selects the appropriate style to apply to each generated container element (DataRow) in the context.
	Items	Gets the collection view that was used to generate the content of the context.
	MaxGroupLevels	Gets a value indicating the maximum number of group levels that can be created.
	MaxSortLevels	Gets a value indicating the maximum number of sort levels that can be created.
	MergedHeaders	Gets a list of the merged column headers in the context.
	ParentDataGridContext	Gets the context's parent DataGridContext.
	ParentItem	Gets the parent data item to which the context belongs
	SelectedCellRanges	Gets the cell ranges selected in the data context.
	SelectedItemRanges	Gets the data item ranges selected in the data context.
	SelectedItems	Gets a collection of data items that are currently selected in the context.
	SourceDetailConfiguration	Gets the detail configuration that was applied to the detail that is the source of the context.
	StatCellConfigurations	Gets the collection of StatCellConfiguration for a DataGridContext (that is a Detail or a Master).
	VisibleColumns	Gets a list of the columns in the context whose Visible property is true, ordered according to their VisiblePosition.

Top

Public Methods

	Name	Description
	AreDetailsExpanded	Retrieves a value indicating whether the details for the specified data item are expanded.
	BeginEdit	Overloaded. Places the context's current item in edit mode.
	CancelEdit	Cancels the edit process of the item that is being edited.
	ClearValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	CoerceValue	(Inherited from System.Windows.DependencyObject)
	CollapseDetails	Collapses the details owned by the specified data item.
	CollapseGroup	Collapses the specified group.
	DeferColumnsUpdate	Enters a defer cycle that can be used to merge column reordering and visibility changes and delay automatic refresh.
	EndEdit	Ends the edit process of the item that is being edited.
	Equals	(Inherited from System.Windows.DependencyObject)
	ExpandDetails	Expands any details owned by the specified data item.
	ExpandGroup	Expands the specified group.
	GetChildContext	Overloaded. Retrieves the child DataGridContext created from the specified DetailConfiguration of an item.
	GetChildContexts	Retrieves the child DataGridContexts of the context.
	GetContainerFromItem	Retrieves the container of the specified item.
	GetGroupFromCollectionViewGroup	Retrieves the group for the specified CollectionViewGroup.
	GetHashCode	(Inherited from System.Windows.DependencyObject)
	GetItemFromContainer	Retrieves an item for the specified container.
	GetLocalValueEnumerator	(Inherited from System.Windows.DependencyObject)
	GetParentGroupFromItem	Retrieves the parent group for the specified item.
	GetValue	(Inherited from System.Windows.DependencyObject)
	InvalidateProperty	(Inherited from System.Windows.DependencyObject)
	IsGroupExpanded	Retrieves a value indicating whether the specified group is expanded.
	MoveColumnAfter	Moves the first column immediately after the second.
	MoveColumnBefore	Moves the first column immediately before the second.
	MoveColumnUnder	Moves the specified current column under the specified parent column.
	ReadLocalValue	(Inherited from System.Windows.DependencyObject)
	SetCurrentValue	(Inherited from System.Windows.DependencyObject)
	SetValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	ToggleDetailExpansion	Toggles any details owned by the specified data item.
	ToggleGroupExpansion	Toggles the specified group.