TeachingTip Class

Definition

A teaching tip is a semi-persistent and content-rich flyout that provides contextual information. It is often used for informing, reminding, and teaching users about important and new features that may enhance their experience.

class TeachingTip : ContentControl
[Microsoft.UI.Xaml.CustomAttributes.MUXContractProperty(version=0)]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallback(enable=true)]
[Microsoft.UI.Xaml.CustomAttributes.MUXPropertyChangedCallbackMethodName(value="OnPropertyChanged")]
[Windows.Foundation.Metadata.Composable(typeof(Microsoft.UI.Xaml.Controls.ITeachingTipFactory), Windows.Foundation.Metadata.CompositionType.Public, 1)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Static(typeof(Microsoft.UI.Xaml.Controls.ITeachingTipStatics), 1)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
[Windows.Foundation.Metadata.Version(1)]
[Windows.Foundation.Metadata.WebHostHidden]
public class TeachingTip : ContentControl
Public Class TeachingTip
Inherits ContentControl
Inheritance
TeachingTip
Attributes

Examples

Tip

For more info, design guidance, and code examples, see Teaching tip.

If you have the XAML Controls Gallery app installed, click here to open the app and see the TeachingTip in action.

Constructors

TeachingTip()

Initializes a new instance of the TeachingTip class.

Properties

ActionButtonCommand

Gets or sets the command to invoke when the action button is clicked.

ActionButtonCommandParameter

Gets or sets the parameter to pass to the command for the action button.

ActionButtonCommandParameterProperty

Identifies the ActionButtonCommandParameter dependency property.

ActionButtonCommandProperty

Identifies the ActionButtonCommand dependency property.

ActionButtonContent

Gets or sets the text of the teaching tip's action button.

ActionButtonContentProperty

Identifies the ActionButtonContent dependency property.

ActionButtonStyle

Gets or sets the Style to apply to the action button.

ActionButtonStyleProperty

Identifies the ActionButtonStyle dependency property.

CloseButtonCommand

Gets or sets the command to invoke when the close button is clicked.

CloseButtonCommandParameter

Gets or sets the parameter to pass to the command for the close button.

CloseButtonCommandParameterProperty

Identifies the CloseButtonCommandParameter dependency property.

CloseButtonCommandProperty

Identifies the CloseButtonCommand dependency property.

CloseButtonContent

Gets or sets the content of the teaching tip's close button.

CloseButtonContentProperty

Identifies the CloseButtonContent dependency property.

CloseButtonStyle

Gets or sets the Style to apply to the teaching tip's close button.

CloseButtonStyleProperty

Identifies the CloseButtonStyle dependency property.

HeroContent

Border-to-border graphic content displayed in the header or footer of the teaching tip. Will appear opposite of the tail in targeted teaching tips unless otherwise set.

HeroContentPlacement

Placement of the hero content within the teaching tip.

HeroContentPlacementProperty

Identifies the HeroContentPlacement dependency property.

HeroContentProperty

Identifies the HeroContent dependency property.

IconSource

Gets or sets the graphic content to appear alongside the title and subtitle.

IconSourceProperty

Identifies the IconSource dependency property.

IsLightDismissEnabled

Enables light-dismiss functionality so that a teaching tip will dismiss when a user scrolls or interacts with other elements of the application.

IsLightDismissEnabledProperty

Identifies the IsLightDismissEnabled dependency property.

IsOpen

Gets or sets a value that indicates whether the teaching tip is open.

IsOpenProperty

Identifies the IsOpen dependency property.

PlacementMargin

Adds a margin between a targeted teaching tip and its target or between a non-targeted teaching tip and the xaml root.

PlacementMarginProperty

Identifies the PlacementMargin dependency property.

PreferredPlacement

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.

PreferredPlacementProperty

Identifies the PreferredPlacement dependency property.

ShouldConstrainToRootBounds

Gets or sets a value that indicates whether the teaching tip will constrain to the bounds of its xaml root.

ShouldConstrainToRootBoundsProperty

Identifies the ShouldConstrainToRootBounds dependency property.

Subtitle

Gets or sets the subtitle of the teaching tip.

SubtitleProperty

Identifies the Subtitle dependency property.

TailVisibility

Toggles collapse of a teaching tip's tail. Can be used to override auto behavior to make a tail visible on a non-targeted teaching tip and hidden on a targeted teaching tip.

TailVisibilityProperty

Identifies the TailVisibility dependency property.

Target

Sets the target for a teaching tip to position itself relative to and point at with its tail.

TargetProperty

Identifies the Target dependency property.

TemplateSettings

Provides calculated values that can be referenced as TemplatedParent sources when defining templates for a TeachingTip.

TemplateSettingsProperty

Identifies the TemplateSettings dependency property.

Title

Gets or sets the title of the teaching tip.

TitleProperty

Identifies the Title dependency property.

Events

ActionButtonClick

Occurs after the action button is clicked.

CloseButtonClick

Occurs after the close button is clicked.

Closed

Occurs after the tip is closed.

Closing

Occurs just before the tip begins to close.

Applies to