通过

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.

Syntax

'Declaration
Public Shared Function BeginShowKeyboardInput ( _
         player As PlayerIndex, _
         title As String, _
         description As String, _
         defaultText As String, _
         callback As AsyncCallback, _
         state As Object, _
         usePasswordMode As Boolean _
) As IAsyncResult 

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

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 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

Type: IAsyncResult
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 255 characters.
ArgumentOutOfRangeException player is not a valid value. On Windows Phone, the only valid option is PlayerIndex.One.

Requirements

Namespace: Microsoft.Xna.Framework.GamerServices

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

See Also

Tasks

Displaying a Software Input Panel
Working with Asynchronous Methods in XNA Game Studio

Reference

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

Platforms

Windows Phone