SelectionItemPattern.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / Net / Net / 3.5.50727.3053 / DEVDIV / depot / DevDiv / releases / Orcas / SP / wpf / src / UIAutomation / UIAutomationClient / System / Windows / Automation / SelectionItemPattern.cs / 1 / SelectionItemPattern.cs
                        

                        
                            //---------------------------------------------------------------------------- 
//
// 
//    Copyright (C) Microsoft Corporation.  All rights reserved.
//  
//
// 
// Description: Client-side wrapper for SelectionItem Pattern 
//
// History: 
//  06/23/2003 : BrendanM Ported to WCP
//
//---------------------------------------------------------------------------
 
using System;
using System.Collections; 
using System.Windows.Automation.Provider; 
using MS.Internal.Automation;
 
namespace System.Windows.Automation
{
    /// 
    /// Class representing containers that manage selection. 
    /// 
#if (INTERNAL_COMPILE) 
    internal class SelectionItemPattern: BasePattern 
#else
    public class SelectionItemPattern: BasePattern 
#endif
    {
        //-----------------------------------------------------
        // 
        //  Constructors
        // 
        //----------------------------------------------------- 

        #region Constructors 

        private SelectionItemPattern(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 

        /// SelectionItem pattern
        public static readonly AutomationPattern Pattern = SelectionItemPatternIdentifiers.Pattern;
 
        /// Indicates the element is currently selected.
        public static readonly AutomationProperty IsSelectedProperty = SelectionItemPatternIdentifiers.IsSelectedProperty; 
        /// Indicates the element is currently selected. 
        public static readonly AutomationProperty SelectionContainerProperty = SelectionItemPatternIdentifiers.SelectionContainerProperty;
 
        /// 
        /// Event ID: ElementAddedToSelection - indicates an element was added to the selection.
        /// sourceElement  refers to the element that was added to the selection.
        ///  
        public static readonly AutomationEvent ElementAddedToSelectionEvent = SelectionItemPatternIdentifiers.ElementAddedToSelectionEvent;
        ///  
        /// Event ID: ElementRemovedFromSelection - indicates an element was removed from the selection. 
        /// sourceElement refers to the element that was removed from the selection.
        ///  
        public static readonly AutomationEvent ElementRemovedFromSelectionEvent = SelectionItemPatternIdentifiers.ElementRemovedFromSelectionEvent;
        /// 
        /// Event ID: ElementSelected - indicates an element was selected in a selection container, deselecting
        /// any previously selected elements in that container. 
        /// sourceElement refers to the selected element
        ///  
        public static readonly AutomationEvent ElementSelectedEvent = SelectionItemPatternIdentifiers.ElementSelectedEvent; 

        #endregion Public Constants and Readonly Fields 


        //------------------------------------------------------
        // 
        //  Public Methods
        // 
        //------------------------------------------------------ 

        #region Public Methods 

        /// 
        /// Sets the current element as the selection
        /// This clears the selection from other elements in the container 
        /// 
        /// 
        ///  
        /// This API does not work inside the secure execution environment.
        ///  
        /// 
        public void Select()
        {
            UiaCoreApi.SelectionItemPattern_Select(_hPattern); 
        }
        ///  
        /// Adds current element to selection 
        /// 
        /// 
        /// 
        /// This API does not work inside the secure execution environment.
        /// 
        ///  
        public void AddToSelection()
        { 
            UiaCoreApi.SelectionItemPattern_AddToSelection(_hPattern); 
        }
 
        /// 
        /// Removes current element from selection
        /// 
        /// 
        /// 
        /// This API does not work inside the secure execution environment. 
        ///  
        /// 
        public void RemoveFromSelection() 
        {
            UiaCoreApi.SelectionItemPattern_RemoveFromSelection(_hPattern);
        }
 
        #endregion Public Methods
 
 
        //-----------------------------------------------------
        // 
        //  Public Properties
        //
        //------------------------------------------------------
 
        #region Public Properties
        ///  
        /// This member allows access to previously requested 
        /// cached properties for this element. The returned object
        /// has accessors for each property defined for this pattern. 
        /// 
        /// 
        /// 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.
        /// 
        public SelectionItemPatternInformation Cached
        { 
            get
            { 
                Misc.ValidateCached(_cached); 
                return new SelectionItemPatternInformation(_el, true);
            } 
        }

        /// 
        /// This member allows access to current property values 
        /// for this element. The returned object has accessors for
        /// each property defined for this pattern. 
        ///  
        /// 
        /// 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.
        ///  
        public SelectionItemPatternInformation Current
        {
            get
            { 
                Misc.ValidateCurrent(_hPattern);
                return new SelectionItemPatternInformation(_el, false); 
            } 
        }
 

        #endregion Public Properties

 
        //-----------------------------------------------------
        // 
        //  Internal Methods 
        //
        //----------------------------------------------------- 

        #region Internal Methods

        internal static object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached) 
        {
            return new SelectionItemPattern(el, hPattern, cached); 
        } 

        #endregion Internal Methods 


        //-----------------------------------------------------
        // 
        //  Private Fields
        // 
        //------------------------------------------------------ 

        #region Private Fields 

        private SafePatternHandle _hPattern;
        private bool _cached;
 
        #endregion Private Fields
 
 
        //-----------------------------------------------------
        // 
        //  Nested Classes
        //
        //------------------------------------------------------
 
        #region Nested Classes
 
        ///  
        /// This class provides access to either Cached or Current
        /// properties on a pattern via the pattern's .Cached or 
        /// .Current accessors.
        /// 
        public struct SelectionItemPatternInformation
        { 
            //------------------------------------------------------
            // 
            //  Constructors 
            //
            //----------------------------------------------------- 

            #region Constructors

            internal SelectionItemPatternInformation(AutomationElement el, bool useCache) 
            {
                _el = el; 
                _useCache = useCache; 
            }
 
            #endregion Constructors


            //------------------------------------------------------ 
            //
            //  Public Properties 
            // 
            //-----------------------------------------------------
 
            #region Public Properties

            /// 
            /// Check whether an element is selected 
            /// 
            /// returns true if the element is selected 
            /// 
            /// 
            /// This API does not work inside the secure execution environment. 
            /// 
            /// 
            public bool IsSelected
            { 
                get
                { 
                    return (bool)_el.GetPatternPropertyValue(IsSelectedProperty, _useCache); 
                }
            } 

            /// 
            /// The logical element that supports the SelectionPattern for this Item
            ///  
            /// returns an AutomationElement
            /// 
            ///  
            /// This API does not work inside the secure execution environment.
            ///  
            /// 
            public AutomationElement SelectionContainer
            {
                get 
                {
                    return (AutomationElement)_el.GetPatternPropertyValue(SelectionContainerProperty, _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 
    }
} 

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.
//---------------------------------------------------------------------------- 
//
// 
//    Copyright (C) Microsoft Corporation.  All rights reserved.
//  
//
// 
// Description: Client-side wrapper for SelectionItem Pattern 
//
// History: 
//  06/23/2003 : BrendanM Ported to WCP
//
//---------------------------------------------------------------------------
 
using System;
using System.Collections; 
using System.Windows.Automation.Provider; 
using MS.Internal.Automation;
 
namespace System.Windows.Automation
{
    /// 
    /// Class representing containers that manage selection. 
    /// 
#if (INTERNAL_COMPILE) 
    internal class SelectionItemPattern: BasePattern 
#else
    public class SelectionItemPattern: BasePattern 
#endif
    {
        //-----------------------------------------------------
        // 
        //  Constructors
        // 
        //----------------------------------------------------- 

        #region Constructors 

        private SelectionItemPattern(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 

        /// SelectionItem pattern
        public static readonly AutomationPattern Pattern = SelectionItemPatternIdentifiers.Pattern;
 
        /// Indicates the element is currently selected.
        public static readonly AutomationProperty IsSelectedProperty = SelectionItemPatternIdentifiers.IsSelectedProperty; 
        /// Indicates the element is currently selected. 
        public static readonly AutomationProperty SelectionContainerProperty = SelectionItemPatternIdentifiers.SelectionContainerProperty;
 
        /// 
        /// Event ID: ElementAddedToSelection - indicates an element was added to the selection.
        /// sourceElement  refers to the element that was added to the selection.
        ///  
        public static readonly AutomationEvent ElementAddedToSelectionEvent = SelectionItemPatternIdentifiers.ElementAddedToSelectionEvent;
        ///  
        /// Event ID: ElementRemovedFromSelection - indicates an element was removed from the selection. 
        /// sourceElement refers to the element that was removed from the selection.
        ///  
        public static readonly AutomationEvent ElementRemovedFromSelectionEvent = SelectionItemPatternIdentifiers.ElementRemovedFromSelectionEvent;
        /// 
        /// Event ID: ElementSelected - indicates an element was selected in a selection container, deselecting
        /// any previously selected elements in that container. 
        /// sourceElement refers to the selected element
        ///  
        public static readonly AutomationEvent ElementSelectedEvent = SelectionItemPatternIdentifiers.ElementSelectedEvent; 

        #endregion Public Constants and Readonly Fields 


        //------------------------------------------------------
        // 
        //  Public Methods
        // 
        //------------------------------------------------------ 

        #region Public Methods 

        /// 
        /// Sets the current element as the selection
        /// This clears the selection from other elements in the container 
        /// 
        /// 
        ///  
        /// This API does not work inside the secure execution environment.
        ///  
        /// 
        public void Select()
        {
            UiaCoreApi.SelectionItemPattern_Select(_hPattern); 
        }
        ///  
        /// Adds current element to selection 
        /// 
        /// 
        /// 
        /// This API does not work inside the secure execution environment.
        /// 
        ///  
        public void AddToSelection()
        { 
            UiaCoreApi.SelectionItemPattern_AddToSelection(_hPattern); 
        }
 
        /// 
        /// Removes current element from selection
        /// 
        /// 
        /// 
        /// This API does not work inside the secure execution environment. 
        ///  
        /// 
        public void RemoveFromSelection() 
        {
            UiaCoreApi.SelectionItemPattern_RemoveFromSelection(_hPattern);
        }
 
        #endregion Public Methods
 
 
        //-----------------------------------------------------
        // 
        //  Public Properties
        //
        //------------------------------------------------------
 
        #region Public Properties
        ///  
        /// This member allows access to previously requested 
        /// cached properties for this element. The returned object
        /// has accessors for each property defined for this pattern. 
        /// 
        /// 
        /// 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.
        /// 
        public SelectionItemPatternInformation Cached
        { 
            get
            { 
                Misc.ValidateCached(_cached); 
                return new SelectionItemPatternInformation(_el, true);
            } 
        }

        /// 
        /// This member allows access to current property values 
        /// for this element. The returned object has accessors for
        /// each property defined for this pattern. 
        ///  
        /// 
        /// 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.
        ///  
        public SelectionItemPatternInformation Current
        {
            get
            { 
                Misc.ValidateCurrent(_hPattern);
                return new SelectionItemPatternInformation(_el, false); 
            } 
        }
 

        #endregion Public Properties

 
        //-----------------------------------------------------
        // 
        //  Internal Methods 
        //
        //----------------------------------------------------- 

        #region Internal Methods

        internal static object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached) 
        {
            return new SelectionItemPattern(el, hPattern, cached); 
        } 

        #endregion Internal Methods 


        //-----------------------------------------------------
        // 
        //  Private Fields
        // 
        //------------------------------------------------------ 

        #region Private Fields 

        private SafePatternHandle _hPattern;
        private bool _cached;
 
        #endregion Private Fields
 
 
        //-----------------------------------------------------
        // 
        //  Nested Classes
        //
        //------------------------------------------------------
 
        #region Nested Classes
 
        ///  
        /// This class provides access to either Cached or Current
        /// properties on a pattern via the pattern's .Cached or 
        /// .Current accessors.
        /// 
        public struct SelectionItemPatternInformation
        { 
            //------------------------------------------------------
            // 
            //  Constructors 
            //
            //----------------------------------------------------- 

            #region Constructors

            internal SelectionItemPatternInformation(AutomationElement el, bool useCache) 
            {
                _el = el; 
                _useCache = useCache; 
            }
 
            #endregion Constructors


            //------------------------------------------------------ 
            //
            //  Public Properties 
            // 
            //-----------------------------------------------------
 
            #region Public Properties

            /// 
            /// Check whether an element is selected 
            /// 
            /// returns true if the element is selected 
            /// 
            /// 
            /// This API does not work inside the secure execution environment. 
            /// 
            /// 
            public bool IsSelected
            { 
                get
                { 
                    return (bool)_el.GetPatternPropertyValue(IsSelectedProperty, _useCache); 
                }
            } 

            /// 
            /// The logical element that supports the SelectionPattern for this Item
            ///  
            /// returns an AutomationElement
            /// 
            ///  
            /// This API does not work inside the secure execution environment.
            ///  
            /// 
            public AutomationElement SelectionContainer
            {
                get 
                {
                    return (AutomationElement)_el.GetPatternPropertyValue(SelectionContainerProperty, _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 
    }
} 

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK