Export (0) Print
Expand All

Guide.BeginShowKeyboardInput Method (PlayerIndex, String, String, String, AsyncCallback, Object, Boolean)

Begins the process for displaying asynchronously the software keyboard interface for a gamer by using the password mode if it is specified.

Namespace: Microsoft.Xna.Framework.GamerServices
Assembly: Microsoft.Xna.Framework.GamerServices (in microsoft.xna.framework.gamerservices.dll)

public static IAsyncResult BeginShowKeyboardInput (
         PlayerIndex player,
         string title,
         string description,
         string defaultText,
         AsyncCallback callback,
         Object state,
         bool usePasswordMode
)

Parameters

player
Type: PlayerIndex
Index of the player providing input. On platforms such as Windows Phone or Windows that support only one player, the valid value is PlayerIndex.One.
title
Type: String
Title of the interface dialog box.
description
Type: String
Text of the interface dialog box.
defaultText
Type: String
Default text displayed in the input area when the interface dialog box is first shown.
callback
Type: AsyncCallback
Method to be called once the asynchronous operation is finished.
state
Type: Object
User-created object uniquely identifying this request.
usePasswordMode
Type: Boolean
Specify true to enable password mode, or false to disable it. If the password mode is specified, the characters that the player types are not echoed in the input area.

Return Value

An IAsyncResult used to track the progress of the method.

Exception typeCondition
ArgumentException title, description, or defaultText is larger than the maximum allowed string length of 255 characters.
ArgumentOutOfRangeException player is not a valid value. On Windows and Windows Phone, the only valid option is PlayerIndex.One.

Xbox 360, Windows 7, Windows Vista, Windows XP

Community Additions

ADD
Show:
© 2014 Microsoft