Show / Hide Table of Contents

Class TitleBar

TitleBar control.

Inheritance
object
DependencyObject
UIElement
FrameworkElement
Control
TitleBar
Implements
IEquatable<DependencyObject>
IAnimationObject
IVisualElement
IVisualElement2
IEquatable<UIElement>
IEquatable<FrameworkElement>
IWinRTObject
IDynamicInterfaceCastable
IEquatable<Control>
Inherited Members
Control.As<I>()
Control.GetIsTemplateFocusTarget(FrameworkElement)
Control.SetIsTemplateFocusTarget(FrameworkElement, bool)
Control.GetIsTemplateKeyTipTarget(DependencyObject)
Control.SetIsTemplateKeyTipTarget(DependencyObject, bool)
Control.FromAbi(nint)
Control.Equals(Control)
Control.Equals(object)
Control.GetHashCode()
Control.RemoveFocusEngagement()
Control.ApplyTemplate()
Control.GetTemplateChild(string)
Control.OnPointerEntered(PointerRoutedEventArgs)
Control.OnPointerPressed(PointerRoutedEventArgs)
Control.OnPointerMoved(PointerRoutedEventArgs)
Control.OnPointerReleased(PointerRoutedEventArgs)
Control.OnPointerExited(PointerRoutedEventArgs)
Control.OnPointerCaptureLost(PointerRoutedEventArgs)
Control.OnPointerCanceled(PointerRoutedEventArgs)
Control.OnPointerWheelChanged(PointerRoutedEventArgs)
Control.OnTapped(TappedRoutedEventArgs)
Control.OnDoubleTapped(DoubleTappedRoutedEventArgs)
Control.OnHolding(HoldingRoutedEventArgs)
Control.OnRightTapped(RightTappedRoutedEventArgs)
Control.OnManipulationStarting(ManipulationStartingRoutedEventArgs)
Control.OnManipulationInertiaStarting(ManipulationInertiaStartingRoutedEventArgs)
Control.OnManipulationStarted(ManipulationStartedRoutedEventArgs)
Control.OnManipulationDelta(ManipulationDeltaRoutedEventArgs)
Control.OnManipulationCompleted(ManipulationCompletedRoutedEventArgs)
Control.OnKeyUp(KeyRoutedEventArgs)
Control.OnKeyDown(KeyRoutedEventArgs)
Control.OnPreviewKeyDown(KeyRoutedEventArgs)
Control.OnPreviewKeyUp(KeyRoutedEventArgs)
Control.OnGotFocus(RoutedEventArgs)
Control.OnLostFocus(RoutedEventArgs)
Control.OnCharacterReceived(CharacterReceivedRoutedEventArgs)
Control.OnDragEnter(DragEventArgs)
Control.OnDragLeave(DragEventArgs)
Control.OnDragOver(DragEventArgs)
Control.OnDrop(DragEventArgs)
Control.IsOverridableInterface(Guid)
Control.BackgroundProperty
Control.BackgroundSizingProperty
Control.BorderBrushProperty
Control.BorderThicknessProperty
Control.CharacterSpacingProperty
Control.CornerRadiusProperty
Control.DefaultStyleKeyProperty
Control.DefaultStyleResourceUriProperty
Control.ElementSoundModeProperty
Control.FontFamilyProperty
Control.FontSizeProperty
Control.FontStretchProperty
Control.FontStyleProperty
Control.FontWeightProperty
Control.ForegroundProperty
Control.HorizontalContentAlignmentProperty
Control.IsEnabledProperty
Control.IsFocusEngagedProperty
Control.IsFocusEngagementEnabledProperty
Control.IsTemplateFocusTargetProperty
Control.IsTemplateKeyTipTargetProperty
Control.IsTextScaleFactorEnabledProperty
Control.PaddingProperty
Control.RequiresPointerProperty
Control.TabNavigationProperty
Control.TemplateProperty
Control.VerticalContentAlignmentProperty
Control.Background
Control.BackgroundSizing
Control.BorderBrush
Control.BorderThickness
Control.CharacterSpacing
Control.CornerRadius
Control.DefaultStyleKey
Control.DefaultStyleResourceUri
Control.ElementSoundMode
Control.FontFamily
Control.FontSize
Control.FontStretch
Control.FontStyle
Control.FontWeight
Control.Foreground
Control.HorizontalContentAlignment
Control.IsEnabled
Control.IsFocusEngaged
Control.IsFocusEngagementEnabled
Control.IsTextScaleFactorEnabled
Control.Padding
Control.RequiresPointer
Control.TabNavigation
Control.Template
Control.VerticalContentAlignment
Control.FocusDisengaged
Control.FocusEngaged
Control.IsEnabledChanged
FrameworkElement.DeferTree(DependencyObject)
FrameworkElement.Equals(FrameworkElement)
FrameworkElement.FindName(string)
FrameworkElement.SetBinding(DependencyProperty, BindingBase)
FrameworkElement.GetBindingExpression(DependencyProperty)
FrameworkElement.InvalidateViewport()
FrameworkElement.MeasureOverride(Size)
FrameworkElement.ArrangeOverride(Size)
FrameworkElement.GoToElementStateCore(string, bool)
FrameworkElement.ActualHeightProperty
FrameworkElement.ActualThemeProperty
FrameworkElement.ActualWidthProperty
FrameworkElement.AllowFocusOnInteractionProperty
FrameworkElement.AllowFocusWhenDisabledProperty
FrameworkElement.DataContextProperty
FrameworkElement.FlowDirectionProperty
FrameworkElement.FocusVisualMarginProperty
FrameworkElement.FocusVisualPrimaryBrushProperty
FrameworkElement.FocusVisualPrimaryThicknessProperty
FrameworkElement.FocusVisualSecondaryBrushProperty
FrameworkElement.FocusVisualSecondaryThicknessProperty
FrameworkElement.HeightProperty
FrameworkElement.HorizontalAlignmentProperty
FrameworkElement.LanguageProperty
FrameworkElement.MarginProperty
FrameworkElement.MaxHeightProperty
FrameworkElement.MaxWidthProperty
FrameworkElement.MinHeightProperty
FrameworkElement.MinWidthProperty
FrameworkElement.NameProperty
FrameworkElement.RequestedThemeProperty
FrameworkElement.StyleProperty
FrameworkElement.TagProperty
FrameworkElement.VerticalAlignmentProperty
FrameworkElement.WidthProperty
FrameworkElement.ActualHeight
FrameworkElement.ActualTheme
FrameworkElement.ActualWidth
FrameworkElement.AllowFocusOnInteraction
FrameworkElement.AllowFocusWhenDisabled
FrameworkElement.BaseUri
FrameworkElement.DataContext
FrameworkElement.FlowDirection
FrameworkElement.FocusVisualMargin
FrameworkElement.FocusVisualPrimaryBrush
FrameworkElement.FocusVisualPrimaryThickness
FrameworkElement.FocusVisualSecondaryBrush
FrameworkElement.FocusVisualSecondaryThickness
FrameworkElement.Height
FrameworkElement.HorizontalAlignment
FrameworkElement.IsLoaded
FrameworkElement.Language
FrameworkElement.Margin
FrameworkElement.MaxHeight
FrameworkElement.MaxWidth
FrameworkElement.MinHeight
FrameworkElement.MinWidth
FrameworkElement.Name
FrameworkElement.Parent
FrameworkElement.RequestedTheme
FrameworkElement.Resources
FrameworkElement.Style
FrameworkElement.Tag
FrameworkElement.Triggers
FrameworkElement.VerticalAlignment
FrameworkElement.Width
FrameworkElement.ActualThemeChanged
FrameworkElement.DataContextChanged
FrameworkElement.EffectiveViewportChanged
FrameworkElement.LayoutUpdated
FrameworkElement.Loaded
FrameworkElement.Loading
FrameworkElement.SizeChanged
FrameworkElement.Unloaded
UIElement.TryStartDirectManipulation(Pointer)
UIElement.RegisterAsScrollPort(UIElement)
UIElement.Equals(UIElement)
UIElement.Measure(Size)
UIElement.Arrange(Rect)
UIElement.CapturePointer(Pointer)
UIElement.ReleasePointerCapture(Pointer)
UIElement.ReleasePointerCaptures()
UIElement.AddHandler(RoutedEvent, object, bool)
UIElement.RemoveHandler(RoutedEvent, object)
UIElement.TransformToVisual(UIElement)
UIElement.InvalidateMeasure()
UIElement.InvalidateArrange()
UIElement.UpdateLayout()
UIElement.CancelDirectManipulations()
UIElement.StartDragAsync(PointerPoint)
UIElement.StartBringIntoView()
UIElement.StartBringIntoView(BringIntoViewOptions)
UIElement.TryInvokeKeyboardAccelerator(ProcessKeyboardAcceleratorEventArgs)
UIElement.Focus(FocusState)
UIElement.StartAnimation(ICompositionAnimationBase)
UIElement.StopAnimation(ICompositionAnimationBase)
UIElement.OnDisconnectVisualChildren()
UIElement.FindSubElementsForTouchTargeting(Point, Rect)
UIElement.GetChildrenInTabFocusOrder()
UIElement.OnKeyboardAcceleratorInvoked(KeyboardAcceleratorInvokedEventArgs)
UIElement.OnProcessKeyboardAccelerators(ProcessKeyboardAcceleratorEventArgs)
UIElement.OnBringIntoViewRequested(BringIntoViewRequestedEventArgs)
UIElement.PopulatePropertyInfoOverride(string, AnimationPropertyInfo)
UIElement.PopulatePropertyInfo(string, AnimationPropertyInfo)
UIElement.GetVisualInternal()
UIElement.AccessKeyProperty
UIElement.AccessKeyScopeOwnerProperty
UIElement.AllowDropProperty
UIElement.BringIntoViewRequestedEvent
UIElement.CacheModeProperty
UIElement.CanBeScrollAnchorProperty
UIElement.CanDragProperty
UIElement.CharacterReceivedEvent
UIElement.ClipProperty
UIElement.CompositeModeProperty
UIElement.ContextFlyoutProperty
UIElement.ContextRequestedEvent
UIElement.DoubleTappedEvent
UIElement.DragEnterEvent
UIElement.DragLeaveEvent
UIElement.DragOverEvent
UIElement.DropEvent
UIElement.ExitDisplayModeOnAccessKeyInvokedProperty
UIElement.FocusStateProperty
UIElement.GettingFocusEvent
UIElement.HighContrastAdjustmentProperty
UIElement.HoldingEvent
UIElement.IsAccessKeyScopeProperty
UIElement.IsDoubleTapEnabledProperty
UIElement.IsHitTestVisibleProperty
UIElement.IsHoldingEnabledProperty
UIElement.IsRightTapEnabledProperty
UIElement.IsTabStopProperty
UIElement.IsTapEnabledProperty
UIElement.KeyDownEvent
UIElement.KeyTipHorizontalOffsetProperty
UIElement.KeyTipPlacementModeProperty
UIElement.KeyTipTargetProperty
UIElement.KeyTipVerticalOffsetProperty
UIElement.KeyUpEvent
UIElement.KeyboardAcceleratorPlacementModeProperty
UIElement.KeyboardAcceleratorPlacementTargetProperty
UIElement.LightsProperty
UIElement.LosingFocusEvent
UIElement.ManipulationCompletedEvent
UIElement.ManipulationDeltaEvent
UIElement.ManipulationInertiaStartingEvent
UIElement.ManipulationModeProperty
UIElement.ManipulationStartedEvent
UIElement.ManipulationStartingEvent
UIElement.NoFocusCandidateFoundEvent
UIElement.OpacityProperty
UIElement.PointerCanceledEvent
UIElement.PointerCaptureLostEvent
UIElement.PointerCapturesProperty
UIElement.PointerEnteredEvent
UIElement.PointerExitedEvent
UIElement.PointerMovedEvent
UIElement.PointerPressedEvent
UIElement.PointerReleasedEvent
UIElement.PointerWheelChangedEvent
UIElement.PreviewKeyDownEvent
UIElement.PreviewKeyUpEvent
UIElement.ProjectionProperty
UIElement.RenderTransformOriginProperty
UIElement.RenderTransformProperty
UIElement.RightTappedEvent
UIElement.ShadowProperty
UIElement.TabFocusNavigationProperty
UIElement.TabIndexProperty
UIElement.TappedEvent
UIElement.Transform3DProperty
UIElement.TransitionsProperty
UIElement.UseLayoutRoundingProperty
UIElement.UseSystemFocusVisualsProperty
UIElement.VisibilityProperty
UIElement.XYFocusDownNavigationStrategyProperty
UIElement.XYFocusDownProperty
UIElement.XYFocusKeyboardNavigationProperty
UIElement.XYFocusLeftNavigationStrategyProperty
UIElement.XYFocusLeftProperty
UIElement.XYFocusRightNavigationStrategyProperty
UIElement.XYFocusRightProperty
UIElement.XYFocusUpNavigationStrategyProperty
UIElement.XYFocusUpProperty
UIElement.AccessKey
UIElement.AccessKeyScopeOwner
UIElement.ActualOffset
UIElement.ActualSize
UIElement.AllowDrop
UIElement.CacheMode
UIElement.CanBeScrollAnchor
UIElement.CanDrag
UIElement.CenterPoint
UIElement.Clip
UIElement.CompositeMode
UIElement.ContextFlyout
UIElement.DesiredSize
UIElement.ExitDisplayModeOnAccessKeyInvoked
UIElement.FocusState
UIElement.HighContrastAdjustment
UIElement.IsAccessKeyScope
UIElement.IsDoubleTapEnabled
UIElement.IsHitTestVisible
UIElement.IsHoldingEnabled
UIElement.IsRightTapEnabled
UIElement.IsTabStop
UIElement.IsTapEnabled
UIElement.KeyTipHorizontalOffset
UIElement.KeyTipPlacementMode
UIElement.KeyTipTarget
UIElement.KeyTipVerticalOffset
UIElement.KeyboardAcceleratorPlacementMode
UIElement.KeyboardAcceleratorPlacementTarget
UIElement.KeyboardAccelerators
UIElement.Lights
UIElement.ManipulationMode
UIElement.Opacity
UIElement.OpacityTransition
UIElement.PointerCaptures
UIElement.Projection
UIElement.ProtectedCursor
UIElement.RasterizationScale
UIElement.RenderSize
UIElement.RenderTransform
UIElement.RenderTransformOrigin
UIElement.Rotation
UIElement.RotationAxis
UIElement.RotationTransition
UIElement.Scale
UIElement.ScaleTransition
UIElement.Shadow
UIElement.TabFocusNavigation
UIElement.TabIndex
UIElement.Transform3D
UIElement.TransformMatrix
UIElement.Transitions
UIElement.Translation
UIElement.TranslationTransition
UIElement.UseLayoutRounding
UIElement.UseSystemFocusVisuals
UIElement.Visibility
UIElement.XYFocusDown
UIElement.XYFocusDownNavigationStrategy
UIElement.XYFocusKeyboardNavigation
UIElement.XYFocusLeft
UIElement.XYFocusLeftNavigationStrategy
UIElement.XYFocusRight
UIElement.XYFocusRightNavigationStrategy
UIElement.XYFocusUp
UIElement.XYFocusUpNavigationStrategy
UIElement.XamlRoot
UIElement.AccessKeyDisplayDismissed
UIElement.AccessKeyDisplayRequested
UIElement.AccessKeyInvoked
UIElement.BringIntoViewRequested
UIElement.CharacterReceived
UIElement.ContextCanceled
UIElement.ContextRequested
UIElement.DoubleTapped
UIElement.DragEnter
UIElement.DragLeave
UIElement.DragOver
UIElement.DragStarting
UIElement.Drop
UIElement.DropCompleted
UIElement.GettingFocus
UIElement.GotFocus
UIElement.Holding
UIElement.KeyDown
UIElement.KeyUp
UIElement.LosingFocus
UIElement.LostFocus
UIElement.ManipulationCompleted
UIElement.ManipulationDelta
UIElement.ManipulationInertiaStarting
UIElement.ManipulationStarted
UIElement.ManipulationStarting
UIElement.NoFocusCandidateFound
UIElement.PointerCanceled
UIElement.PointerCaptureLost
UIElement.PointerEntered
UIElement.PointerExited
UIElement.PointerMoved
UIElement.PointerPressed
UIElement.PointerReleased
UIElement.PointerWheelChanged
UIElement.PreviewKeyDown
UIElement.PreviewKeyUp
UIElement.ProcessKeyboardAccelerators
UIElement.RightTapped
UIElement.Tapped
DependencyObject.Equals(DependencyObject)
DependencyObject.GetValue(DependencyProperty)
DependencyObject.SetValue(DependencyProperty, object)
DependencyObject.ClearValue(DependencyProperty)
DependencyObject.ReadLocalValue(DependencyProperty)
DependencyObject.GetAnimationBaseValue(DependencyProperty)
DependencyObject.RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)
DependencyObject.UnregisterPropertyChangedCallback(DependencyProperty, long)
DependencyObject.Dispatcher
DependencyObject.DispatcherQueue
object.Equals(object, object)
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: WinUIEx
Assembly: WinUIEx.dll
Syntax
[Obsolete("Use Windows App SDK's TitleBar control instead.")]
[WinRTRuntimeClassName("Microsoft.UI.Xaml.IUIElementOverrides")]
[WinRTExposedType(typeof(TitleBarWinRTTypeDetails))]
public class TitleBar : Control, IEquatable<DependencyObject>, IAnimationObject, IVisualElement, IVisualElement2, IEquatable<UIElement>, IEquatable<FrameworkElement>, IWinRTObject, IDynamicInterfaceCastable, IEquatable<Control>

Constructors

Name Description
TitleBar()

Initializes a new instance of the TitleBar class.

Fields

Name Description
ContentProperty

Identifies the Content dependency property.

FooterProperty

Identifies the Footer dependency property.

HeaderProperty

Identifies the Header dependency property.

IconSourceProperty

Identifies the IconSource dependency property.

IsBackButtonVisibleProperty

Identifies the IsBackButtonVisible dependency property.

IsBackEnabledProperty

Identifies the IsBackEnabled dependency property.

IsPaneToggleButtonVisibleProperty

Identifies the IsPaneToggleButtonVisible dependency property.

SubtitleProperty

Identifies the Subtitle dependency property.

TemplateSettingsProperty

Identifies the TemplateSettings dependency property.

TitleProperty

Identifies the Title dependency property.

Properties

Name Description
Content

Gets or sets the content for the titlebar

Footer

Gets or sets the footer of the titlebar

Header

Gets or sets the Header content for the titlebar

IconSource

Gets or sets the Icon for the titlebar

IsBackButtonVisible

Gets or sets a value indicating whether the back button is visible

IsBackEnabled

Gets or sets a value indicating whether the back button is enabled

IsPaneToggleButtonVisible

Gets or sets a value indicating whether the pane toggle button is visible

Subtitle

Gets or sets the Subtitle for the titlebar

TemplateSettings

Gets the template settings for the titlebar

Title

Gets or sets the Window title

Methods

Name Description
~TitleBar()

Finalizer

OnApplyTemplate()

Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class.

OnCreateAutomationPeer()

When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure.

Events

Name Description
BackRequested

Raised when the back button is clicked

PaneToggleRequested

Raised when the Pane toggle button is clicked

In this article
Back to top Generated by DocFX