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)

Syntax

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

Parameters

• player
  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
  Title of the interface dialog box.
• description
  Text of the interface dialog box.
• defaultText
  Default text displayed in the input area when the interface dialog box is first shown.
• callback
  Method to be called once the asynchronous operation is finished.
• state
  User-created object uniquely identifying this request.
• usePasswordMode
  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.

Exceptions

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

See Also

Tasks

Displaying a Software Input Panel (Windows Phone, Xbox 360)
Working with Asynchronous Methods in XNA Game Studio

Reference

Guide Class
Guide Members
Microsoft.Xna.Framework.GamerServices Namespace

Platforms

Xbox 360, Windows 7, Windows Vista, Windows XP, Windows Phone 7