TogglePattern.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / Dotnetfx_Vista_SP2 / Dotnetfx_Vista_SP2 / 8.0.50727.4016 / DEVDIV / depot / DevDiv / releases / Orcas / QFE / wpf / src / UIAutomation / UIAutomationClient / System / Windows / Automation / TogglePattern.cs / 1 / TogglePattern.cs
                        

                        
                            //---------------------------------------------------------------------------- 
//
// 
//    Copyright (C) Microsoft Corporation.  All rights reserved.
//  
//
// 
// Description: Client-side wrapper for Toggle Pattern 
//
// History: 
//  02/03/2004 : Created by MKarr
//
//---------------------------------------------------------------------------
 
using System;
using System.Windows.Automation.Provider; 
using MS.Internal.Automation; 

namespace System.Windows.Automation 
{
    /// 
    /// Represents UI elements that have a set of states that can by cycled through such as a checkbox, or toggle button.
    ///  
#if (INTERNAL_COMPILE)
    internal class TogglePattern: BasePattern 
#else 
    public class TogglePattern: BasePattern
#endif 
    {
        //-----------------------------------------------------
        //
        //  Constructors 
        //
        //----------------------------------------------------- 
 
        #region Constructors
 
        private TogglePattern(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
 
        /// Toggle pattern
        public static readonly AutomationPattern Pattern = TogglePatternIdentifiers.Pattern;

        /// Property ID: ToggleState - Value of a toggleable control, as a ToggleState enum 
        public static readonly AutomationProperty ToggleStateProperty = TogglePatternIdentifiers.ToggleStateProperty;
 
        #endregion Public Constants and Readonly Fields 

 
        //------------------------------------------------------
        //
        //  Public Methods
        // 
        //------------------------------------------------------
 
        #region Public Methods 

        ///  
        /// Request to change the state that this UI element is currently representing
        /// 
        ///
        ///  
        /// This API does not work inside the secure execution environment.
        ///  
        ///  
        public void Toggle()
        { 
            UiaCoreApi.TogglePattern_Toggle(_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 TogglePatternInformation Cached
        {
            get 
            {
                Misc.ValidateCached(_cached); 
                return new TogglePatternInformation(_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 TogglePatternInformation Current 
        {
            get
            {
                Misc.ValidateCurrent(_hPattern); 
                return new TogglePatternInformation(_el, false);
            } 
        } 

 
        #endregion Public Properties


        //----------------------------------------------------- 
        //
        //  Internal Methods 
        // 
        //-----------------------------------------------------
 
        #region Internal Methods

        static internal object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached)
        { 
            return new TogglePattern(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 TogglePatternInformation
        {
            //------------------------------------------------------ 
            //
            //  Constructors 
            // 
            //-----------------------------------------------------
 
            #region Constructors

            internal TogglePatternInformation(AutomationElement el, bool useCache)
            { 
                _el = el;
                _useCache = useCache; 
            } 

            #endregion Constructors 


            //------------------------------------------------------
            // 
            //  Public Properties
            // 
            //----------------------------------------------------- 

            #region Public Properties 

            /// Value of a toggleable control, as a ToggleState enum
            ///
            ///  
            /// This API does not work inside the secure execution environment.
            ///  
            ///  
            public ToggleState ToggleState
            { 
                get
                {
                    return (ToggleState)_el.GetPatternPropertyValue(ToggleStateProperty, _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 Toggle Pattern 
//
// History: 
//  02/03/2004 : Created by MKarr
//
//---------------------------------------------------------------------------
 
using System;
using System.Windows.Automation.Provider; 
using MS.Internal.Automation; 

namespace System.Windows.Automation 
{
    /// 
    /// Represents UI elements that have a set of states that can by cycled through such as a checkbox, or toggle button.
    ///  
#if (INTERNAL_COMPILE)
    internal class TogglePattern: BasePattern 
#else 
    public class TogglePattern: BasePattern
#endif 
    {
        //-----------------------------------------------------
        //
        //  Constructors 
        //
        //----------------------------------------------------- 
 
        #region Constructors
 
        private TogglePattern(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
 
        /// Toggle pattern
        public static readonly AutomationPattern Pattern = TogglePatternIdentifiers.Pattern;

        /// Property ID: ToggleState - Value of a toggleable control, as a ToggleState enum 
        public static readonly AutomationProperty ToggleStateProperty = TogglePatternIdentifiers.ToggleStateProperty;
 
        #endregion Public Constants and Readonly Fields 

 
        //------------------------------------------------------
        //
        //  Public Methods
        // 
        //------------------------------------------------------
 
        #region Public Methods 

        ///  
        /// Request to change the state that this UI element is currently representing
        /// 
        ///
        ///  
        /// This API does not work inside the secure execution environment.
        ///  
        ///  
        public void Toggle()
        { 
            UiaCoreApi.TogglePattern_Toggle(_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 TogglePatternInformation Cached
        {
            get 
            {
                Misc.ValidateCached(_cached); 
                return new TogglePatternInformation(_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 TogglePatternInformation Current 
        {
            get
            {
                Misc.ValidateCurrent(_hPattern); 
                return new TogglePatternInformation(_el, false);
            } 
        } 

 
        #endregion Public Properties


        //----------------------------------------------------- 
        //
        //  Internal Methods 
        // 
        //-----------------------------------------------------
 
        #region Internal Methods

        static internal object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached)
        { 
            return new TogglePattern(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 TogglePatternInformation
        {
            //------------------------------------------------------ 
            //
            //  Constructors 
            // 
            //-----------------------------------------------------
 
            #region Constructors

            internal TogglePatternInformation(AutomationElement el, bool useCache)
            { 
                _el = el;
                _useCache = useCache; 
            } 

            #endregion Constructors 


            //------------------------------------------------------
            // 
            //  Public Properties
            // 
            //----------------------------------------------------- 

            #region Public Properties 

            /// Value of a toggleable control, as a ToggleState enum
            ///
            ///  
            /// This API does not work inside the secure execution environment.
            ///  
            ///  
            public ToggleState ToggleState
            { 
                get
                {
                    return (ToggleState)_el.GetPatternPropertyValue(ToggleStateProperty, _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