InteractionChainingMode Enum
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Defines the chaining behavior for a VisualInteractionSource. There are three options: Always chain, never chain or auto chain (let the system choose). If chaining is enabled, when an InteractionTracker reaches its minimum or maximum bounds, it will instead send the input to the next ancestor VisualInteractionSource.
public enum class InteractionChainingMode
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.LiftedContract, 65536)]
enum class InteractionChainingMode
/// [Windows.Foundation.Metadata.ContractVersion(Microsoft.Foundation.WindowsAppSDKContract, 65536)]
enum class InteractionChainingMode
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.LiftedContract), 65536)]
public enum InteractionChainingMode
[Windows.Foundation.Metadata.ContractVersion(typeof(Microsoft.Foundation.WindowsAppSDKContract), 65536)]
public enum InteractionChainingMode
var value = Microsoft.UI.Composition.Interactions.InteractionChainingMode.auto
Public Enum InteractionChainingMode
- Inheritance
-
InteractionChainingMode
- Attributes
Fields
Name | Value | Description |
---|---|---|
Auto | 0 | Automatically determine whether to continue the manipulation. |
Always | 1 | Always continue the manipulation. |
Never | 2 | Never continue the manipulation. |
Examples
void SetupInteractionSource(ContainerVisual container, InteractionTracker tracker)
{
// Setup the Interaction Source
_interactionSource = VisualInteractionSource.Create(container);
// Define Chaining modes for X, Y, and Scale.
_interactionSource.PositionXChainingMode = InteractionChainingMode.Never;
_interactionSource.PositionYChainingMode = InteractionChainingMode.Always;
_interactionSource.ScaleChainingMode = InteractionChainingMode.Auto;
// Attach the VisualInteractionSource to InteractionTracker
tracker.InteractionSources.Add(_interactionSource);
}
Remarks
When an InteractionTracker reaches either its minimum or maximum bounds, it will either overpan or chain the input up to its next ancestor VisualInteractionSource.
The picture below demonstrates a scenario where there may be a VisualInteractionSource (B) who is the child of another VisualInteractionSource (A). In this scenario, both elements are scrollable content – when the InteractionTracker in B reaches the boundary and chaining is enabled on B, the input will chain to A whose content will now begin to scroll.
Note
In these situations with chaining enabled, the input can chain from an InteractionTracker to an InteractionTracker, from an InteractionTracker to a XAML ScrollViewer, or from an InteractionTracker to a CoreWindow.