TeachingTip.PreferredPlacement Property

Definition

Namespace:

Microsoft.UI.Xaml.Controls

Preferred placement to be used for the teaching tip. If there is not enough space to show at the preferred placement, a new placement will be automatically chosen. Placement is relative to its target if Target is non-null or to the parent window of the teaching tip if Target is null.

public:
 property TeachingTipPlacementMode PreferredPlacement { TeachingTipPlacementMode get(); void set(TeachingTipPlacementMode value); };

/// [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="winrt::TeachingTipPlacementMode::Auto")]
/// [get: Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="winrt::TeachingTipPlacementMode::Auto")]
/// [set: Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="winrt::TeachingTipPlacementMode::Auto")]
TeachingTipPlacementMode PreferredPlacement();

void PreferredPlacement(TeachingTipPlacementMode value);

[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="winrt::TeachingTipPlacementMode::Auto")]
public TeachingTipPlacementMode PreferredPlacement { [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="winrt::TeachingTipPlacementMode::Auto")] get; [Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValue(value="winrt::TeachingTipPlacementMode::Auto")] set; }

var teachingTipPlacementMode = teachingTip.preferredPlacement;
teachingTip.preferredPlacement = teachingTipPlacementMode;

Public Property PreferredPlacement As TeachingTipPlacementMode

Property Value

TeachingTipPlacementMode

Attributes

Microsoft.UI.Xaml.CustomAttributes.MUXPropertyDefaultValueAttribute

Remarks

Teaching tip replicates Flyout's FlyoutPlacementMode placement behavior with the TeachingTipPlacementMode property. The default placement mode will try to place a targeted teaching tip above its target and a non-targeted teaching tip centered at the bottom of the xaml root. As with Flyout, if the preferred placement mode would not leave room for the teaching tip to show, another placement mode will be automatically chosen.

If you anticipate that your app will be used with game controller input, please see gamepad and remote control interactions. It is encouraged to test game controller accessibility of each teaching tip using all possible configurations of an app's UI.