ExpandCollapsePattern.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / DotNET / DotNET / 8.0 / untmp / WIN_WINDOWS / lh_tools_devdiv_wpf / Windows / AccessibleTech / longhorn / Automation / UIAutomationClient / System / Windows / Automation / ExpandCollapsePattern.cs / 1 / ExpandCollapsePattern.cs
                        

                        
                            //---------------------------------------------------------------------------- 
//
// 
//    Copyright (C) Microsoft Corporation.  All rights reserved.
//  
//
// 
// Description: Client-side wrapper for ExpandCollapse Pattern 
//
// History: 
//  06/23/2003 : [....] Ported to WCP
//
//---------------------------------------------------------------------------
 
using System;
using System.Windows.Automation.Provider; 
using MS.Internal.Automation; 

namespace System.Windows.Automation 
{
    ///wrapper class for ExpandCollapse pattern 
#if (INTERNAL_COMPILE)
    internal class ExpandCollapsePattern: BasePattern 
#else
    public class ExpandCollapsePattern: BasePattern 
#endif 
    {
        //----------------------------------------------------- 
        //
        //  Constructors
        //
        //----------------------------------------------------- 

        #region Constructors 
 
        private ExpandCollapsePattern(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 
 
        /// Scroll pattern
        public static readonly AutomationPattern Pattern = ExpandCollapsePatternIdentifiers.Pattern; 

        /// Property ID: ExpandCollapseState - Current Collapsed or Expanded state
        public static readonly AutomationProperty ExpandCollapseStateProperty = ExpandCollapsePatternIdentifiers.ExpandCollapseStateProperty;
 
        #endregion Public Constants and Readonly Fields
 
 
        //------------------------------------------------------
        // 
        //  Public Methods
        //
        //------------------------------------------------------
 
        #region Public Methods
 
        ///  
        /// Blocking method that returns after the element has been expanded
        ///  
        ///
        /// 
        /// This API does not work inside the secure execution environment.
        ///  
        /// 
        public void Expand() 
        { 
            UiaCoreApi.ExpandCollapsePattern_Expand(_hPattern);
        } 

        /// 
        /// Blocking method that returns after the element has been collapsed
        ///  
        ///
        ///  
        /// This API does not work inside the secure execution environment. 
        /// 
        ///  
        public void Collapse()
        {
            UiaCoreApi.ExpandCollapsePattern_Collapse(_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 ExpandCollapsePatternInformation Cached 
        {
            get 
            { 
                Misc.ValidateCached(_cached);
                return new ExpandCollapsePatternInformation(_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 ExpandCollapsePatternInformation Current
        {
            get 
            {
                Misc.ValidateCurrent(_hPattern); 
                return new ExpandCollapsePatternInformation(_el, false); 
            }
        } 


        #endregion Public Properties
 

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

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

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

            #endregion Constructors

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

            #region Public Properties

            ///indicates an element's current Collapsed or Expanded state 
            ///
            ///  
            /// This API does not work inside the secure execution environment. 
            /// 
            ///  
            public ExpandCollapseState ExpandCollapseState
            {
                get
                { 
                    return (ExpandCollapseState)_el.GetPatternPropertyValue(ExpandCollapseStateProperty, _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