Export (0) Print
Expand All

InputLanguageChangingEventArgs Class

Provides data for the InputLanguageChanging event.

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.Windows.Forms.InputLanguageChangingEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public class InputLanguageChangingEventArgs : CancelEventArgs

The InputLanguageChangingEventArgs type exposes the following members.

  NameDescription
Public methodInputLanguageChangingEventArgs(CultureInfo, Boolean)Initializes a new instance of the InputLanguageChangingEventArgs class with the specified locale, character set, and acceptance.
Public methodInputLanguageChangingEventArgs(InputLanguage, Boolean)Initializes a new instance of the InputLanguageChangingEventArgs class with the specified input language, character set, and acceptance of a language change.
Top

  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyCultureGets the locale of the requested input language.
Public propertyInputLanguageGets a value indicating the input language.
Public propertySysCharSetGets a value indicating whether the system default font supports the character set required for the requested input language.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

You can use the data from the InputLanguageChangingEventArgs class to prepare to change Input Method Editors (IME) or swap right-to-left values. You can also change a thread's CurrentCulture and CurrentUICulture properties so that different resources get picked up. To prevent the input language from changing, set the Cancel property to true.

An InputLanguageChangingEventArgs identifies the requested input language and the character set of new input language. The Culture property identifies the locale of the requested language.

The InputLanguageChanging event precedes the InputLanguageChanged event.

For information about handling events, see Handling and Raising Events.

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the InputLanguageChanging event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type Form named Form1. Then ensure that the event handler is associated with the InputLanguageChanging event.

private void Form1_InputLanguageChanging(Object sender, InputLanguageChangingEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "InputLanguage", e.InputLanguage );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Culture", e.Culture );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "SysCharSet", e.SysCharSet );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "InputLanguageChanging Event" );
}

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, 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.

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