Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

Guide.BeginShowKeyboardInput Method

Begins the process for displaying a dialog for keyboard input from a gamer. The display operation is performed asynchronously.

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

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


Index of the player providing input. For Windows-based XNA games, the only valid option is PlayerIndex.One.
Title of the dialog box.
Text of the dialog box.
Text displayed when the dialog box is initially shown.
The method to be called once the asynchronous operation has finished.
A user-created object uniquely identifying this request.

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 260 characters.
ArgumentOutOfRangeException player is not a valid value. For Windows-based XNA games, the only valid option is PlayerIndex.One.

Xbox 360, Windows XP SP2, Windows Vista

Community Additions

© 2015 Microsoft