SettingsFlyout class

Applies to Windows and Windows Phone

Represents a control that provides in-context access to settings that affect the current app.

Inheritance

Object
  DependencyObject
    UIElement
      FrameworkElement
        Control
          ContentControl
            SettingsFlyout

Syntax


public class SettingsFlyout : ContentControl



<SettingsFlyout ...>
  singleRootElement
</SettingsFlyout>

XAML Values

singleRootElement

A single XAML object element that contains the intended flyout content further down in its own XAML composition. Typically this is a panel or items control.

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06030000)]
[WebHostHidden()]

Members

The SettingsFlyout class has these types of members:

Constructors

The SettingsFlyout class has these constructors.

ConstructorDescription
SettingsFlyout Initializes a new instance of the SettingsFlyout class.

 

Events

The SettingsFlyout class has these events.

EventDescription
BackClick Occurs when the user clicks the back button on a SettingsFlyout control.
DataContextChanged Occurs when the value of the FrameworkElement.DataContext property changes. (Inherited from FrameworkElement)
DoubleTapped Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement)
DragEnter Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement)
DragLeave Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement)
DragOver Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement)
Drop Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement)
GotFocus Occurs when a UIElement receives focus. (Inherited from UIElement)
Holding Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement)
IsEnabledChanged Occurs when the IsEnabled property changes. (Inherited from Control)
KeyDown Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement)
KeyUp Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement)
LayoutUpdated Occurs when the layout of the visual tree changes, due to layout-relevant properties changing value or some other action that refreshes the layout. (Inherited from FrameworkElement)
Loaded Occurs when a FrameworkElement has been constructed and added to the object tree, and is ready for interaction. (Inherited from FrameworkElement)
LostFocus Occurs when a UIElement loses focus. (Inherited from UIElement)
ManipulationCompleted Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement)
ManipulationDelta Occurs when the input device changes position during a manipulation. (Inherited from UIElement)
ManipulationInertiaStarting Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement)
ManipulationStarted Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement)
ManipulationStarting Occurs when the manipulation processor is first created. (Inherited from UIElement)
PointerCanceled Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement)
PointerCaptureLost Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement)
PointerEntered Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement)
PointerExited Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement)
PointerMoved Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement)
PointerPressed Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement)
PointerReleased Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement)
PointerWheelChanged Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement)
RightTapped Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement)
SizeChanged Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement)
Tapped Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement)
Unloaded Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement)

 

Methods

The SettingsFlyout class has these methods. It also inherits methods from the Object class.

MethodDescription
AddHandler 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. (Inherited from UIElement)
ApplyTemplate Loads the relevant control template so that its parts can be referenced. (Inherited from Control)
Arrange 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. (Inherited from UIElement)
ArrangeOverride Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement)
CancelDirectManipulations Cancels ongoing direct manipulation processing (system-defined panning/zooming) on any ScrollViewer parent that contains the current UIElement. (Inherited from UIElement)
CapturePointer Sets pointer capture to a UIElement. Once captured, only the element that has capture will fire pointer-related events. (Inherited from UIElement)
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
FindName Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement)
FindSubElementsForTouchTargeting Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement)
Focus Attempts to set the focus on the control. (Inherited from Control)
GetAnimationBaseValue Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetBindingExpression Returns the BindingExpression that represents the binding on the specified property. (Inherited from FrameworkElement)
GetTemplateChild Retrieves the named element in the instantiated ControlTemplate visual tree. (Inherited from Control)
GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject)
GoToElementStateCore 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. (Inherited from FrameworkElement)
Hide Closes the Settings flyout.
InvalidateArrange Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement)
InvalidateMeasure Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement)
Measure 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. (Inherited from UIElement)
MeasureOverride Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement)
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. (Inherited from FrameworkElement)
OnContentChanged Invoked when the value of the Content property changes. (Inherited from ContentControl)
OnContentTemplateChanged Invoked when the value of the ContentTemplate property changes. (Inherited from ContentControl)
OnContentTemplateSelectorChanged Invoked when the value of the ContentTemplateSelector property changes. (Inherited from ContentControl)
OnCreateAutomationPeer When implemented in a derived class, returns class-specific AutomationPeer implementations for the Microsoft UI Automation infrastructure. (Inherited from UIElement)
OnDisconnectVisualChildren Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement)
OnDoubleTapped Called before the DoubleTapped event occurs. (Inherited from Control)
OnDragEnter Called before the DragEnter event occurs. (Inherited from Control)
OnDragLeave Called before the DragLeave event occurs. (Inherited from Control)
OnDragOver Called before the DragOver event occurs. (Inherited from Control)
OnDrop Called before the Drop event occurs. (Inherited from Control)
OnGotFocus Called before the GotFocus event occurs. (Inherited from Control)
OnHolding Called before the Holding event occurs. (Inherited from Control)
OnKeyDown Called before the KeyDown event occurs. (Inherited from Control)
OnKeyUp Called before the KeyUp event occurs. (Inherited from Control)
OnLostFocus Called before the LostFocus event occurs. (Inherited from Control)
OnManipulationCompleted Called before the ManipulationCompleted event occurs. (Inherited from Control)
OnManipulationDelta Called before the ManipulationDelta event occurs. (Inherited from Control)
OnManipulationInertiaStarting Called before the ManipulationInertiaStarting event occurs. (Inherited from Control)
OnManipulationStarted Called before the ManipulationStarted event occurs. (Inherited from Control)
OnManipulationStarting Called before the ManipulationStarting event occurs. (Inherited from Control)
OnPointerCanceled Called before the PointerCanceled event occurs. (Inherited from Control)
OnPointerCaptureLost Called before the PointerCaptureLost event occurs. (Inherited from Control)
OnPointerEntered Called before the PointerEntered event occurs. (Inherited from Control)
OnPointerExited Called before the PointerExited event occurs. (Inherited from Control)
OnPointerMoved Called before the PointerMoved event occurs. (Inherited from Control)
OnPointerPressed Called before the PointerPressed event occurs. (Inherited from Control)
OnPointerReleased Called before the PointerReleased event occurs. (Inherited from Control)
OnPointerWheelChanged Called before the PointerWheelChanged event occurs. (Inherited from Control)
OnRightTapped Called before the RightTapped event occurs. (Inherited from Control)
OnTapped Called before the Tapped event occurs. (Inherited from Control)
ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
ReleasePointerCapture Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement)
ReleasePointerCaptures Releases all pointer captures held by this element. (Inherited from UIElement)
RemoveHandler Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement)
SetBinding Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)
Show Opens the Settings flyout, and returns the user to the Settings pane after the flyout is dismissed.
ShowIndependent Opens the Settings flyout, and returns the user to the app after the flyout is dismissed.
TransformToVisual Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement)
UpdateLayout Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement)

 

Properties

The SettingsFlyout class has these properties.

PropertyAccess typeDescription

ActualHeight

Read-onlyGets the rendered height of a FrameworkElement. (Inherited from FrameworkElement)

ActualWidth

Read-onlyGets the rendered width of a FrameworkElement. (Inherited from FrameworkElement)

AllowDrop

Read/writeGets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement)

Background

Read/writeGets or sets a brush that provides the background of the control. (Inherited from Control)

BaseUri

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

BorderBrush

Read/writeGets or sets a brush that describes the border fill of a control. (Inherited from Control)

BorderThickness

Read/writeGets or sets the border thickness of a control. (Inherited from Control)

CacheMode

Read/writeGets or sets a value that indicates that rendered content should be cached as a composited bitmap when possible. (Inherited from UIElement)

CharacterSpacing

Read/writeGets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from Control)

Clip

Read/writeGets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement)

CompositeMode

Read/writeGets 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. (Inherited from UIElement)

Content

Read/writeGets or sets the content of a ContentControl. (Inherited from ContentControl)

ContentTemplate

Read/writeGets or sets the data template that is used to display the content of the ContentControl. (Inherited from ContentControl)

ContentTemplateRoot

Read-onlyGets the root element of the date template specified by the ContentTemplate property. (Inherited from ContentControl)

ContentTemplateSelector

Read/writeGets 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. (Inherited from ContentControl)

ContentTransitions

Read/writeGets or sets the collection of Transition style elements that apply to the content of a ContentControl. (Inherited from ContentControl)

DataContext

Read/writeGets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement)

DefaultStyleKey

Read/writeGets 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. (Inherited from Control)

DesiredSize

Read-onlyGets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement)

Dispatcher

Read-onlyGets 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. (Inherited from DependencyObject)

FlowDirection

Read/writeGets 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. (Inherited from FrameworkElement)

FocusState

Read-onlyGets a value that specifies whether this control has focus, and the mode by which focus was obtained. (Inherited from Control)

FontFamily

Read/writeGets or sets the font used to display text in the control. (Inherited from Control)

FontSize

Read/writeGets or sets the size of the text in this control. (Inherited from Control)

FontStretch

Read/writeGets or sets the degree to which a font is condensed or expanded on the screen. (Inherited from Control)

FontStyle

Read/writeGets or sets the style in which the text is rendered. (Inherited from Control)

FontWeight

Read/writeGets or sets the thickness of the specified font. (Inherited from Control)

Foreground

Read/writeGets or sets a brush that describes the foreground color. (Inherited from Control)

HeaderBackground

Read/writeGets or sets the Brush that fills the background of the SettingsFlyout header.

HeaderBackgroundProperty

Read-onlyIdentifies the HeaderBackground dependency property.

HeaderForeground

Read/writeGets or sets the Brush that fills the foreground of the SettingsFlyout header.

HeaderForegroundProperty

Read-onlyIdentifies the HeaderForeground dependency property.

Height

Read/writeGets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement)

HorizontalAlignment

Read/writeGets 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. (Inherited from FrameworkElement)

HorizontalContentAlignment

Read/writeGets or sets the horizontal alignment of the control's content. (Inherited from Control)

IconSource

Read/writeGets or sets the icon image displayed in the SettingsFlyout header.

IconSourceProperty

Read-onlyIdentifies the IconSource dependency property.

IsDoubleTapEnabled

Read/writeGets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement)

IsEnabled

Read/writeGets or sets a value indicating whether the user can interact with the control. (Inherited from Control)

IsHitTestVisible

Read/writeGets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement)

IsHoldingEnabled

Read/writeGets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement)

IsRightTapEnabled

Read/writeGets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement)

IsTabStop

Read/writeGets or sets a value that indicates whether a control is included in tab navigation. (Inherited from Control)

IsTapEnabled

Read/writeGets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement)

IsTextScaleFactorEnabled

Read/writeGets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from Control)

Language

Read/writeGets 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. (Inherited from FrameworkElement)

ManipulationMode

Read/writeGets 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. (Inherited from UIElement)

Margin

Read/writeGets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement)

MaxHeight

Read/writeGets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MaxWidth

Read/writeGets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinHeight

Read/writeGets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement)

MinWidth

Read/writeGets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement)

Name

Read/writeGets 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. (Inherited from FrameworkElement)

Opacity

Read/writeGets or sets the degree of the object's opacity. (Inherited from UIElement)

Padding

Read/writeGets or sets the padding inside a control. (Inherited from Control)

Parent

Read-onlyGets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement)

PointerCaptures

Read-onlyGets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement)

Projection

Read/writeGets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement)

RenderSize

Read-onlyGets the final render size of a UIElement. (Inherited from UIElement)

RenderTransform

Read/writeGets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement)

RenderTransformOrigin

Read/writeGets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement)

RequestedTheme

Read/writeGets 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. (Inherited from FrameworkElement)

Resources

Read/writeGets 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. (Inherited from FrameworkElement)

Style

Read/writeGets or sets an instance Style that is applied for this object during layout and rendering. (Inherited from FrameworkElement)

TabIndex

Read/writeGets or sets a value that determines the order in which elements receive focus when the user navigates through controls by pressing the Tab key. (Inherited from Control)

TabNavigation

Read/writeGets or sets a value that modifies how tabbing and TabIndex work for this control. (Inherited from Control)

Tag

Read/writeGets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement)

Template

Read/writeGets or sets a control template. The control template defines the visual appearance of a control in UI, and is defined in XAML markup. (Inherited from Control)

TemplateSettings

Read-onlyGets an object that provides calculated values that can be referenced as TemplateBinding sources when defining templates for a SettingsFlyout control.

Title

Read/writeGets or sets the title of the SettingsFlyout control when displayed.

TitleProperty

Read-onlyIdentifies the Title dependency property.

Transitions

Read/writeGets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement)

Triggers

Read-onlyGets the collection of triggers for animations that are defined for a FrameworkElement. Not commonly used. (Inherited from FrameworkElement)

UseLayoutRounding

Read/writeGets 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. (Inherited from UIElement)

VerticalAlignment

Read/writeGets 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. (Inherited from FrameworkElement)

VerticalContentAlignment

Read/writeGets or sets the vertical alignment of the control's content. (Inherited from Control)

Visibility

Read/writeGets 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. (Inherited from UIElement)

Width

Read/writeGets or sets the width of a FrameworkElement. (Inherited from FrameworkElement)

 

Remarks

Caution  SettingsFlyout is supported only for use with the SettingsPane in Windows. While the SettingsFlyout type is visible in Windows Phone projects, SettingsPane is not present on Windows Phone, so use of SettingsFlyout is not supported.

A SettingsFlyout control isn't intended to be a composite part of a page or general app UI. Instead, a SettingsFlyout control is typically defined as a separate XAML file, where the class you're defining is a SettingsFlyout subclass that's unique to your project, using a SettingsFlyout object element as a XAML file root. In Microsoft Visual Studio, you can use the Add New Item menu options for a project to add the files to your project using a basic starting template. This starting template sets styles for items contained by the SettingsFlyout control that reference existing pre-defined styles. For example, there's a style for a section header that references the TitleTextBlockStyle style that's defined by the Windows Runtime as a XAML resource. The generated XAML also provides some initial attribute values that are intended to be replaced. For example it sets the initial Title value to use the class name. You'll also want to add controls or other UI to the content section to replace the templated UI it starts with.

Showing and dismissing a Settings flyout

Users can access your SettingsFlyout control through the Settings charm. You can programmatically show a SettingsFlyout control by calling the Show or ShowIndependent methods, and dismiss it by calling Hide. A SettingsFlyout always includes a back button in its header area that uses the typical arrow glyph (this button isn't part of the adjustable XAML template, it's always there and is added by default control logic). By default, the back button dismisses the flyout.

If a SettingsFlyout control is shown by calling Show, clicking the back button dismisses the flyout and reopens the settings pane. If a SettingsFlyout is shown by calling ShowIndependent, clicking the back button dismisses the flyout and returns the user to the app. For example, if you open a SettingsFlyout control from a "Settings" button in your app, you will typically call ShowIndependent so users are returned directly to your app when they dismiss the flyout.

Only one SettingsFlyout control can be shown at a time. Calling Show on any SettingsFlyout instance hides any other SettingsFlyout instance currently shown.

You can override the default back button behavior by handling the BackClick event. This event is raised whenever the user clicks the back button. To override the default behavior, wire an event handler for the event and set the BackClickEventArgs.Handled property to true. This is useful when you have a SettingsFlyout that opens a second SettingsFlyout. By default, when the user taps the Back button on the second flyout, it will open the SettingsPane. You should handle the BackClick event and open the first flyout instead.

Connecting to the SettingsPane

You must manually associate the SettingsFlyout control with the app’s SettingsPane object. Do this by handling the SettingsPane.CommandsRequested event and adding a SettingsCommand to the ApplicationCommands collection. The SettingsCommand has a label for your SettingsFlyout control that’s shown in the Settings charm, and specifies a method that's executed when a user selects the command in the Settings charm. In this method, you create an instance of the SettingsFlyout control and show it.

We recommend that you add the CommandsRequested event handler in the overridden OnWindowCreated method, and remove it in the Application.Suspending event handler method. See the examples section for more info.

Defining a Settings flyout

To add a SettingsFlyout control to an app project in Visual Studio:

  1. Right-click your project in Solution Explorer. Select Project > Add New Item.
  2. In the Add New Item dialog, select Settings Flyout from the middle pane.
  3. Type a name for the SettingsFlyout control subclass in the Name field and click Add.

Note  When you add a SettingsFlyout control, you're creating a new class with a name you choose. When you look at the generated code-behind file, you'll see that the class you define is subclassing from SettingsFlyout.

To instantiate your SettingsFlyout control, use the class name you specified and the default constructor for it. For example, if you named your SettingsFlyout class as UpdateSettingsFlyout, you'd call new UpdateSettingsFlyout().

For more information and detailed steps, see Quickstart: Add app settings and Quickstart: Add app help.

Examples

This example shows the result of adding a templated item for Settings Flyout and naming the class UpdateSettingsFlyout. Then, the SettingsFlyoutSectionStyle resource is redefined, and appropriate strings and controls are added to the XAML composition of the SettingsFlyout XAML so that the user can adjust the settings.


<SettingsFlyout
    x:Class="SettingsFlyoutExample.UpdateSettingsFlyout"
    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
    xmlns:local="using:SettingsFlyoutExample"
    xmlns:d="http://schemas.microsoft.com/expression/blend/2008"
    xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006"
    mc:Ignorable="d"
    IconSource="Assets/SmallLogo.png"
    Title="App Updates"
    d:DesignWidth="346"
    Width="346" 
    HeaderBackground="#FF2B4A80">
    <SettingsFlyout.Resources>
        <Style x:Key="SettingsFlyoutSectionStyle" TargetType="StackPanel">
            <Setter Property="Margin" Value="0,0,0,39"/>
        </Style>
    </SettingsFlyout.Resources>

    <!-- This stack panel acts as a root panel for vertical layout of the content sections. -->
    <StackPanel VerticalAlignment="Stretch" HorizontalAlignment="Stretch" >

        <!-- The stack panels below define individual content sections. -->

        <!-- Content Section 1-->
        <StackPanel Style="{StaticResource SettingsFlyoutSectionStyle}">

            <!-- Section 1 header -->
            <TextBlock Style="{StaticResource TitleTextBlockStyle}"
                                 Text="Automatic updates" />

            <!-- Section 1 body -->
            <TextBlock Style="{StaticResource BodyTextBlockStyle}" Margin="0,0,0,25" TextWrapping="Wrap">
                <TextBlock.Text>
                    Turn automatic updating on or off.
                </TextBlock.Text>
            </TextBlock>
            <ToggleSwitch Header="Download updates automatically" />
            <ToggleSwitch Header="Install updates automatically" />

        </StackPanel>

        <!-- Define more Content Sections below as necessary. -->

    </StackPanel>
</SettingsFlyout>

Here's how this SettingsFlyout control can be associated with the app's SettingsPane and ApplicationCommands. These methods are in App.xaml.cs.



// Add the CommandsRequested handler when the window is created.
protected override void OnWindowCreated(WindowCreatedEventArgs args)
{
    SettingsPane.GetForCurrentView().CommandsRequested += OnCommandsRequested;
}

// Commands are requested when the Settings charm is used to open the SettingsPane.
private void OnCommandsRequested(SettingsPane sender, SettingsPaneCommandsRequestedEventArgs args)
{
    args.Request.ApplicationCommands.Add(new SettingsCommand(
    "AppUpdateSettings", "App updates", (handler) => ShowAppUpdatesSettingFlyout()));
}

// This code is executed when the user taps the "App updates" command in the SettingsPane.
public void ShowAppUpdatesSettingFlyout()
{
    UpdateSettingsFlyout updatesFlyout = new UpdateSettingsFlyout();
    updatesFlyout.Show();
}

// Remove the CommandsRequested handler when the app is suspending.
private async void OnSuspending(object sender, SuspendingEventArgs e)
{
    SettingsPane.GetForCurrentView().CommandsRequested -= App_CommandsRequested;

    var deferral = e.SuspendingOperation.GetDeferral();
    await SuspensionManager.SaveAsync();
    deferral.Complete();
}

Alternatively, theSettingsFlyout can be shown independently:


<Button Content="App update settings" Click="UpdateSettingsButton_Click"/>



private void UpdateSettingsButton_Click(object sender, RoutedEventArgs e)
{
    UpdateSettingsFlyout updatesFlyout = new UpdateSettingsFlyout();
    updatesFlyout.ShowIndependent();
}

For more code in context, see the App settings sample.

Requirements

Minimum supported client

Windows 8.1 [Windows Store apps only]

Minimum supported server

Windows Server 2012 R2 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Controls
Windows::UI::Xaml::Controls [C++]

Metadata

Windows.winmd

See also

ContentControl
Quickstart: Add app settings
Quickstart: Add app help
App settings sample

 

 

Show:
© 2014 Microsoft