Export (0) Print
Expand All

KeysConverter Class

Provides a TypeConverter to convert Keys objects to and from other representations.

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

public class KeysConverter : TypeConverter, 
	IComparer

The KeysConverter type exposes the following members.

  NameDescription
Public methodKeysConverterInitializes an instance of the KeysConverter class.
Top

  NameDescription
Public methodCanConvertFrom(Type)Returns whether this converter can convert an object of the given type to the type of this converter. (Inherited from TypeConverter.)
Public methodCanConvertFrom(ITypeDescriptorContext, Type)Returns a value indicating whether this converter can convert an object in the specified source type to the native type of the converter using the specified context. (Overrides TypeConverter.CanConvertFrom(ITypeDescriptorContext, Type).)
Public methodCanConvertTo(Type)Returns whether this converter can convert the object to the specified type. (Inherited from TypeConverter.)
Public methodCanConvertTo(ITypeDescriptorContext, Type)Returns a value indicating whether this converter can convert an object in the specified source type to the native type of the converter using the specified context. (Overrides TypeConverter.CanConvertTo(ITypeDescriptorContext, Type).)
Public methodCompareCompares two key values for equivalence.
Public methodConvertFrom(Object)Converts the given value to the type of this converter. (Inherited from TypeConverter.)
Public methodConvertFrom(ITypeDescriptorContext, CultureInfo, Object)Converts the specified object to the converter's native type. (Overrides TypeConverter.ConvertFrom(ITypeDescriptorContext, CultureInfo, Object).)
Public methodConvertFromInvariantString(String)Converts the given string to the type of this converter, using the invariant culture. (Inherited from TypeConverter.)
Public methodConvertFromInvariantString(ITypeDescriptorContext, String)Converts the given string to the type of this converter, using the invariant culture and the specified context. (Inherited from TypeConverter.)
Public methodConvertFromString(String)Converts the specified text to an object. (Inherited from TypeConverter.)
Public methodConvertFromString(ITypeDescriptorContext, String)Converts the given text to an object, using the specified context. (Inherited from TypeConverter.)
Public methodConvertFromString(ITypeDescriptorContext, CultureInfo, String)Converts the given text to an object, using the specified context and culture information. (Inherited from TypeConverter.)
Public methodConvertTo(Object, Type)Converts the given value object to the specified type, using the arguments. (Inherited from TypeConverter.)
Public methodConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type)Converts the specified object to the specified destination type. (Overrides TypeConverter.ConvertTo(ITypeDescriptorContext, CultureInfo, Object, Type).)
Public methodConvertToInvariantString(Object)Converts the specified value to a culture-invariant string representation. (Inherited from TypeConverter.)
Public methodConvertToInvariantString(ITypeDescriptorContext, Object)Converts the specified value to a culture-invariant string representation, using the specified context. (Inherited from TypeConverter.)
Public methodConvertToString(Object)Converts the specified value to a string representation. (Inherited from TypeConverter.)
Public methodConvertToString(ITypeDescriptorContext, Object)Converts the given value to a string representation, using the given context. (Inherited from TypeConverter.)
Public methodConvertToString(ITypeDescriptorContext, CultureInfo, Object)Converts the given value to a string representation, using the specified context and culture information. (Inherited from TypeConverter.)
Public methodCreateInstance(IDictionary)Re-creates an Object given a set of property values for the object. (Inherited from TypeConverter.)
Public methodCreateInstance(ITypeDescriptorContext, IDictionary)Creates an instance of the type that this TypeConverter is associated with, using the specified context, given a set of property values for the object. (Inherited from TypeConverter.)
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.)
Protected methodGetConvertFromExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Protected methodGetConvertToExceptionReturns an exception to throw when a conversion cannot be performed. (Inherited from TypeConverter.)
Public methodGetCreateInstanceSupported()Returns whether changing a value on this object requires a call to the CreateInstance method to create a new value. (Inherited from TypeConverter.)
Public methodGetCreateInstanceSupported(ITypeDescriptorContext)Returns whether changing a value on this object requires a call to CreateInstance to create a new value, using the specified context. (Inherited from TypeConverter.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetProperties(Object)Returns a collection of properties for the type of array specified by the value parameter. (Inherited from TypeConverter.)
Public methodGetProperties(ITypeDescriptorContext, Object)Returns a collection of properties for the type of array specified by the value parameter, using the specified context. (Inherited from TypeConverter.)
Public methodGetProperties(ITypeDescriptorContext, Object, Attribute[])Returns a collection of properties for the type of array specified by the value parameter, using the specified context and attributes. (Inherited from TypeConverter.)
Public methodGetPropertiesSupported()Returns whether this object supports properties. (Inherited from TypeConverter.)
Public methodGetPropertiesSupported(ITypeDescriptorContext)Returns whether this object supports properties, using the specified context. (Inherited from TypeConverter.)
Public methodGetStandardValues()Returns a collection of standard values from the default context for the data type this type converter is designed for. (Inherited from TypeConverter.)
Public methodGetStandardValues(ITypeDescriptorContext)Returns a collection of standard values for the data type that this type converter is designed for when provided with a format context. (Overrides TypeConverter.GetStandardValues(ITypeDescriptorContext).)
Public methodGetStandardValuesExclusive()Returns whether the collection of standard values returned from GetStandardValues is an exclusive list. (Inherited from TypeConverter.)
Public methodGetStandardValuesExclusive(ITypeDescriptorContext)Determines if the list of standard values returned from GetStandardValues is an exclusive list using the specified ITypeDescriptorContext. (Overrides TypeConverter.GetStandardValuesExclusive(ITypeDescriptorContext).)
Public methodGetStandardValuesSupported()Returns whether this object supports a standard set of values that can be picked from a list. (Inherited from TypeConverter.)
Public methodGetStandardValuesSupported(ITypeDescriptorContext)Gets a value indicating whether this object supports a standard set of values that can be picked from a list. (Overrides TypeConverter.GetStandardValuesSupported(ITypeDescriptorContext).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsValid(Object)Returns whether the given value object is valid for this type. (Inherited from TypeConverter.)
Public methodIsValid(ITypeDescriptorContext, Object)Returns whether the given value object is valid for this type and for the specified context. (Inherited from TypeConverter.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSortPropertiesSorts a collection of properties. (Inherited from TypeConverter.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

Most commonly, the KeysConverter type converter is used to convert Keys instances to and from their corresponding localized String representations.

The following code example demonstrates how to use the KeysConverter class to convert a KeyCode to a String. This example assumes that you have a TextBox named TextBox1 on a Form named Form1.

public partial class Form1 : Form
{
    public Form1()
    {
        InitializeComponent();

        this.textBox1.KeyPress += new System.Windows.Forms.KeyPressEventHandler(this.KeyPressWork);
        this.textBox1.KeyDown += new System.Windows.Forms.KeyEventHandler(this.KeyDownWork);
    }

    private void KeyDownWork(object sender, KeyEventArgs e)
    {
        MessageBox.Show(e.KeyCode.ToString(), "KeyDown");

        KeysConverter kc = new KeysConverter();
        MessageBox.Show(kc.ConvertToString(e.KeyCode), "KeyDown");
    }

    private void KeyPressWork(object sender, KeyPressEventArgs e)
    {
        MessageBox.Show(e.KeyChar.ToString(), "KeyPress");
    }
}

.NET Framework

Supported in: 4.5.3, 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