Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

UIElement.CaptureStylus Method

Attempts to force capture of the stylus to this element.

Namespace: System.Windows
Assembly: PresentationCore (in presentationcore.dll)

public bool CaptureStylus ()
public final boolean CaptureStylus ()
public final function CaptureStylus () : boolean
You cannot use methods in XAML.

Return Value

true if the stylus was successfully captured; otherwise, false.

The default implementation based on the underlying default stylus device always returns true. However, if you are extending the input devices that provide the device implementation for the input system, it is possible to create a system with an alternative stylus device implementation that might return different results.

When an element captures the stylus, it receives stylus input even if the stylus is outside its bounds. The stylus is typically captured only during drag-and-drop operations.

Calling this method calls an underlying static Stylus method Capture. The actual capture behavior is implemented by the active stylus device implementation.

To be captured, an element must be enabled. Check whether IsEnabled is true return before you call CaptureStylus.

If calling CaptureStylus returns true, IsStylusCaptured is also true.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

Show:
© 2015 Microsoft