Accounts​Settings​Pane Accounts​Settings​Pane Accounts​Settings​Pane Class

Definition

Provides methods to show the accounts pane and also to enable the app to register callbacks when the accounts flyout is about to be displayed.

public sealed class AccountsSettingsPane : IAccountsSettingsPanepublic sealed class AccountsSettingsPane : IAccountsSettingsPanePublic NotInheritable Class AccountsSettingsPane Implements IAccountsSettingsPane
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The app provides the callbacks with account metadata for all of the web account providers, web accounts, global account commands, and credential locker credentials that the app displays. Examples of account providers are Facebook, LinkedIn, and Twitter.

The account and credential command classes in the Windows.UI.ApplicationSettings namespace correspond with data objects in the Windows.UI.ApplicationSettings namespace:

Data Object (Windows.Security.Credentials )UI object (Windows.UI.ApplicationSettings )
WebAccount WebAccountCommand
WebAccountProvider WebAccountProviderCommand
PasswordCredential CredentialCommand

Methods

GetForCurrentView() GetForCurrentView() GetForCurrentView()

Gets an AccountsSettingsPane object that is associated with the current app view (that is, with CoreWindow ).

public static AccountsSettingsPane GetForCurrentView()public static AccountsSettingsPane GetForCurrentView()Public Static Function GetForCurrentView() As AccountsSettingsPane
Returns
Attributes

Show() Show() Show()

Displays the account settings pane.

public static void Show()public static void Show()Public Static Function Show() As void
Attributes

Remarks

Do not call Show multiple times in rapid succession. If you call Show while an existing Show operation is still running, exception will throw.

ShowAddAccountAsync() ShowAddAccountAsync() ShowAddAccountAsync()

Displays the add accounts screen.

public static IAsyncAction ShowAddAccountAsync()public static IAsyncAction ShowAddAccountAsync()Public Static Function ShowAddAccountAsync() As IAsyncAction
Returns

Represents the asynchronous action. You usually don't access this IAsyncAction return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is void.

Attributes
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ShowManageAccountsAsync() ShowManageAccountsAsync() ShowManageAccountsAsync()

Displays the manage accounts screen.

public static IAsyncAction ShowManageAccountsAsync()public static IAsyncAction ShowManageAccountsAsync()Public Static Function ShowManageAccountsAsync() As IAsyncAction
Returns

Represents the asynchronous action. You usually don't access this IAsyncAction return value directly. That's because you almost always use the language-specific awaitable syntax. In this case, the apparent return value of the method is void.

Attributes
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

Events

AccountCommandsRequested AccountCommandsRequested AccountCommandsRequested

Occurs when the user opens the accounts pane. Handling this event lets the app initialize the accounts commands and pause its UI until the user closes the pane.

public event TypedEventHandler AccountCommandsRequestedpublic event TypedEventHandler AccountCommandsRequestedPublic Event AccountCommandsRequested
Attributes

Remarks

When your app handles this event, populate the provided AccountsSettingsPaneCommandsRequestedEventArgs with your SettingsCommand objects, your CredentialCommand objects, and your WebAccountCommand objects to make them available to the AccountsSettingsPane UI.