DataGridContext Class

In This Topic

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

Object Model

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.

Example

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

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.
	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)
	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.
	ParentDataGridContext	Gets the context's parent DataGridContext.
	ParentItem	This property is not used in the toolkit version of the datagrid control. 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.
	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)
	CollapseGroup
	DeferColumnsUpdate
	EndEdit	Ends the edit process of the item that is being edited.
	Equals	(Inherited from System.Windows.DependencyObject)
	ExpandGroup
	GetChildContext	Retrieves the child DataGridContext created from the detail configuration that has the specified relation name.
	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
	MoveColumnAfter
	MoveColumnBefore
	MoveColumnUnder
	ReadLocalValue	(Inherited from System.Windows.DependencyObject)
	SetCurrentValue	(Inherited from System.Windows.DependencyObject)
	SetValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	ToggleGroupExpansion	Toggles the specified group.

Top

Protected Methods

	Name	Description
	OnPropertyChanged	Overridden.
	ShouldSerializeProperty	(Inherited from System.Windows.DependencyObject)

Top

Extension Methods

	Name	Description
	FindLogicalAncestor<T>	Finds the logical ancenster
	FindLogicalAncestorsAndSelf
	FindLogicalChildren<T>	Find the logical children.
	FindVisualAncestor<T>	Finds the visual ancestor.
	FindVisualChildren<T>	Finds the visual children.
	FindVisualTreeRoot	Finds the visual tree root.
	ShowDialog	Overloaded.

Top

Public Events

	Name	Description
	PropertyChanged	Raised when the value of a property is changed.

Top

Supported Frameworks

.NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

.NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

Reference

DataGridContext Members
Xceed.Wpf.DataGrid Namespace

Send Feedback

Business Suite

Ultimate Suite

Reference