|
//---------------------------------------------------------------------------
//
// <copyright file="GridItemPattern" company="Microsoft">
// Copyright (C) Microsoft Corporation. All rights reserved.
// </copyright>
//
//
// Description: Client-side wrapper for GridItem Pattern
//
// History:
// 06/23/2003 : BrendanM Ported to WCP
//
//---------------------------------------------------------------------------
using System;
using System.Windows.Automation.Provider;
using MS.Internal.Automation;
namespace System.Windows.Automation
{
/// <summary>
/// Allows clients to quickly determine if an item they discover is part
/// of a grid and, if so, where the item is in the grid in terms of row/column coordinates
/// and spans.
/// </summary>
#if (INTERNAL_COMPILE)
internal class GridItemPattern: BasePattern
#else
public class GridItemPattern: BasePattern
#endif
{
//------------------------------------------------------
//
// Constructors
//
//------------------------------------------------------
#region Constructors
internal GridItemPattern(AutomationElement el, SafePatternHandle hPattern, bool cached)
: base(el, hPattern)
{
_hPattern = hPattern;
_cached = cached;
}
#endregion Constructors
//------------------------------------------------------
//
// Public Constants / Readonly Fields
//
//------------------------------------------------------
#region Public Constants and Readonly Fields
/// <summary>GridItem pattern</summary>
public static readonly AutomationPattern Pattern = GridItemPatternIdentifiers.Pattern;
/// <summary>RowCount</summary>
public static readonly AutomationProperty RowProperty = GridItemPatternIdentifiers.RowProperty;
/// <summary>ColumnCount</summary>
public static readonly AutomationProperty ColumnProperty = GridItemPatternIdentifiers.ColumnProperty;
/// <summary>RowSpan</summary>
public static readonly AutomationProperty RowSpanProperty = GridItemPatternIdentifiers.RowSpanProperty;
/// <summary>ColumnSpan</summary>
public static readonly AutomationProperty ColumnSpanProperty = GridItemPatternIdentifiers.ColumnSpanProperty;
/// <summary>The logical element that supports the GripPattern for this Item</summary>
public static readonly AutomationProperty ContainingGridProperty = GridItemPatternIdentifiers.ContainingGridProperty;
#endregion Public Constants and Readonly Fields
//------------------------------------------------------
//
// Public Methods
//
//------------------------------------------------------
#region Public Methods
#endregion Public Methods
//------------------------------------------------------
//
// Public Properties
//
//------------------------------------------------------
#region Public Properties
/// <summary>
/// This member allows access to previously requested
/// cached properties for this element. The returned object
/// has accessors for each property defined for this pattern.
/// </summary>
/// <remarks>
/// Cached property values must have been previously requested
/// using a CacheRequest. If you try to access a cached
/// property that was not previously requested, an InvalidOperation
/// Exception will be thrown.
///
/// To get the value of a property at the current point in time,
/// access the property via the Current accessor instead of
/// Cached.
/// </remarks>
public GridItemPatternInformation Cached
{
get
{
Misc.ValidateCached(_cached);
return new GridItemPatternInformation(_el, true);
}
}
/// <summary>
/// This member allows access to current property values
/// for this element. The returned object has accessors for
/// each property defined for this pattern.
/// </summary>
/// <remarks>
/// This pattern must be from an AutomationElement with a
/// Full reference in order to get current values. If the
/// AutomationElement was obtained using AutomationElementMode.None,
/// then it contains only cached data, and attempting to get
/// the current value of any property will throw an InvalidOperationException.
///
/// To get the cached value of a property that was previously
/// specified using a CacheRequest, access the property via the
/// Cached accessor instead of Current.
/// </remarks>
public GridItemPatternInformation Current
{
get
{
Misc.ValidateCurrent(_hPattern);
return new GridItemPatternInformation(_el, false);
}
}
#endregion Public Properties
//------------------------------------------------------
//
// Internal Methods
//
//------------------------------------------------------
#region Internal Methods
internal static object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached)
{
return new GridItemPattern(el, hPattern, cached);
}
#endregion Internal Methods
//------------------------------------------------------
//
// Private Fields
//
//------------------------------------------------------
#region Private Fields
private SafePatternHandle _hPattern;
internal bool _cached; // internal, since protected makes this publically visible
#endregion Private Fields
//------------------------------------------------------
//
// Nested Classes
//
//------------------------------------------------------
#region Nested Classes
/// <summary>
/// This class provides access to either Cached or Current
/// properties on a pattern via the pattern's .Cached or
/// .Current accessors.
/// </summary>
public struct GridItemPatternInformation
{
//------------------------------------------------------
//
// Constructors
//
//------------------------------------------------------
#region Constructors
internal GridItemPatternInformation(AutomationElement el, bool useCache)
{
_el = el;
_useCache = useCache;
}
#endregion Constructors
//------------------------------------------------------
//
// Public Properties
//
//------------------------------------------------------
#region Public Properties
/// <summary>
/// the row number of the element. This is zero based.
/// </summary>
///
/// <outside_see conditional="false">
/// This API does not work inside the secure execution environment.
/// <exception cref="System.Security.Permissions.SecurityPermission"/>
/// </outside_see>
public int Row
{
get
{
return (int)_el.GetPatternPropertyValue(RowProperty, _useCache);
}
}
/// <summary>
/// the column number of the element. This is zero based.
/// </summary>
///
/// <outside_see conditional="false">
/// This API does not work inside the secure execution environment.
/// <exception cref="System.Security.Permissions.SecurityPermission"/>
/// </outside_see>
public int Column
{
get
{
return (int)_el.GetPatternPropertyValue(ColumnProperty, _useCache);
}
}
/// <summary>
/// count of how many rows the element spans
/// -- non merged cells should always return 1
/// </summary>
///
/// <outside_see conditional="false">
/// This API does not work inside the secure execution environment.
/// <exception cref="System.Security.Permissions.SecurityPermission"/>
/// </outside_see>
public int RowSpan
{
get
{
return (int)_el.GetPatternPropertyValue(RowSpanProperty, _useCache);
}
}
/// <summary>
/// count of how many columns the element spans
/// -- non merged cells should always return 1
///</summary>
///
/// <outside_see conditional="false">
/// This API does not work inside the secure execution environment.
/// <exception cref="System.Security.Permissions.SecurityPermission"/>
/// </outside_see>
public int ColumnSpan
{
get
{
return (int)_el.GetPatternPropertyValue(ColumnSpanProperty, _useCache);
}
}
/// <summary>
/// The logical element that supports the GripPattern for this Item
///</summary>
///
/// <outside_see conditional="false">
/// This API does not work inside the secure execution environment.
/// <exception cref="System.Security.Permissions.SecurityPermission"/>
/// </outside_see>
public AutomationElement ContainingGrid
{
get
{
return (AutomationElement)_el.GetPatternPropertyValue(ContainingGridProperty, _useCache);
}
}
#endregion Public Properties
//------------------------------------------------------
//
// Private Fields
//
//------------------------------------------------------
#region Private Fields
private AutomationElement _el; // AutomationElement that contains the cache or live reference
private bool _useCache; // true to use cache, false to use live reference to get current values
#endregion Private Fields
}
#endregion Nested Classes
}
}
|