Skip to content

Latest commit

 

History

History
62 lines (44 loc) · 4.9 KB

uielement_manipulationmode.md

File metadata and controls

62 lines (44 loc) · 4.9 KB
Raw
-api-id -api-type
P:Windows.UI.Xaml.UIElement.ManipulationMode
winrt property

Windows.UI.Xaml.UIElement.ManipulationMode

-description

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

-xaml-syntax

<uiElement ManipulationMode="All"/>
-or-
<uiElement ManipulationMode="None"/>
-or-
<uiElement ManipulationMode="singleManipulationModesMemberName"/>
-or-
<uiElement ManipulationMode="relatedManipulationModesNames"/>

-xaml-values

singleManipulationModesMemberName
singleManipulationModesMemberNameOne of the named constants of the ManipulationModes enumeration. These constrain the manipulation to a single behavior, for example TranslateX.
relatedManipulationModesNames
relatedManipulationModesNamesTwo or more ManipulationModes enumeration constant names separated by commas, for example TranslateX,TranslateY. This is the XAML syntax for specifying multiple values of a flagwise enumeration. See "Specifying related manipulation modes" section.
## -property-value A value or values of the enumeration. The default is typically **System**, but this can vary on specific controls and elements. See Remarks.

-remarks

You must set the ManipulationMode to a value other than System or None if you want to handle manipulation events such as ManipulationStarted from UI elements in your app code. For more info on manipulations, see Handle pointer input.

The typical default value of ManipulationMode is System rather than None. When the value is System, manipulations that originate from the element can be handled by the Windows Runtime infrastructure, which is based on the Direct Manipulation API. For example, ScrollViewer handles user manipulations in its control logic and processes them as scrolling actions for the control. The System value also enables personality animations that respond to manipulation events.

Slider and ToggleSwitch have default templates that set the ManipulationMode value to None, so None will be the default value you see at design time.

Specifying related manipulation modes

You can specify more than one of the flagwise ManipulationModes values as the value of the ManipulationMode property. This is possible in XAML using the comma syntax shown in the "XAML Values" section. For example, you can combine TranslateX, TranslateY, Rotate, and Scale, or any combination of these. However, not all combinations are valid. Validity is enforced only once ManipulationModes is used by a specific control, so issues with setting an invalid combination of ManipulationModes might not appear until run-time when values are applied.

  • Don't combine Translate* values with TranslateRails* values, these are treated as mutually exclusive values.
  • Don't combine the inertial values with the non-inertial values.
  • The All value isn't the true additive value of all the flags (if values are compared bitwise). A value of All doesn't necessarily indicate that the combination of all the values is valid either, or that any specific value is set.

Notes for previous versions

Windows 8.x On Windows 8, setting ManipulationMode to a value that combines System with any other value will throw an exception, so some of the combinations mentioned above won't work for Windows 8. Starting with Windows 8.1, you can combine System with other values.

Apps that were compiled for Windows 8 but running on Windows 8.1 use the new behavior and permit combining System with other values.

-examples

-see-also

ManipulationStarted, ManipulationDelta, ManipulationCompleted, ManipulationModes, Handle pointer input, Direct Manipulation Reference, Basic input sample (Windows 10)