Code:
/ Dotnetfx_Vista_SP2 / Dotnetfx_Vista_SP2 / 8.0.50727.4016 / DEVDIV / depot / DevDiv / releases / Orcas / QFE / wpf / src / UIAutomation / UIAutomationClient / System / Windows / Automation / WindowPattern.cs / 1 / WindowPattern.cs
//----------------------------------------------------------------------------
//
//
// Copyright (C) Microsoft Corporation. All rights reserved.
//
//
//
// Description: Client-side wrapper for Window Pattern
//
// History:
// 06/23/2003 : BrendanM Ported to WCP
//
//---------------------------------------------------------------------------
using System;
using System.Windows.Automation.Provider;
using MS.Internal.Automation;
using System.Runtime.InteropServices;
namespace System.Windows.Automation
{
// Disable warning for obsolete types. These are scheduled to be removed in M8.2 so
// only need the warning to come out for components outside of APT.
#pragma warning disable 0618
///wrapper class for Window pattern
#if (INTERNAL_COMPILE)
internal class WindowPattern: BasePattern
#else
public class WindowPattern: BasePattern
#endif
{
//-----------------------------------------------------
//
// Constructors
//
//-----------------------------------------------------
#region Constructors
private WindowPattern(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
/// Returns the Window pattern identifier
public static readonly AutomationPattern Pattern = WindowPatternIdentifiers.Pattern;
/// Property ID: CanMaximize -
public static readonly AutomationProperty CanMaximizeProperty = WindowPatternIdentifiers.CanMaximizeProperty;
/// Property ID: CanMinimize -
public static readonly AutomationProperty CanMinimizeProperty = WindowPatternIdentifiers.CanMinimizeProperty;
/// Property ID: IsModal - Is this is a modal window
public static readonly AutomationProperty IsModalProperty = WindowPatternIdentifiers.IsModalProperty;
/// Property ID: WindowVisualState - Is the Window Maximized, Minimized, or Normal (aka restored)
public static readonly AutomationProperty WindowVisualStateProperty = WindowPatternIdentifiers.WindowVisualStateProperty;
/// Property ID: WindowInteractionState - Is the Window Closing, ReadyForUserInteraction, BlockedByModalWindow or NotResponding.
public static readonly AutomationProperty WindowInteractionStateProperty = WindowPatternIdentifiers.WindowInteractionStateProperty;
/// Property ID: - This window is always on top
public static readonly AutomationProperty IsTopmostProperty = WindowPatternIdentifiers.IsTopmostProperty;
/// Event ID: WindowOpened - Immediately after opening the window - ApplicationWindows or Window Status is not guarantee to be: ReadyForUserInteraction
public static readonly AutomationEvent WindowOpenedEvent = WindowPatternIdentifiers.WindowOpenedEvent;
/// Event ID: WindowClosed - Immediately after closing the window
public static readonly AutomationEvent WindowClosedEvent = WindowPatternIdentifiers.WindowClosedEvent;
#endregion Public Constants and Readonly Fields
//------------------------------------------------------
//
// Public Methods
//
//------------------------------------------------------
#region Public Methods
///
/// Changes the State of the window based on the passed enum.
///
/// The requested state of the window.
///
///
/// This API does not work inside the secure execution environment.
///
public void SetWindowVisualState( WindowVisualState state )
{
UiaCoreApi.WindowPattern_SetWindowVisualState(_hPattern, state);
}
///
/// Non-blocking call to close this non-application window.
/// When called on a split pane, it will close the pane (thereby removing a
/// split), it may or may not also close all other panes related to the
/// document/content/etc. This behavior is application dependent.
///
///
///
/// This API does not work inside the secure execution environment.
///
public void Close()
{
UiaCoreApi.WindowPattern_Close(_hPattern);
}
///
/// Causes the calling code to block, waiting the specified number of milliseconds, for the
/// associated window to enter an idle state.
///
///
/// The implementation is dependent on the underlying application framework therefore this
/// call may return sometime after the window is ready for user input. The calling code
/// should not rely on this call to understand exactly when the window has become idle.
///
/// For now this method works reliably for both WinFx and Win32 Windows that are starting
/// up. However, if called at other times on WinFx Windows (e.g. during a long layout)
/// WaitForInputIdle may return true before the Window is actually idle. Additional work
/// needs to be done to detect when WinFx Windows are idle.
///
/// The amount of time, in milliseconds, to wait for the
/// associated process to become idle. The maximum is the largest possible value of a
/// 32-bit integer, which represents infinity to the operating system
///
///
/// returns true if the window has reached the idle state and false if the timeout occurred.
///
public bool WaitForInputIdle( int milliseconds )
{
return UiaCoreApi.WindowPattern_WaitForInputIdle(_hPattern, milliseconds);
}
#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 WindowPatternInformation Cached
{
get
{
Misc.ValidateCached(_cached);
return new WindowPatternInformation(_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 WindowPatternInformation Current
{
get
{
Misc.ValidateCurrent(_hPattern);
return new WindowPatternInformation(_el, false);
}
}
#endregion Public Properties
//-----------------------------------------------------
//
// Internal Methods
//
//-----------------------------------------------------
#region Internal Methods
internal static object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached)
{
return new WindowPattern(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 WindowPatternInformation
{
//------------------------------------------------------
//
// Constructors
//
//-----------------------------------------------------
#region Constructors
internal WindowPatternInformation(AutomationElement el, bool useCache)
{
_el = el;
_useCache = useCache;
}
#endregion Constructors
//------------------------------------------------------
//
// Public Properties
//
//-----------------------------------------------------
#region Public Properties
/// Is this window Maximizable
///
///
/// This API does not work inside the secure execution environment.
///
public bool CanMaximize
{
get
{
return (bool)_el.GetPatternPropertyValue(CanMaximizeProperty, _useCache);
}
}
/// Is this window Minimizable
///
///
/// This API does not work inside the secure execution environment.
///
public bool CanMinimize
{
get
{
return (bool)_el.GetPatternPropertyValue(CanMinimizeProperty, _useCache);
}
}
/// Is this is a modal window.
///
///
/// This API does not work inside the secure execution environment.
///
public bool IsModal
{
get
{
return (bool)_el.GetPatternPropertyValue(IsModalProperty, _useCache);
}
}
/// Is the Window Maximized, Minimized, or Normal (aka restored)
///
///
/// This API does not work inside the secure execution environment.
///
public WindowVisualState WindowVisualState
{
get
{
return (WindowVisualState)_el.GetPatternPropertyValue(WindowVisualStateProperty, _useCache);
}
}
/// Is the Window Closing, ReadyForUserInteraction, BlockedByModalWindow or NotResponding.
///
///
/// This API does not work inside the secure execution environment.
///
public WindowInteractionState WindowInteractionState
{
get
{
return (WindowInteractionState)_el.GetPatternPropertyValue(WindowInteractionStateProperty, _useCache);
}
}
/// Is this window is always on top
///
///
/// This API does not work inside the secure execution environment.
///
public bool IsTopmost
{
get
{
return (bool)_el.GetPatternPropertyValue(IsTopmostProperty, _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 Window Pattern
//
// History:
// 06/23/2003 : BrendanM Ported to WCP
//
//---------------------------------------------------------------------------
using System;
using System.Windows.Automation.Provider;
using MS.Internal.Automation;
using System.Runtime.InteropServices;
namespace System.Windows.Automation
{
// Disable warning for obsolete types. These are scheduled to be removed in M8.2 so
// only need the warning to come out for components outside of APT.
#pragma warning disable 0618
///wrapper class for Window pattern
#if (INTERNAL_COMPILE)
internal class WindowPattern: BasePattern
#else
public class WindowPattern: BasePattern
#endif
{
//-----------------------------------------------------
//
// Constructors
//
//-----------------------------------------------------
#region Constructors
private WindowPattern(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
/// Returns the Window pattern identifier
public static readonly AutomationPattern Pattern = WindowPatternIdentifiers.Pattern;
/// Property ID: CanMaximize -
public static readonly AutomationProperty CanMaximizeProperty = WindowPatternIdentifiers.CanMaximizeProperty;
/// Property ID: CanMinimize -
public static readonly AutomationProperty CanMinimizeProperty = WindowPatternIdentifiers.CanMinimizeProperty;
/// Property ID: IsModal - Is this is a modal window
public static readonly AutomationProperty IsModalProperty = WindowPatternIdentifiers.IsModalProperty;
/// Property ID: WindowVisualState - Is the Window Maximized, Minimized, or Normal (aka restored)
public static readonly AutomationProperty WindowVisualStateProperty = WindowPatternIdentifiers.WindowVisualStateProperty;
/// Property ID: WindowInteractionState - Is the Window Closing, ReadyForUserInteraction, BlockedByModalWindow or NotResponding.
public static readonly AutomationProperty WindowInteractionStateProperty = WindowPatternIdentifiers.WindowInteractionStateProperty;
/// Property ID: - This window is always on top
public static readonly AutomationProperty IsTopmostProperty = WindowPatternIdentifiers.IsTopmostProperty;
/// Event ID: WindowOpened - Immediately after opening the window - ApplicationWindows or Window Status is not guarantee to be: ReadyForUserInteraction
public static readonly AutomationEvent WindowOpenedEvent = WindowPatternIdentifiers.WindowOpenedEvent;
/// Event ID: WindowClosed - Immediately after closing the window
public static readonly AutomationEvent WindowClosedEvent = WindowPatternIdentifiers.WindowClosedEvent;
#endregion Public Constants and Readonly Fields
//------------------------------------------------------
//
// Public Methods
//
//------------------------------------------------------
#region Public Methods
///
/// Changes the State of the window based on the passed enum.
///
/// The requested state of the window.
///
///
/// This API does not work inside the secure execution environment.
///
public void SetWindowVisualState( WindowVisualState state )
{
UiaCoreApi.WindowPattern_SetWindowVisualState(_hPattern, state);
}
///
/// Non-blocking call to close this non-application window.
/// When called on a split pane, it will close the pane (thereby removing a
/// split), it may or may not also close all other panes related to the
/// document/content/etc. This behavior is application dependent.
///
///
///
/// This API does not work inside the secure execution environment.
///
public void Close()
{
UiaCoreApi.WindowPattern_Close(_hPattern);
}
///
/// Causes the calling code to block, waiting the specified number of milliseconds, for the
/// associated window to enter an idle state.
///
///
/// The implementation is dependent on the underlying application framework therefore this
/// call may return sometime after the window is ready for user input. The calling code
/// should not rely on this call to understand exactly when the window has become idle.
///
/// For now this method works reliably for both WinFx and Win32 Windows that are starting
/// up. However, if called at other times on WinFx Windows (e.g. during a long layout)
/// WaitForInputIdle may return true before the Window is actually idle. Additional work
/// needs to be done to detect when WinFx Windows are idle.
///
/// The amount of time, in milliseconds, to wait for the
/// associated process to become idle. The maximum is the largest possible value of a
/// 32-bit integer, which represents infinity to the operating system
///
///
/// returns true if the window has reached the idle state and false if the timeout occurred.
///
public bool WaitForInputIdle( int milliseconds )
{
return UiaCoreApi.WindowPattern_WaitForInputIdle(_hPattern, milliseconds);
}
#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 WindowPatternInformation Cached
{
get
{
Misc.ValidateCached(_cached);
return new WindowPatternInformation(_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 WindowPatternInformation Current
{
get
{
Misc.ValidateCurrent(_hPattern);
return new WindowPatternInformation(_el, false);
}
}
#endregion Public Properties
//-----------------------------------------------------
//
// Internal Methods
//
//-----------------------------------------------------
#region Internal Methods
internal static object Wrap(AutomationElement el, SafePatternHandle hPattern, bool cached)
{
return new WindowPattern(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 WindowPatternInformation
{
//------------------------------------------------------
//
// Constructors
//
//-----------------------------------------------------
#region Constructors
internal WindowPatternInformation(AutomationElement el, bool useCache)
{
_el = el;
_useCache = useCache;
}
#endregion Constructors
//------------------------------------------------------
//
// Public Properties
//
//-----------------------------------------------------
#region Public Properties
/// Is this window Maximizable
///
///
/// This API does not work inside the secure execution environment.
///
public bool CanMaximize
{
get
{
return (bool)_el.GetPatternPropertyValue(CanMaximizeProperty, _useCache);
}
}
/// Is this window Minimizable
///
///
/// This API does not work inside the secure execution environment.
///
public bool CanMinimize
{
get
{
return (bool)_el.GetPatternPropertyValue(CanMinimizeProperty, _useCache);
}
}
/// Is this is a modal window.
///
///
/// This API does not work inside the secure execution environment.
///
public bool IsModal
{
get
{
return (bool)_el.GetPatternPropertyValue(IsModalProperty, _useCache);
}
}
/// Is the Window Maximized, Minimized, or Normal (aka restored)
///
///
/// This API does not work inside the secure execution environment.
///
public WindowVisualState WindowVisualState
{
get
{
return (WindowVisualState)_el.GetPatternPropertyValue(WindowVisualStateProperty, _useCache);
}
}
/// Is the Window Closing, ReadyForUserInteraction, BlockedByModalWindow or NotResponding.
///
///
/// This API does not work inside the secure execution environment.
///
public WindowInteractionState WindowInteractionState
{
get
{
return (WindowInteractionState)_el.GetPatternPropertyValue(WindowInteractionStateProperty, _useCache);
}
}
/// Is this window is always on top
///
///
/// This API does not work inside the secure execution environment.
///
public bool IsTopmost
{
get
{
return (bool)_el.GetPatternPropertyValue(IsTopmostProperty, _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
This book is available now!
Buy at Amazon US or
Buy at Amazon UK
- ReadContentAsBinaryHelper.cs
- SortExpressionBuilder.cs
- RootContext.cs
- Ops.cs
- CorrelationManager.cs
- PipeSecurity.cs
- ResXDataNode.cs
- COM2FontConverter.cs
- GlyphInfoList.cs
- objectresult_tresulttype.cs
- ThreadAbortException.cs
- EntityConnection.cs
- XpsPackagingException.cs
- BindingListCollectionView.cs
- RichTextBox.cs
- EncryptionUtility.cs
- TextRunCacheImp.cs
- InitializationEventAttribute.cs
- FontInfo.cs
- httpstaticobjectscollection.cs
- GetWinFXPath.cs
- IisTraceWebEventProvider.cs
- AsyncResult.cs
- WindowsSolidBrush.cs
- HttpWebRequest.cs
- Resources.Designer.cs
- Roles.cs
- BamlLocalizationDictionary.cs
- DataTable.cs
- XsdDuration.cs
- XmlUnspecifiedAttribute.cs
- KnownBoxes.cs
- Positioning.cs
- ZeroOpNode.cs
- ObjectParameter.cs
- RightsManagementResourceHelper.cs
- FieldBuilder.cs
- PasswordTextNavigator.cs
- QuarticEase.cs
- processwaithandle.cs
- IItemContainerGenerator.cs
- URLMembershipCondition.cs
- TrackingParameters.cs
- SafeMemoryMappedFileHandle.cs
- PartitionResolver.cs
- OdbcDataReader.cs
- IPEndPoint.cs
- SystemColors.cs
- Timer.cs
- X509ClientCertificateCredentialsElement.cs
- PagesChangedEventArgs.cs
- AsyncStreamReader.cs
- DefaultAsyncDataDispatcher.cs
- IdentityReference.cs
- SRef.cs
- BrowserTree.cs
- SelectionGlyphBase.cs
- ValidatorCollection.cs
- MessageEventSubscriptionService.cs
- EncryptedKeyIdentifierClause.cs
- ValueSerializerAttribute.cs
- LogFlushAsyncResult.cs
- HttpChannelListener.cs
- MessageEventSubscriptionService.cs
- ValueUnavailableException.cs
- TypeBuilder.cs
- XmlSchemaImport.cs
- SaveFileDialog.cs
- SID.cs
- UnsafeNativeMethods.cs
- CodeTypeConstructor.cs
- ListViewInsertionMark.cs
- TreeNodeStyleCollectionEditor.cs
- AncestorChangedEventArgs.cs
- SqlAliasesReferenced.cs
- DbProviderFactory.cs
- ErrorProvider.cs
- SqlErrorCollection.cs
- HtmlElementErrorEventArgs.cs
- OutputCacheProfile.cs
- PKCS1MaskGenerationMethod.cs
- RemotingAttributes.cs
- IndexExpression.cs
- FileNotFoundException.cs
- TypeListConverter.cs
- HashMembershipCondition.cs
- ExternalFile.cs
- CodeAccessSecurityEngine.cs
- EventMappingSettingsCollection.cs
- XmlSchemaObjectTable.cs
- ObjectStorage.cs
- ReversePositionQuery.cs
- SapiRecoContext.cs
- XmlSchemaSequence.cs
- DigitalSignatureProvider.cs
- WebContext.cs
- messageonlyhwndwrapper.cs
- ProgressBarAutomationPeer.cs
- TdsParserHelperClasses.cs
- RTTypeWrapper.cs