Provides facilities for managing and interacting with the Text Services Framework, which provides support for alternate text input methods such as speech and handwriting.
Assembly: PresentationCore (in PresentationCore.dll)
Syntax
Public Class InputMethod _
Inherits [%$TOPIC/ms617141_en-us_VS_110_2_0_0_0_0%]public class InputMethod : [%$TOPIC/ms617141_en-us_VS_110_2_0_1_0_0%]public ref class InputMethod : public [%$TOPIC/ms617141_en-us_VS_110_2_0_2_0_0%]type InputMethod =
class
inherit [%$TOPIC/ms617141_en-us_VS_110_2_0_3_0_0%]
endThe InputMethod type exposes the following members.
Properties
Top
| Name | Description | |
|---|---|---|
.gif) | CanShowConfigurationUI | Gets a value that indicates whether or not this input method can display configuration user interface (UI). |
|
| CanShowRegisterWordUI | Gets a value that indicates whether this input method can display word registration user interface (UI). |
.gif) | Current | Gets a reference to any currently active input method associated with the current context. |
|
| Dispatcher | Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.) |
|
| HandwritingState | Gets or sets the current state of handwriting input for this input method. |
|
| ImeConversionMode | Gets or sets the current conversion mode for the input method editor associated with this input method. |
|
| ImeSentenceMode | Gets or sets the current sentence mode for the input method editor associated with this input method. |
|
| ImeState | Gets or sets the current state of the input method editor associated with this input method. |
|
| MicrophoneState | Gets or sets the current state of microphone input for this input method. |
|
| SpeechMode | Gets or sets the speech mode for this input method. |
Attached Properties
Top
| Name | Description | |
|---|---|---|
|
| InputScope | Gets or sets the input scope for a specified dependency object. |
|
| IsInputMethodEnabled | Gets or sets a value that indicates whether this input method is enabled. |
|
| IsInputMethodSuspended | Gets or sets a value that indicates whether this input method is suspended. |
|
| PreferredImeConversionMode | Gets or sets a preferred ImeConversionModeValues value for a specified dependency object. |
|
| PreferredImeSentenceMode | Gets or sets a preferred ImeSentenceModeValues value for a specified dependency object. |
|
| PreferredImeState | Gets or sets a preferred input method state for a specified dependency object. |
Methods
Top
| Name | Description | |
|---|---|---|
.gif) | CheckAccess | Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
.gif) | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
| GetInputScope | Returns the value of the InputScope attached property for a specified dependency object. |
|
| GetIsInputMethodEnabled | Returns the value of the IsInputMethodEnabled attached property for a specified dependency object. |
|
| GetIsInputMethodSuspended | Returns the value of the IsInputMethodSuspended attached property for a specified dependency object. |
|
| GetPreferredImeConversionMode | Returns the value of the PreferredImeConversionMode attached property for a specified dependency object. |
|
| GetPreferredImeSentenceMode | Returns the value of the PreferredImeSentenceMode attached property for a specified dependency object. |
|
| GetPreferredImeState | Returns the value of the PreferredImeState attached property for a specified dependency object. |
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
| SetInputScope | Sets the value of the InputScope attached property on the specified dependency object. |
|
| SetIsInputMethodEnabled | Sets the value of the IsInputMethodEnabled attached property on the specified dependency object. |
|
| SetIsInputMethodSuspended | Sets the value of the IsInputMethodSuspended attached property on the specified dependency object. |
|
| SetPreferredImeConversionMode | Sets the value of the PreferredImeConversionMode attached property on the specified dependency object. |
|
| SetPreferredImeSentenceMode | Sets the value of the PreferredImeSentenceMode attached property on the specified dependency object. |
|
| SetPreferredImeState | Sets the value of the PreferredImeState attached property on the specified dependency object. |
|
| ShowConfigureUI | Displays configuration user interface (UI) associated with the currently active keyboard text service. |
|
| ShowConfigureUI(UIElement) | Displays configuration user interface (UI) associated with the currently active keyboard text service, using a specified UIElement as the parent element for the configuration UI. |
|
| ShowRegisterWordUI | Displays word registration user interface (UI) associated with the currently active keyboard text service. |
|
| ShowRegisterWordUI(String) | Displays word registration user interface (UI) associated with the currently active keyboard text service. Accepts a specified string as the default value to register. |
|
| ShowRegisterWordUI(UIElement, String) | Displays word registration user interface (UI) associated with the currently active keyboard text service. Accepts a specified string as the default value to register, and a specified UIElement as the parent element for the configuration UI. |
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
| VerifyAccess | Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.) |
Events
Top
| Name | Description | |
|---|---|---|
.gif) | StateChanged | Occurs when the input method state (represented by the ImeState property) changes. |
Fields
Top
| Name | Description | |
|---|---|---|
.gif)
| InputScopeProperty | Identifies the InputScope attached property. |
|
| IsInputMethodEnabledProperty | Identifies the IsInputMethodEnabled attached property. |
|
| IsInputMethodSuspendedProperty | Identifies the IsInputMethodSuspended attached property. |
|
| PreferredImeConversionModeProperty | Identifies the PreferredImeConversionMode attached property. |
|
| PreferredImeSentenceModeProperty | Identifies the PreferredImeSentenceMode attached property. |
|
| PreferredImeStateProperty | Identifies the PreferredImeState attached property. |
Examples
The following example demonstrates how to use an InputMethod object.
InputMethod.SetPreferredImeState(myTextBox, InputMethodState.On)
InputMethod.Current.ImeSentenceMode = ImeSentenceModeValues.Automatic
InputMethod.Current.HandwritingState = InputMethodState.On
InputMethod.Current.SpeechMode = SpeechMode.Dictation
Dim myInputScope As New InputScope()
myInputScope.RegularExpression = "W|P|F"
InputMethod.SetInputScope(myTextBox, myInputScope)
tb6.Text = "Configuration UI Available?: " & InputMethod.Current.CanShowConfigurationUI.ToString()InputMethod.SetPreferredImeState(myTextBox, InputMethodState.On);
InputMethod.Current.ImeSentenceMode = ImeSentenceModeValues.Automatic;
InputMethod.Current.HandwritingState = InputMethodState.On;
InputMethod.Current.SpeechMode = SpeechMode.Dictation;
InputScope myInputScope = new InputScope();
myInputScope.RegularExpression = "W|P|F";
InputMethod.SetInputScope(myTextBox, myInputScope);
tb6.Text = "Configuration UI Available?: " + InputMethod.Current.CanShowConfigurationUI.ToString();
Platforms
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.png)
