Help.Show Method

Launches the Help app and displays the calling app’s Help manual.

Syntax

public:
static IAsyncAction^ Show(
         IUser^ user
)

Parameters

user
Type: IUser

User that invoked Help.

Return value

Type: IAsyncAction

Interface for tracking the progress of the asynchronous call. Can be used by the calling app to confirm success. This async operation enables you to use .then() semantics in JavaScript, or lambdas in C++ or C#.

Remarks

Call Show in response to the user selecting Help from your app menu. Show launches the system Help app in snap mode, and then displays the calling app’s Help manual. The app’s Help manual must have previously been uploaded to XDP. To update your Help manual, upload a new version to XDP.

The manual locale is determined by the locale of the user specified in user.

The Help app will navigate to the top of the manual’s index.html page, or to a specific section if the app has been communicating the CurrentHelpTopic user statistic. For information on setting the current help topic, see Displaying Help.

For information about Help manuals, and to download a sample manual, see the “Game and App Help Technical Overview and Best Practices” whitepaper download, available on XGD.

Example

For the user argument, the following C++ example specifies the user associated with the gamepad that invoked Help. To instead specify the user who launched the application, use Windows::Xbox::ApplicationModel::Core::CoreApplicationContext::CurrentUser.

Note Windows::Xbox::ApplicationModel::Core::CoreApplicationContext::CurrentUser is available in the ADK, and will be available in the XDK in a future release.

C++

using namespace Windows::Foundation;
      
// Show Help manual
void ShowHelp(IGamepad ^gamepad)
{
    Windows::Xbox::System::User^ user = nullptr;
    if (gamepad != nullptr && gamepad->User != nullptr)
    {
        user = gamepad->User;
    }
    else
    {
        user = Windows::Xbox::System::User::Users->GetAt(0);
        // When it becomes available, instead use:
        // Windows::Xbox::ApplicationModel::Core::CoreApplicationContext::CurrentUser
    }

    Windows::Foundation::IAsyncAction^ helpAction = Windows::Xbox::ApplicationModel::Help::Show(user);

    // Optionally, specify a completion handler.
    helpAction->Completed = ref new AsyncActionCompletedHandler(
        [](IAsyncAction^ action, Windows::Foundation::AsyncStatus status)
        {
            // help has launched
        });
}

// Show help manual
function showHelp() {
    if (Windows.Xbox) {
        var user = Windows.Xbox.ApplicationModel.Core.CoreApplicationContext.currentUser;
        if (user === null) {
            user = Windows.Xbox.System.User.users[0];
        }
    
        Windows.Xbox.ApplicationModel.Help.show(user).then(
            function () {
                // help has launched
            });
    }
}

Requirements

Namespace: Windows.Xbox.ApplicationModel

Metadata: windows.winmd