InputMethod Class

 

Provides facilities for managing and interacting with the Text Services Framework, which provides support for alternate text input methods such as speech and handwriting.

Namespace:   System.Windows.Input
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.Input.InputMethod

public class InputMethod : DispatcherObject

NameDescription
System_CAPS_pubpropertyCanShowConfigurationUI

Gets a value that indicates whether or not this input method can display configuration user interface (UI).

System_CAPS_pubpropertyCanShowRegisterWordUI

Gets a value that indicates whether this input method can display word registration user interface (UI). 

System_CAPS_pubpropertySystem_CAPS_staticCurrent

Gets a reference to any currently active input method associated with the current context.

System_CAPS_pubpropertyDispatcher

Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)

System_CAPS_pubpropertyHandwritingState

Gets or sets the current state of handwriting input for this input method.

System_CAPS_pubpropertyImeConversionMode

Gets or sets the current conversion mode for the input method editor associated with this input method.

System_CAPS_pubpropertyImeSentenceMode

Gets or sets the current sentence mode for the input method editor associated with this input method.

System_CAPS_pubpropertyImeState

Gets or sets the current state of the input method editor associated with this input method.

System_CAPS_pubpropertyMicrophoneState

Gets or sets the current state of microphone input for this input method.

System_CAPS_pubpropertySpeechMode

Gets or sets the speech mode for this input method.

NameDescription
System_CAPS_pubpropertySystem_CAPS_staticInputScope

Gets or sets the input scope for a specified dependency object.

System_CAPS_pubpropertySystem_CAPS_staticIsInputMethodEnabled

Gets or sets a value that indicates whether this input method is enabled.

System_CAPS_pubpropertySystem_CAPS_staticIsInputMethodSuspended

Gets or sets a value that indicates whether this input method is suspended.

System_CAPS_pubpropertySystem_CAPS_staticPreferredImeConversionMode

Gets or sets a preferred ImeConversionModeValues value for a specified dependency object.

System_CAPS_pubpropertySystem_CAPS_staticPreferredImeSentenceMode

Gets or sets a preferred ImeSentenceModeValues value for a specified dependency object.

System_CAPS_pubpropertySystem_CAPS_staticPreferredImeState

Gets or sets a preferred input method state for a specified dependency object.

NameDescription
System_CAPS_pubmethodCheckAccess()

Determines whether the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticGetInputScope(DependencyObject)

Returns the value of the InputScope  attached property for a specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticGetIsInputMethodEnabled(DependencyObject)

Returns the value of the IsInputMethodEnabled  attached property for a specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticGetIsInputMethodSuspended(DependencyObject)

Returns the value of the IsInputMethodSuspended  attached property for a specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticGetPreferredImeConversionMode(DependencyObject)

Returns the value of the PreferredImeConversionMode  attached property for a specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticGetPreferredImeSentenceMode(DependencyObject)

Returns the value of the PreferredImeSentenceMode  attached property for a specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticGetPreferredImeState(DependencyObject)

Returns the value of the PreferredImeState  attached property for a specified dependency object.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticSetInputScope(DependencyObject, InputScope)

Sets the value of the InputScope attached property on the specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticSetIsInputMethodEnabled(DependencyObject, Boolean)

Sets the value of the IsInputMethodEnabled attached property on the specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticSetIsInputMethodSuspended(DependencyObject, Boolean)

Sets the value of the IsInputMethodSuspended attached property on the specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticSetPreferredImeConversionMode(DependencyObject, ImeConversionModeValues)

Sets the value of the PreferredImeConversionMode attached property on the specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticSetPreferredImeSentenceMode(DependencyObject, ImeSentenceModeValues)

Sets the value of the PreferredImeSentenceMode attached property on the specified dependency object.

System_CAPS_pubmethodSystem_CAPS_staticSetPreferredImeState(DependencyObject, InputMethodState)

Sets the value of the PreferredImeState attached property on the specified dependency object.

System_CAPS_pubmethodShowConfigureUI()

Displays configuration user interface (UI) associated with the currently active keyboard text service.

System_CAPS_pubmethodShowConfigureUI(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.

System_CAPS_pubmethodShowRegisterWordUI()

Displays word registration user interface (UI) associated with the currently active keyboard text service.

System_CAPS_pubmethodShowRegisterWordUI(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.

System_CAPS_pubmethodShowRegisterWordUI(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.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_pubmethodVerifyAccess()

Enforces that the calling thread has access to this DispatcherObject.(Inherited from DispatcherObject.)

NameDescription
System_CAPS_pubfieldSystem_CAPS_staticInputScopeProperty

Identifies the InputScope attached property.

System_CAPS_pubfieldSystem_CAPS_staticIsInputMethodEnabledProperty

Identifies the IsInputMethodEnabled attached property.

System_CAPS_pubfieldSystem_CAPS_staticIsInputMethodSuspendedProperty

Identifies the IsInputMethodSuspended attached property.

System_CAPS_pubfieldSystem_CAPS_staticPreferredImeConversionModeProperty

Identifies the PreferredImeConversionMode attached property.

System_CAPS_pubfieldSystem_CAPS_staticPreferredImeSentenceModeProperty

Identifies the PreferredImeSentenceMode attached property.

System_CAPS_pubfieldSystem_CAPS_staticPreferredImeStateProperty

Identifies the PreferredImeState attached property.

NameDescription
System_CAPS_pubeventStateChanged

Occurs when the input method state (represented by the ImeState property) changes.

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;
InputScope myInputScope = new InputScope();
myInputScope.RegularExpression = "W|P|F";
InputMethod.SetInputScope(myTextBox, myInputScope);
tb6.Text = "Configuration UI Available?: " + InputMethod.Current.CanShowConfigurationUI.ToString();

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: