using System; using System.Collections.Generic; using System.Diagnostics; using System.Windows.Automation; using System.Windows.Automation.Peers; using System.Windows.Automation.Provider; using System.Windows.Controls; using System.Windows.Media; using EGC = ExtendedGrid.Microsoft.Windows.Controls; namespace ExtendedGrid.Microsoft.Windows.Controls { /// /// AutomationPeer for DataGrid /// Supports Grid, Table, Selection and Scroll patters /// public sealed class DataGridAutomationPeer : FrameworkElementAutomationPeer, IGridProvider, ISelectionProvider, ITableProvider { #region Constructors /// /// Default contructor /// /// DataGrid public DataGridAutomationPeer(EGC.DataGrid owner) : base(owner) { if (owner == null) { throw new ArgumentNullException("owner"); } } #endregion #region AutomationPeer Overrides /// /// Gets the control type for the element that is associated with the UI Automation peer. /// /// The control type. protected override AutomationControlType GetAutomationControlTypeCore() { return AutomationControlType.DataGrid; } /// /// Called by GetClassName that gets a human readable name that, in addition to AutomationControlType, /// differentiates the control represented by this AutomationPeer. /// /// The string that contains the name. protected override string GetClassNameCore() { return Owner.GetType().Name; } /// /// Gets the control pattern that is associated with the specified System.Windows.Automation.Peers.PatternInterface. /// /// A value from the System.Windows.Automation.Peers.PatternInterface enumeration. /// The object that supports the specified pattern, or null if unsupported. public override object GetPattern(PatternInterface patternInterface) { switch (patternInterface) { case PatternInterface.Grid: case PatternInterface.Selection: case PatternInterface.Table: return this; case PatternInterface.Scroll: { ScrollViewer scrollViewer = this.OwningDataGrid.InternalScrollHost; if (scrollViewer != null) { AutomationPeer scrollPeer = UIElementAutomationPeer.CreatePeerForElement(scrollViewer); IScrollProvider scrollProvider = scrollPeer as IScrollProvider; if (scrollPeer != null && scrollProvider != null) { scrollPeer.EventsSource = this; return scrollProvider; } } break; } } return base.GetPattern(patternInterface); } #endregion #region IGridProvider int IGridProvider.ColumnCount { get { return this.OwningDataGrid.Columns.Count; } } int IGridProvider.RowCount { get { return this.OwningDataGrid.Items.Count; } } IRawElementProviderSimple IGridProvider.GetItem(int row, int column) { if (row >= 0 && row < this.OwningDataGrid.Items.Count && column >= 0 && column < this.OwningDataGrid.Columns.Count) { object item = this.OwningDataGrid.Items[row]; EGC.DataGridColumn dataGridColumn = this.OwningDataGrid.Columns[column]; this.OwningDataGrid.ScrollIntoView(item, dataGridColumn); this.OwningDataGrid.UpdateLayout(); EGC.DataGridItemAutomationPeer itemPeer = this.GetOrCreateItemPeer(item); if (itemPeer != null) { EGC.DataGridCellItemAutomationPeer cellItemPeer = itemPeer.GetOrCreateCellItemPeer(dataGridColumn); if (cellItemPeer != null) { return ProviderFromPeer(cellItemPeer); } } } return null; } #endregion #region ISelectionProvider IRawElementProviderSimple[] ISelectionProvider.GetSelection() { List selectedProviders = new List(); switch (this.OwningDataGrid.SelectionUnit) { case EGC.DataGridSelectionUnit.Cell: { AddSelectedCells(selectedProviders); break; } case EGC.DataGridSelectionUnit.FullRow: { AddSelectedRows(selectedProviders); break; } case EGC.DataGridSelectionUnit.CellOrRowHeader: { AddSelectedRows(selectedProviders); AddSelectedCells(selectedProviders); break; } default: { Debug.Assert(false); break; } } return selectedProviders.ToArray(); } bool ISelectionProvider.CanSelectMultiple { get { return this.OwningDataGrid.SelectionMode == EGC.DataGridSelectionMode.Extended; } } bool ISelectionProvider.IsSelectionRequired { get { return false; } } #endregion #region ITableProvider RowOrColumnMajor ITableProvider.RowOrColumnMajor { get { return RowOrColumnMajor.RowMajor; } } IRawElementProviderSimple[] ITableProvider.GetColumnHeaders() { if ((this.OwningDataGrid.HeadersVisibility & EGC.DataGridHeadersVisibility.Column) == EGC.DataGridHeadersVisibility.Column) { List providers = new List(); EGC.DataGridColumnHeadersPresenter dataGridColumnHeadersPresenter = this.OwningDataGrid.ColumnHeadersPresenter; for (int i = 0; i < this.OwningDataGrid.Columns.Count; i++) { EGC.DataGridColumnHeader dataGridColumnHeader = dataGridColumnHeadersPresenter.ItemContainerGenerator.ContainerFromIndex(i) as EGC.DataGridColumnHeader; if (dataGridColumnHeader != null) { AutomationPeer peer = CreatePeerForElement(dataGridColumnHeader); if (peer != null) { providers.Add(ProviderFromPeer(peer)); } } } if (providers.Count > 0) { return providers.ToArray(); } } return null; } // Row virtualization does not allow us to enumerate all the row headers because // Their visual and bindings cannot be predicted before the row is devirtualized // This method will return only the list of devirtualized rows headers. IRawElementProviderSimple[] ITableProvider.GetRowHeaders() { if ((this.OwningDataGrid.HeadersVisibility & EGC.DataGridHeadersVisibility.Row) == EGC.DataGridHeadersVisibility.Row) { List providers = new List(); foreach (object item in this.OwningDataGrid.Items) { EGC.DataGridItemAutomationPeer dataGridItemAutomationPeer = GetOrCreateItemPeer(item); AutomationPeer rowHeaderAutomationPeer = dataGridItemAutomationPeer.RowHeaderAutomationPeer; if (rowHeaderAutomationPeer != null) { providers.Add(ProviderFromPeer(rowHeaderAutomationPeer)); } } if (providers.Count > 0) { return providers.ToArray(); } } return null; } #endregion #region Private Helpers private EGC.DataGrid OwningDataGrid { get { return (EGC.DataGrid)Owner; } } // Return a list of automation peer corresponding to all rows in the DataGrid // Called from DataGridRowsPresenterAutomationPeer.GetChildrenCore to populate its children internal List GetItemPeers() { List peers = new List(); Dictionary oldChildren = new Dictionary(_itemPeers); _itemPeers.Clear(); foreach (object item in this.OwningDataGrid.Items) { EGC.DataGridItemAutomationPeer peer = null; bool peerExists = oldChildren.TryGetValue(item, out peer); if (!peerExists || peer == null) { peer = new EGC.DataGridItemAutomationPeer(item, this.OwningDataGrid); } peers.Add(peer); _itemPeers.Add(item, peer); } return peers; } // Return automation peer corresponding to the row data item internal EGC.DataGridItemAutomationPeer GetOrCreateItemPeer(object item) { EGC.DataGridItemAutomationPeer peer = null; bool peerExists = _itemPeers.TryGetValue(item, out peer); if (!peerExists || peer == null) { peer = new EGC.DataGridItemAutomationPeer(item, this.OwningDataGrid); _itemPeers.Add(item, peer); } return peer; } // Private helper returning the automation peer coresponding to cellInfo // Cell can be virtualized private EGC.DataGridCellItemAutomationPeer GetCellItemPeer(EGC.DataGridCellInfo cellInfo) { if (cellInfo.IsValid) { EGC.DataGridItemAutomationPeer dataGridItemAutomationPeer = GetOrCreateItemPeer(cellInfo.Item); if (dataGridItemAutomationPeer != null) { return dataGridItemAutomationPeer.GetOrCreateCellItemPeer(cellInfo.Column); } } return null; } // This method is called from DataGrid.OnSelectedCellsChanged // Raises the selection events when Cell selection changes internal void RaiseAutomationCellSelectedEvent(EGC.SelectedCellsChangedEventArgs e) { // If the result of an AddToSelection or RemoveFromSelection is a single selected cell, // then all we raise is the ElementSelectedEvent for single item if (AutomationPeer.ListenerExists(AutomationEvents.SelectionItemPatternOnElementSelected) && this.OwningDataGrid.SelectedCells.Count == 1 && e.AddedCells.Count == 1) { EGC.DataGridCellItemAutomationPeer cellPeer = GetCellItemPeer(e.AddedCells[0]); if (cellPeer != null) { cellPeer.RaiseAutomationEvent(AutomationEvents.SelectionItemPatternOnElementSelected); } } else { int i; if (AutomationPeer.ListenerExists(AutomationEvents.SelectionItemPatternOnElementAddedToSelection)) { for (i = 0; i < e.AddedCells.Count; i++) { EGC.DataGridCellItemAutomationPeer cellPeer = GetCellItemPeer(e.AddedCells[i]); if (cellPeer != null) { cellPeer.RaiseAutomationEvent(AutomationEvents.SelectionItemPatternOnElementAddedToSelection); } } } if (AutomationPeer.ListenerExists(AutomationEvents.SelectionItemPatternOnElementRemovedFromSelection)) { for (i = 0; i < e.RemovedCells.Count; i++) { EGC.DataGridCellItemAutomationPeer cellPeer = GetCellItemPeer(e.RemovedCells[i]); if (cellPeer != null) { cellPeer.RaiseAutomationEvent(AutomationEvents.SelectionItemPatternOnElementRemovedFromSelection); } } } } } // This method is called from DataGrid.OnBeginningEdit/OnCommittingEdit/OnCancelingEdit // Raises Invoked event when row begin/cancel/commit edit internal void RaiseAutomationRowInvokeEvents(EGC.DataGridRow row) { EGC.DataGridItemAutomationPeer dataGridItemAutomationPeer = GetOrCreateItemPeer(row.Item); if (dataGridItemAutomationPeer != null) { dataGridItemAutomationPeer.RaiseAutomationEvent(AutomationEvents.InvokePatternOnInvoked); } } // This method is called from DataGrid.OnBeginningEdit/OnCommittingEdit/OnCancelingEdit // Raises Invoked event when cell begin/cancel/commit edit internal void RaiseAutomationCellInvokeEvents(EGC.DataGridColumn column, EGC.DataGridRow row) { EGC.DataGridItemAutomationPeer dataGridItemAutomationPeer = GetOrCreateItemPeer(row.Item); if (dataGridItemAutomationPeer != null) { EGC.DataGridCellItemAutomationPeer cellPeer = dataGridItemAutomationPeer.GetOrCreateCellItemPeer(column); if (cellPeer != null) { cellPeer.RaiseAutomationEvent(AutomationEvents.InvokePatternOnInvoked); } } } // This method is called from DataGrid.OnSelectionChanged // Raises the selection events when Items selection changes internal void RaiseAutomationSelectionEvents(SelectionChangedEventArgs e) { // If the result of an AddToSelection or RemoveFromSelection is a single selected item, // then all we raise is the ElementSelectedEvent for single item if (AutomationPeer.ListenerExists(AutomationEvents.SelectionItemPatternOnElementSelected) && this.OwningDataGrid.SelectedItems.Count == 1) { EGC.DataGridItemAutomationPeer peer = GetOrCreateItemPeer(this.OwningDataGrid.SelectedItem); if (peer != null) { peer.RaiseAutomationEvent(AutomationEvents.SelectionItemPatternOnElementSelected); } } else { int i; if (AutomationPeer.ListenerExists(AutomationEvents.SelectionItemPatternOnElementAddedToSelection)) { for (i = 0; i < e.AddedItems.Count; i++) { EGC.DataGridItemAutomationPeer peer = GetOrCreateItemPeer(e.AddedItems[i]); if (peer != null) { peer.RaiseAutomationEvent(AutomationEvents.SelectionItemPatternOnElementAddedToSelection); } } } if (AutomationPeer.ListenerExists(AutomationEvents.SelectionItemPatternOnElementRemovedFromSelection)) { for (i = 0; i < e.RemovedItems.Count; i++) { EGC.DataGridItemAutomationPeer peer = GetOrCreateItemPeer(e.RemovedItems[i]); if (peer != null) { peer.RaiseAutomationEvent(AutomationEvents.SelectionItemPatternOnElementRemovedFromSelection); } } } } } private void AddSelectedCells(List cellProviders) { if (cellProviders == null) { throw new ArgumentNullException("cellProviders"); } // Add selected cells to selection if (this.OwningDataGrid.SelectedCells != null) { foreach (EGC.DataGridCellInfo cellInfo in this.OwningDataGrid.SelectedCells) { EGC.DataGridItemAutomationPeer itemPeer = this.GetOrCreateItemPeer(cellInfo.Item); if (itemPeer != null) { IRawElementProviderSimple provider = ProviderFromPeer(itemPeer.GetOrCreateCellItemPeer(cellInfo.Column)); if (provider != null) { cellProviders.Add(provider); } } } } } private void AddSelectedRows(List itemProviders) { if (itemProviders == null) { throw new ArgumentNullException("itemProviders"); } // Add selected items to selection if (this.OwningDataGrid.SelectedItems != null) { foreach (object item in this.OwningDataGrid.SelectedItems) { IRawElementProviderSimple provider = ProviderFromPeer(GetOrCreateItemPeer(item)); if (provider != null) { itemProviders.Add(provider); } } } } #endregion #region Private Data // Cache items automation peers private Dictionary _itemPeers = new Dictionary(); #endregion } }