UIElement.CaptureStylus Method


Attempts to force capture of the stylus to this element.

 virtual bool CaptureStylus();
public bool CaptureStylus ();
abstract member CaptureStylus : unit -> bool
override this.CaptureStylus : unit -> bool
Public Function CaptureStylus () As Boolean


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.

Applies to