CommandBarTemplateSettings Class

Definition

Provides calculated values that can be referenced as TemplatedParent sources when defining templates for a CommandBar control. Not intended for general use.

Equivalent WinUI class: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.

public ref class CommandBarTemplateSettings sealed : DependencyObject
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class CommandBarTemplateSettings final : DependencyObject
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class CommandBarTemplateSettings : DependencyObject
Public NotInheritable Class CommandBarTemplateSettings
Inherits DependencyObject
Inheritance
Object IInspectable DependencyObject CommandBarTemplateSettings
Attributes

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

Version history

Windows version SDK version Value added
1511 10586 OverflowContentMaxWidth
1607 14393 EffectiveOverflowButtonVisibility
1903 18362 OverflowContentCompactYTranslation
1903 18362 OverflowContentHiddenYTranslation
1903 18362 OverflowContentMinimalYTranslation

Properties

ContentHeight

Gets the height of the CommandBar content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.ContentHeight.

Dispatcher

Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread.

Equivalent WinUI property: Microsoft.UI.Xaml.DependencyObject.Dispatcher.

(Inherited from DependencyObject)
EffectiveOverflowButtonVisibility

Gets the effective visibility of the command bar's overflow button.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.EffectiveOverflowButtonVisibility.

NegativeOverflowContentHeight

Gets the height of the overflow content when the overflow direction is negative.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.NegativeOverflowContentHeight.

OverflowContentClipRect

Gets the Rect that describes the clipped area of the overflow content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentClipRect.

OverflowContentCompactYTranslation

Gets the translation of the overflow content on the Y-axis in the compact state.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentCompactYTranslation.

OverflowContentHeight

Gets the height of the overflow content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentHeight.

OverflowContentHiddenYTranslation

Gets the translation of the overflow content on the Y-axis in the hidden state.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentHiddenYTranslation.

OverflowContentHorizontalOffset

Gets the horizontal offset value of the overflow content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentHorizontalOffset.

OverflowContentMaxHeight

Gets the maximum height value of the overflow content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentMaxHeight.

OverflowContentMaxWidth

Gets the maximum width value of the overflow content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentMaxWidth.

OverflowContentMinimalYTranslation

Gets the translation of the overflow content on the Y-axis in the minimal state.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentMinimalYTranslation.

OverflowContentMinWidth

Gets the minimum width value of the overflow content.

Equivalent WinUI property: Microsoft.UI.Xaml.Controls.Primitives.CommandBarTemplateSettings.OverflowContentMinWidth.

Methods

ClearValue(DependencyProperty)

Clears the local value of a dependency property.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ClearValue.

(Inherited from DependencyObject)
GetAnimationBaseValue(DependencyProperty)

Returns any base value established for a dependency property, which would apply in cases where an animation is not active.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetAnimationBaseValue.

(Inherited from DependencyObject)
GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.GetValue.

(Inherited from DependencyObject)
ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.ReadLocalValue.

(Inherited from DependencyObject)
RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback)

Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.RegisterPropertyChangedCallback.

(Inherited from DependencyObject)
SetValue(DependencyProperty, Object)

Sets the local value of a dependency property on a DependencyObject.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.SetValue.

(Inherited from DependencyObject)
UnregisterPropertyChangedCallback(DependencyProperty, Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

Equivalent WinUI method: Microsoft.UI.Xaml.DependencyObject.UnregisterPropertyChangedCallback.

(Inherited from DependencyObject)

Applies to

See also