DockPattern.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / 4.0 / 4.0 / untmp / DEVDIV_TFS / Dev10 / Releases / RTMRel / wpf / src / UIAutomation / UIAutomationClient / System / Windows / Automation / DockPattern.cs / 1305600 / DockPattern.cs
                        

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

namespace System.Windows.Automation 
{

    /// 
    /// Expose an element's ability to change its dock state at run time. 
    /// 
#if (INTERNAL_COMPILE) 
    internal class DockPattern: BasePattern 
#else
    public class DockPattern: BasePattern 
#endif
    {
        //-----------------------------------------------------
        // 
        //  Constructors
        // 
        //----------------------------------------------------- 

        #region Constructors 

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

        /// Dock pattern
        public static readonly AutomationPattern Pattern = DockPatternIdentifiers.Pattern;
 
        /// Property ID: DockPosition - Is the DockPosition Top, Left, Bottom, Right, Fill, or None
        public static readonly AutomationProperty DockPositionProperty = DockPatternIdentifiers.DockPositionProperty; 
 
        #endregion Public Constants and Readonly Fields
 

        //------------------------------------------------------
        //
        //  Public Methods 
        //
        //------------------------------------------------------ 
 
        #region Public Methods
 
        /// 
        /// Moves the window to be docked at the requested location.
        /// 
        /// 
        /// 
        /// This API does not work inside the secure execution environment. 
        ///  
        /// 
        public void SetDockPosition( DockPosition dockPosition ) 
        {
            UiaCoreApi.DockPattern_SetDockPosition(_hPattern, dockPosition);
        }
 
        #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 DockPatternInformation Cached
        { 
            get
            { 
                Misc.ValidateCached(_cached); 
                return new DockPatternInformation(_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 DockPatternInformation Current
        {
            get
            { 
                Misc.ValidateCurrent(_hPattern);
                return new DockPatternInformation(_el, false); 
            } 
        }
 
        #endregion Public Properties


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

        internal static object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached)
        { 
            return new DockPattern(el, hPattern, cached);
        } 
 
        #endregion Internal Methods
 

        //-----------------------------------------------------
        //
        //  Private Fields 
        //
        //------------------------------------------------------ 
 
        #region Private Fields
 
        private SafePatternHandle _hPattern;
        private bool _cached;

        #endregion Private Fields 
        #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 DockPatternInformation
        { 
            //-----------------------------------------------------
            // 
            //  Constructors 
            //
            //------------------------------------------------------ 

            #region Constructors

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


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

            /// Returns whether the DockPosition is Top, Left, Bottom, Right, Fill, or None.
            /// 
            /// 
            /// This API does not work inside the secure execution environment. 
            ///  
            /// 
            public DockPosition DockPosition 
            {
                get
                {
                    return (DockPosition)_el.GetPatternPropertyValue(DockPositionProperty, _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