AppBarToggleButton Class

Initializes a new instance of the AppBarToggleButton class.

Gets or sets the access key (mnemonic) for this element.

Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element.

Gets the rendered height of a FrameworkElement. See Remarks.

Gets the position of this UIElement, relative to its parent, computed during the arrange pass of the layout process.

Gets the size that this UIElement computed during the arrange pass of the layout process.

Gets the UI theme that is currently used by the element, which might be different than the RequestedTheme.

Gets the rendered width of a FrameworkElement. See Remarks.

Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations.

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

Gets or sets whether a disabled control can receive focus.

Gets or sets a brush that provides the background of the control.

Gets or sets a value that indicates how far the background extends in relation to this element's border.

Gets a Uniform Resource Identifier (URI) that represents the base URI for an XAML-constructed object at XAML load time. This property is useful for URI resolution at run time.

Gets or sets a brush that describes the border fill of a control.

Gets or sets the border thickness of a control.

Gets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible.

Gets or sets a value that indicates whether the UIElement can be a candidate for scroll anchoring.

Gets or sets a value that indicates whether the element can be dragged as data in a drag-and-drop operation.

Gets or sets the center point of the element, which is the point about which rotation or scaling occurs. Affects the rendering position of the element.

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

Gets or sets a value that indicates when the Click event occurs, in terms of device behavior.

Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement.

Gets or sets the command to invoke when this button is pressed.

Gets or sets the parameter to pass to the Command property.

Gets or sets a property that declares alternate composition and blending modes for the element in its parent layout and window. This is relevant for elements that are involved in a mixed XAML / Microsoft DirectX UI.

Gets or sets the content of a ContentControl.

Gets or sets the data template that is used to display the content of the ContentControl.

Gets the root element of the data template specified by the ContentTemplate property.

Gets or sets a selection object that changes the DataTemplate to apply for content, based on processing information about the content item or its container at run time.

Gets or sets the collection of Transition style elements that apply to the content of a ContentControl.

Gets or sets the flyout associated with this element.

Gets or sets the radius for the corners of the control's border.

Gets or sets the data context for a FrameworkElement. A common use of a data context is when a FrameworkElement uses the {Binding} markup extension and participates in data binding.

Gets or sets the key that references the default style for the control. Authors of custom controls use this property to change the default for the style that their control uses.

Gets or sets the path to the resource file that contains the default style for the control.

Gets the size that this UIElement computed during the measure pass of the layout process.

Always returns null in a Windows App SDK app. Use DispatcherQueue instead.

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

Gets or sets the order in which this item is moved to the CommandBar overflow menu.

Identifies the DynamicOverflowOrder dependency property.

Get or sets a value that specifies a control's preference for whether sounds are played.

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. This property can be set to either LeftToRight or RightToLeft. Setting FlowDirection to RightToLeft on any element sets the alignment to the right, the reading order to right-to-left and the layout of the control to flow from right to left.

Gets a value that specifies whether this control has focus, and the mode by which focus was obtained.

Gets or sets the outer margin of the focus visual for a FrameworkElement.

Gets or sets the brush used to draw the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Gets or sets the thickness of the outer border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Gets or sets the brush used to draw the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Gets or sets the thickness of the inner border of a HighVisibility or Reveal focus visual for a FrameworkElement.

Gets or sets the font used to display text in the control.

Gets or sets the size of the text in this control.

Gets or sets the degree to which a font is condensed or expanded on the screen.

Gets or sets the style in which the text is rendered.

Gets or sets the thickness of the specified font.

Gets or sets a brush that describes the foreground color.

Gets or sets the suggested height of a FrameworkElement.

Gets or sets a value that indicates whether the framework automatically adjusts the element's visual properties when high contrast themes are enabled.

Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control.

Gets or sets the horizontal alignment of the control's content.

Gets or sets the graphic content of the app bar toggle button.

Identifies the Icon dependency property.

Gets or sets a value that indicates whether an element defines its own access key scope.

Gets or sets whether the ToggleButton is checked.

Gets or sets a value that indicates whether the button is shown with no label and reduced padding.

Identifies the IsCompact dependency property.

Gets or sets a value that determines whether the DoubleTapped event can originate from that element.

Gets or sets a value indicating whether the user can interact with the control.

Get or sets a value that indicates whether focus is constrained to the control when the user presses the A/Select button on a game controller.

Get or sets a value that indicates whether focus can be constrained to the control when the user presses the A/Select button on a game controller.

Gets or sets whether the contained area of this UIElement can return true values for hit testing.

Gets or sets a value that determines whether the Holding event can originate from that element.

Gets a value that indicates whether this item is in the overflow menu.

Identifies the IsInOverflow dependency property.

Gets a value that indicates whether the element has been added to the element tree and is ready for interaction.

Gets a value that indicates whether a device pointer is located over this button control.

Gets a value that indicates whether a ButtonBase is currently in a pressed state.

Gets or sets a value that determines whether the RightTapped event can originate from that element.

Gets or sets a value that indicates whether a control is included in tab navigation.

Gets or sets a value that determines whether the Tapped event can originate from that element.

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

Gets or sets a value that indicates whether the control supports three states.

Gets or sets a value that indicates whether the control tooltip displays the key combination for its associated keyboard accelerator.

Gets or sets a value that indicates the control tooltip that displays the accelerator key combination.

Gets the collection of key combinations that invoke an action using the keyboard.

Accelerators are typically assigned to buttons or menu items.

Example of a menu showing keyboard accelerators for various menu items

Gets or sets a string that overrides the default key combination string associated with a keyboard accelerator.

Example of a menu showing keyboard accelerators for various menu items

Identifies the AppBarToggleButton.KeyboardAcceleratorTextOverride dependency property.

Gets or sets a value that indicates how far left or right the Key Tip is placed in relation to the UIElement.

Gets or sets a value that indicates where the access key Key Tip is placed in relation to the boundary of the UIElement.

Gets or sets a value that indicates the element targeted by the access key Key Tip.

Gets or sets a value that indicates how far up or down the Key Tip is placed in relation to the UI element.

Gets or sets the text description displayed on the app bar toggle button.

Gets or sets a value that indicates the placement and visibility of the button's label.

Identifies the LabelPosition dependency property.

Identifies the Label dependency property.

Gets or sets localization/globalization language information that applies to a FrameworkElement, and also to all child elements of the current FrameworkElement in the object representation and in UI.

Gets the collection of XamlLight objects attached to this element.

Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. Setting this value enables handling the manipulation events from this element in app code.

Gets or sets the outer margin of a FrameworkElement.

Gets or sets the maximum height constraint of a FrameworkElement.

Gets or sets the maximum width constraint of a FrameworkElement.

Gets or sets the minimum height constraint of a FrameworkElement.

Gets or sets the minimum width constraint of a FrameworkElement.

Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name.

Gets or sets the degree of the object's opacity.

Gets or sets the ScalarTransition that animates changes to the Opacity property.

Gets or sets the padding inside a control.

Gets the parent object of this FrameworkElement in the object tree.

Gets the set of all captured pointers, represented as Pointer values.

Gets or sets the perspective projection (3-D effect) to apply when rendering this element.

Gets or sets the cursor that displays when the pointer is over this element. Defaults to null, indicating no change to the cursor.

Gets a value that represents the number of raw (physical) pixels for each view pixel.

Gets the final render size of a UIElement. Use is not recommended, see Remarks.

Gets or sets transform information that affects the rendering position of a UIElement.

Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement.

Gets or sets the UI theme that is used by the UIElement (and its child elements) for resource determination. The UI theme you specify with RequestedTheme can override the app-level RequestedTheme.

Gets or sets whether a UI element supports mouse mode, which emulates pointer interaction experiences with non-pointer input devices such as a keyboard or game controller.

Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax.

Gets or sets the angle of clockwise rotation, in degrees. Rotates relative to the RotationAxis and the CenterPoint. Affects the rendering position of the element.

Gets or sets the axis to rotate the element around.

Gets or sets the ScalarTransition that animates changes to the Rotation property.

Gets or sets the scale of the element. Scales relative to the element's CenterPoint. Affects the rendering position of the element.

Gets or sets the Vector3Transition that animates changes to the Scale property.

Gets or sets the shadow effect cast by the element.

Gets or sets an instance Style that is applied for this object during layout and rendering.

Gets or sets a value that modifies how tabbing and TabIndex work for this control.

Gets or sets a value that determines the order in which elements receive focus when the user navigates through controls using the Tab key.

Gets or sets a value that modifies how tabbing and UIElement.TabIndex work for this control.

Gets or sets an arbitrary object value that can be used to store custom information about this object.

Gets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup.

Gets an object that provides calculated values that can be referenced as {TemplateBinding} markup extension sources when defining templates for an AppBarToggleButton control.

Gets or sets the 3-D transform effect to apply when rendering this element.

Gets or sets the transformation matrix to apply to the element.

Gets or sets the collection of Transition style elements that apply to a UIElement.

Gets or sets the x, y, and z rendering position of the element.

Gets or sets the Vector3Transition that animates changes to the Translation property.

Gets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. See Remarks.

Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels.

Gets or sets a value that indicates whether the control uses focus visuals drawn by the system or focus visuals defined in the control template.

Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control.

Gets or sets the vertical alignment of the control's content.

Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout.

Gets or sets the width of a FrameworkElement.

Gets or sets the XamlRoot in which this element is being viewed.

Gets or sets the object that gets focus when a user presses down on the Directional Pad (D-pad) of a game controller.

Gets or sets a value that specifies the strategy used to determine the target element of a down navigation.

Gets or sets a value that enables or disables navigation using the keyboard directional arrows.

Gets or sets the object that gets focus when a user presses left on the Directional Pad (D-pad) of a game controller.

Gets or sets a value that specifies the strategy used to determine the target element of a left navigation.

Gets or sets the object that gets focus when a user presses right on the Directional Pad (D-pad) of a game controller.

Gets or sets a value that specifies the strategy used to determine the target element of a right navigation.

Gets or sets the object that gets focus when a user presses up on the Directional Pad (D-pad) of a game controller.

Gets or sets a value that specifies the strategy used to determine the target element of an up navigation.

Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked even if the event is handled elsewhere.

Loads the relevant control template so that its parts can be referenced.

Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update.

Provides the behavior for the "Arrange" pass of layout. Classes can override this method to define their own "Arrange" pass behavior.

Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement.

Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events.

Clears the local value of a dependency property.

Retrieves an object that has the specified identifier name.

Enables a UIElement subclass to expose child elements that assist with resolving touch targeting.

Attempts to set focus to this element.

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

Returns the BindingExpression that represents the binding on the specified property.

Enables a UIElement subclass to expose child elements that take part in Tab focus.

Retrieves the named element in the instantiated ControlTemplate visual tree.

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

Retrieves the Visual that the element resolves to.

When implemented in a derived class, enables per-state construction of a visual tree for a control template in code, rather than by loading XAML for all states at control startup.

Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously.

Invalidates the measurement state (layout) for a UIElement.

Invalidates the viewport state for a UIElement that is used to calculate the effective viewport.

Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update.

Provides the behavior for the "Measure" pass of the layout cycle. Classes can override this method to define their own "Measure" pass behavior.

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.

Called before the BringIntoViewRequested event occurs.

Called before the CharacterReceived event occurs.

Invoked when the value of the Content property changes.

Invoked when the value of the ContentTemplate property changes.

Invoked when the value of the ContentTemplateSelector property changes.

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

Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property.

Called before the DoubleTapped event occurs.

Called before the DragEnter event occurs.

Called before the DragLeave event occurs.

Called before the DragOver event occurs.

Called before the Drop event occurs.

Called before the GotFocus event occurs.

Called before the Holding event occurs.

Called when a keyboard shortcut (or accelerator) is processed in your app. Override this method to handle how your app responds when a keyboard accelerator is invoked.

Called before the KeyDown event occurs.

Called before the KeyUp event occurs.

Called before the LostFocus event occurs.

Called before the ManipulationCompleted event occurs.

Called before the ManipulationDelta event occurs.

Called before the ManipulationInertiaStarting event occurs.

Called before the ManipulationStarted event occurs.

Called before the ManipulationStarting event occurs.

Called before the PointerCanceled event occurs.

Called before the PointerCaptureLost event occurs.

Called before the PointerEntered event occurs.

Called before the PointerExited event occurs.

Called before the PointerMoved event occurs.

Called before the PointerPressed event occurs.

Called before the PointerReleased event occurs.

Called before the PointerWheelChanged event occurs.

Called before the PreviewKeyDown event occurs.

Called before the PreviewKeyUp event occurs.

Called just before a keyboard shortcut (or accelerator) is processed in your app. Invoked whenever application code or internal processes call ProcessKeyboardAccelerators. Override this method to influence the default accelerator handling.

Called before the RightTapped event occurs.

Called before the Tapped event occurs.

Called when the ToggleButton receives toggle stimulus.

Defines a property that can be animated.

When overridden in a derived class, defines a property that can be animated.

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

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

Releases pointer captures for capture of one specific pointer by this UIElement.

Releases all pointer captures held by this element.

Releases the control from focus constraints that support game controller interactions (where IsFocusEngaged is true).

Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler.

Attaches a binding to a FrameworkElement, using the provided binding object.

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

Begins the specified animation on the element.

Initiates a request to the XAML framework to bring the element into view within any scrollable regions it is contained within.

Initiates a request to the XAML framework to bring the element into view using the specified options.

Initiates a drag-and-drop operation.

Stops the specified animation on the element.

Returns a transform object that can be used to transform coordinates from the UIElement to the specified object.

Attempts to invoke a keyboard shortcut (or accelerator) by searching the entire visual tree of the UIElement for the shortcut.

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

Ensures that all positions of child objects of a UIElement are properly updated for layout.

Occurs when access keys should no longer be displayed.

Occurs when the user requests that access keys be displayed.

Occurs when a user completes an access key sequence.

Occurs when the ActualTheme property value has changed.

Occurs when StartBringIntoView is called on this element or one of its descendants.

Occurs when a single, composed character is received by the input queue.

Fires when a ToggleButton is checked.

Occurs when a button control is clicked.

Occurs when a context input gesture continues into a manipulation gesture, to notify the element that the context flyout should not be opened.

Occurs when the user has completed a context input gesture, such as a right-click.

Occurs when the value of the FrameworkElement.DataContext property changes.

Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element.

Occurs when the input system reports an underlying drag event with this element as the target.

Occurs when the input system reports an underlying drag event with this element as the origin.

Occurs when the input system reports an underlying drag event with this element as the potential drop target.

Occurs when a drag operation is initiated.

Occurs when the input system reports an underlying drop event with this element as the drop target.

Occurs when a drag-and-drop operation with this element as the source is ended.

Occurs when the FrameworkElement's effective viewport changes.

Occurs as focus is released from the control when the user presses the B/Back button on a game controller.

Occurs as focus is constrained to the control when the user presses the A/Select button on a game controller.

Occurs before a UIElement receives focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Occurs when a UIElement receives focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element.

Fires when the state of a ToggleButton is switched to the indeterminate state.

Occurs when the IsEnabled property changes.

Occurs when a keyboard key is pressed while the UIElement has focus.

Occurs when a keyboard key is released while the UIElement has focus.

Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout.

Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction.

Occurs when a FrameworkElement begins to load.

Occurs before a UIElement loses focus. This event is raised synchronously to ensure focus isn't moved while the event is bubbling.

Occurs when a UIElement loses focus. This event is raised asynchronously, so focus can move again before bubbling is complete.

Occurs when a manipulation on the UIElement is complete.

Occurs when the input device changes position during a manipulation.

Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins.

Occurs when an input device begins a manipulation on the UIElement.

Occurs when the manipulation processor is first created.

Occurs when a user attempts to move focus (via tab or directional arrows), but focus doesn't move because no focus candidate is found in the direction of movement.

Occurs when a pointer that made contact abnormally loses contact.

Occurs when pointer capture previously held by this element moves to another element or elsewhere.

Occurs when a pointer enters the hit test area of this element.

Occurs when a pointer leaves the hit test area of this element.

Occurs when a pointer moves while the pointer remains within the hit test area of this element.

Occurs when the pointer device initiates a Press action within this element.

Occurs when the pointer device that previously initiated a Press action is released, while within this element. Note that the end of a Press action is not guaranteed to fire a PointerReleased event; other events may fire instead. For more info, see Remarks.

Occurs when the delta value of a pointer wheel changes.

Occurs when a keyboard key is pressed while the UIElement has focus.

Occurs when a keyboard key is released while the UIElement has focus.

Occurs when a keyboard shortcut (or accelerator) is pressed.

Occurs when a right-tap input stimulus happens while the pointer is over the element.

Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement.

Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element.

Occurs when a ToggleButton is unchecked.

Occurs when this object is no longer connected to the main object tree.