mcs/class/Managed.Windows.Forms/Documentation/en/System.Windows.Forms/KeysConverter.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="KeysConverter" FullName="System.Windows.Forms.KeysConverter">
   3   <TypeSignature Language="C#" Value="public class KeysConverter : System.ComponentModel.TypeConverter, System.Collections.IComparer" />
   4   <AssemblyInfo>
   5     <AssemblyName>System.Windows.Forms</AssemblyName>
   6     <AssemblyVersion>1.0.5000.0</AssemblyVersion>
   7     <AssemblyVersion>2.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.ComponentModel.TypeConverter</BaseTypeName>
  11   </Base>
  12   <Interfaces>
  13     <Interface>
  14       <InterfaceName>System.Collections.IComparer</InterfaceName>
  15     </Interface>
  16   </Interfaces>
  17   <Docs>
  18     <remarks>
  19       <attribution license="cc4" from="Microsoft" modified="false" />
  20       <para>Most commonly, the <see cref="T:System.Windows.Forms.KeysConverter" /> type converter is used to convert <see cref="T:System.Windows.Forms.Keys" /> instances to and from their corresponding localized <see cref="T:System.String" /> representations.</para>
  21     </remarks>
  22     <summary>
  23       <attribution license="cc4" from="Microsoft" modified="false" />
  24       <para>Provides a <see cref="T:System.ComponentModel.TypeConverter" /> to convert <see cref="T:System.Windows.Forms.Keys" /> objects to and from other representations.</para>
  25     </summary>
  26   </Docs>
  27   <Members>
  28     <Member MemberName=".ctor">
  29       <MemberSignature Language="C#" Value="public KeysConverter ();" />
  30       <MemberType>Constructor</MemberType>
  31       <Parameters />
  32       <Docs>
  33         <remarks>
  34           <attribution license="cc4" from="Microsoft" modified="false" />
  35           <para>This is the default, compiler-supplied constructor for the <see cref="T:System.Windows.Forms.KeysConverter" /> class.</para>
  36           <para>Typically, you do not directly create an instance of a <see cref="T:System.Windows.Forms.KeysConverter" />. Instead, call the <see cref="M:System.ComponentModel.TypeDescriptor.GetConverter(System.Object)" /> method of <see cref="T:System.ComponentModel.TypeDescriptor" /> class. For more information, see the examples in the <see cref="T:System.ComponentModel.TypeConverter" /> base class.</para>
  37         </remarks>
  38         <summary>
  39           <attribution license="cc4" from="Microsoft" modified="false" />
  40           <para>Initializes an instance of the <see cref="T:System.Windows.Forms.KeysConverter" /> class.</para>
  41         </summary>
  42       </Docs>
  43       <AssemblyInfo>
  44         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  45         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  46       </AssemblyInfo>
  47     </Member>
  48     <Member MemberName="CanConvertFrom">
  49       <MemberSignature Language="C#" Value="public override bool CanConvertFrom (System.ComponentModel.ITypeDescriptorContext context, Type sourceType);" />
  50       <MemberType>Method</MemberType>
  51       <ReturnValue>
  52         <ReturnType>System.Boolean</ReturnType>
  53       </ReturnValue>
  54       <Parameters>
  55         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
  56         <Parameter Name="sourceType" Type="System.Type" />
  57       </Parameters>
  58       <Docs>
  59         <remarks>
  60           <attribution license="cc4" from="Microsoft" modified="false" />
  61           <para>The <see cref="M:System.Windows.Forms.KeysConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method is specialized to return true if the <paramref name="sourceType" /> parameter is of type <see cref="T:System.String" /> or <see cref="T:System.Enum" /> array; otherwise, it defers evaluation to the base implementation of this method.</para>
  62         </remarks>
  63         <summary>
  64           <attribution license="cc4" from="Microsoft" modified="false" />
  65           <para>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.</para>
  66         </summary>
  67         <returns>
  68           <attribution license="cc4" from="Microsoft" modified="false" />
  69           <para>true if the conversion can be performed; otherwise, false.</para>
  70         </returns>
  71         <param name="context">
  72           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this converter is being invoked from. This parameter or properties of this parameter can be null. </param>
  73         <param name="sourceType">
  74           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> to convert from. </param>
  75       </Docs>
  76       <AssemblyInfo>
  77         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
  78         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  79       </AssemblyInfo>
  80     </Member>
  81     <Member MemberName="CanConvertTo">
  82       <MemberSignature Language="C#" Value="public override bool CanConvertTo (System.ComponentModel.ITypeDescriptorContext context, Type destinationType);" />
  83       <MemberType>Method</MemberType>
  84       <AssemblyInfo>
  85         <AssemblyVersion>2.0.0.0</AssemblyVersion>
  86       </AssemblyInfo>
  87       <ReturnValue>
  88         <ReturnType>System.Boolean</ReturnType>
  89       </ReturnValue>
  90       <Parameters>
  91         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
  92         <Parameter Name="destinationType" Type="System.Type" />
  93       </Parameters>
  94       <Docs>
  95         <remarks>
  96           <attribution license="cc4" from="Microsoft" modified="false" />
  97           <para>The <see cref="M:System.Windows.Forms.KeysConverter.CanConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Type)" /> method is specialized to return true if the <paramref name="destinationType" /> parameter is of type <see cref="T:System.Enum" /> array; otherwise, it defers evaluation to the base implementation of this method.</para>
  98         </remarks>
  99         <summary>
 100           <attribution license="cc4" from="Microsoft" modified="false" />
 101           <para>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.</para>
 102         </summary>
 103         <returns>
 104           <attribution license="cc4" from="Microsoft" modified="false" />
 105           <para>true if the conversion can be performed; otherwise, false.</para>
 106         </returns>
 107         <param name="context">
 108           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this converter is being invoked from. This parameter or properties of this parameter can be null. </param>
 109         <param name="destinationType">
 110           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> to convert to. </param>
 111       </Docs>
 112     </Member>
 113     <Member MemberName="Compare">
 114       <MemberSignature Language="C#" Value="public int Compare (object a, object b);" />
 115       <MemberType>Method</MemberType>
 116       <ReturnValue>
 117         <ReturnType>System.Int32</ReturnType>
 118       </ReturnValue>
 119       <Parameters>
 120         <Parameter Name="a" Type="System.Object" />
 121         <Parameter Name="b" Type="System.Object" />
 122       </Parameters>
 123       <Docs>
 124         <remarks>
 125           <attribution license="cc4" from="Microsoft" modified="false" />
 126           <para>This method uses <see cref="M:System.String.Compare(System.String,System.String)" /> to compare the two objects.</para>
 127         </remarks>
 128         <summary>
 129           <attribution license="cc4" from="Microsoft" modified="false" />
 130           <para>Compares two key values for equivalence.</para>
 131         </summary>
 132         <returns>
 133           <attribution license="cc4" from="Microsoft" modified="false" />
 134           <para>An integer indicating the relationship between the two parameters.</para>
 135           <list type="table">
 136             <listheader>
 137               <item>
 138                 <term>
 139                   <para>Value Type </para>
 140                 </term>
 141                 <description>
 142                   <para>Condition </para>
 143                 </description>
 144               </item>
 145             </listheader>
 146             <item>
 147               <term>
 148                 <para>A negative integer. </para>
 149               </term>
 150               <description>
 151                 <para>
 152                   <paramref name="a" /> is less than <paramref name="b" />. </para>
 153               </description>
 154             </item>
 155             <item>
 156               <term>
 157                 <para>zero </para>
 158               </term>
 159               <description>
 160                 <para>
 161                   <paramref name="a" /> equals <paramref name="b" />. </para>
 162               </description>
 163             </item>
 164             <item>
 165               <term>
 166                 <para>A positive integer. </para>
 167               </term>
 168               <description>
 169                 <para>
 170                   <paramref name="a" /> is greater than <paramref name="b" />. </para>
 171               </description>
 172             </item>
 173           </list>
 174         </returns>
 175         <param name="a">
 176           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the first key to compare. </param>
 177         <param name="b">
 178           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.Object" /> that represents the second key to compare. </param>
 179       </Docs>
 180       <AssemblyInfo>
 181         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 182         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 183       </AssemblyInfo>
 184     </Member>
 185     <Member MemberName="ConvertFrom">
 186       <MemberSignature Language="C#" Value="public override object ConvertFrom (System.ComponentModel.ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value);" />
 187       <MemberType>Method</MemberType>
 188       <ReturnValue>
 189         <ReturnType>System.Object</ReturnType>
 190       </ReturnValue>
 191       <Parameters>
 192         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
 193         <Parameter Name="culture" Type="System.Globalization.CultureInfo" />
 194         <Parameter Name="value" Type="System.Object" />
 195       </Parameters>
 196       <Docs>
 197         <remarks>
 198           <attribution license="cc4" from="Microsoft" modified="false" />
 199           <para>The <see cref="M:System.Windows.Forms.KeysConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)" /> method is specialized to convert objects of type <see cref="T:System.String" /> or <see cref="T:System.Enum" /> array. In this case, it will return an object of type <see cref="T:System.Windows.Forms.Keys" />. Otherwise, it defers evaluation to the base implementation of this method.</para>
 200         </remarks>
 201         <summary>
 202           <attribution license="cc4" from="Microsoft" modified="false" />
 203           <para>Converts the specified object to the converter's native type.</para>
 204         </summary>
 205         <returns>
 206           <attribution license="cc4" from="Microsoft" modified="false" />
 207           <para>An object that represents the converted <paramref name="value" />.</para>
 208         </returns>
 209         <param name="context">
 210           <attribution license="cc4" from="Microsoft" modified="false" />An ITypeDescriptorContext that provides a format context, which can be used to extract additional information about the environment this converter is being invoked from. This parameter or properties of this parameter can be null. </param>
 211         <param name="culture">
 212           <attribution license="cc4" from="Microsoft" modified="false" />A CultureInfo object to provide locale information. </param>
 213         <param name="value">
 214           <attribution license="cc4" from="Microsoft" modified="false" />The object to convert. </param>
 215       </Docs>
 216       <AssemblyInfo>
 217         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 218         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 219       </AssemblyInfo>
 220     </Member>
 221     <Member MemberName="ConvertTo">
 222       <MemberSignature Language="C#" Value="public override object ConvertTo (System.ComponentModel.ITypeDescriptorContext context, System.Globalization.CultureInfo culture, object value, Type destinationType);" />
 223       <MemberType>Method</MemberType>
 224       <ReturnValue>
 225         <ReturnType>System.Object</ReturnType>
 226       </ReturnValue>
 227       <Parameters>
 228         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
 229         <Parameter Name="culture" Type="System.Globalization.CultureInfo" />
 230         <Parameter Name="value" Type="System.Object" />
 231         <Parameter Name="destinationType" Type="System.Type" />
 232       </Parameters>
 233       <Docs>
 234         <remarks>
 235           <attribution license="cc4" from="Microsoft" modified="false" />
 236           <para>The <see cref="M:System.Windows.Forms.KeysConverter.ConvertTo(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object,System.Type)" /> method is specialized to convert objects of type <see cref="T:System.Windows.Forms.Keys" /> or <see cref="T:System.Int32" />. In this case, it will return an object of type <see cref="T:System.String" />. Otherwise, it defers evaluation to the base implementation of this method. </para>
 237         </remarks>
 238         <summary>
 239           <attribution license="cc4" from="Microsoft" modified="false" />
 240           <para>Converts the specified object to the specified destination type.</para>
 241         </summary>
 242         <returns>
 243           <attribution license="cc4" from="Microsoft" modified="false" />
 244           <para>An <see cref="T:System.Object" /> that represents the converted <paramref name="value" />.</para>
 245         </returns>
 246         <param name="context">
 247           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this converter is being invoked from. This parameter or properties of this parameter can be null. </param>
 248         <param name="culture">
 249           <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Globalization.CultureInfo" /> to provide locale information. </param>
 250         <param name="value">
 251           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Object" /> to convert. </param>
 252         <param name="destinationType">
 253           <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Type" /> to convert the object to. </param>
 254       </Docs>
 255       <AssemblyInfo>
 256         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 257         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 258       </AssemblyInfo>
 259     </Member>
 260     <Member MemberName="GetStandardValues">
 261       <MemberSignature Language="C#" Value="public override System.ComponentModel.TypeConverter.StandardValuesCollection GetStandardValues (System.ComponentModel.ITypeDescriptorContext context);" />
 262       <MemberType>Method</MemberType>
 263       <ReturnValue>
 264         <ReturnType>System.ComponentModel.TypeConverter+StandardValuesCollection</ReturnType>
 265       </ReturnValue>
 266       <Parameters>
 267         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
 268       </Parameters>
 269       <Docs>
 270         <remarks>
 271           <attribution license="cc4" from="Microsoft" modified="false" />
 272           <para>The collection returned contains the values of the keys that can be converted.</para>
 273         </remarks>
 274         <summary>
 275           <attribution license="cc4" from="Microsoft" modified="false" />
 276           <para>Returns a collection of standard values for the data type that this type converter is designed for when provided with a format context.</para>
 277         </summary>
 278         <returns>
 279           <attribution license="cc4" from="Microsoft" modified="false" />
 280           <para>A <see cref="T:System.ComponentModel.TypeConverter.StandardValuesCollection" /> that holds a standard set of valid values, which can be empty if the data type does not support a standard set of values.</para>
 281         </returns>
 282         <param name="context">
 283           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this converter is being invoked from. This parameter or properties of this parameter can be null. </param>
 284       </Docs>
 285       <AssemblyInfo>
 286         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 287         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 288       </AssemblyInfo>
 289     </Member>
 290     <Member MemberName="GetStandardValuesExclusive">
 291       <MemberSignature Language="C#" Value="public override bool GetStandardValuesExclusive (System.ComponentModel.ITypeDescriptorContext context);" />
 292       <MemberType>Method</MemberType>
 293       <ReturnValue>
 294         <ReturnType>System.Boolean</ReturnType>
 295       </ReturnValue>
 296       <Parameters>
 297         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
 298       </Parameters>
 299       <Docs>
 300         <remarks>
 301           <attribution license="cc4" from="Microsoft" modified="false" />
 302           <para>The <paramref name="context" /> parameter is not used in the standard implementation of this method.</para>
 303           <para>If the list is exclusive, then no other values are valid, such as in an <see cref="T:System.Enum" /> data type. If the list is not exclusive, then there are other valid values besides the list of standard values <see cref="Overload:System.Windows.Forms.KeysConverter.GetStandardValues" /> provides.</para>
 304         </remarks>
 305         <summary>
 306           <attribution license="cc4" from="Microsoft" modified="false" />
 307           <para>Determines if the list of standard values returned from GetStandardValues is an exclusive list using the specified <see cref="T:System.ComponentModel.ITypeDescriptorContext" />.</para>
 308         </summary>
 309         <returns>
 310           <attribution license="cc4" from="Microsoft" modified="false" />
 311           <para>true if the collection returned from <see cref="Overload:System.Windows.Forms.KeysConverter.GetStandardValues" /> is an exhaustive list of possible values; otherwise, false if other values are possible. The default implementation for this method always returns false. </para>
 312         </returns>
 313         <param name="context">
 314           <attribution license="cc4" from="Microsoft" modified="false" />A formatter context. This object can be used to extract additional information about the environment this converter is being invoked from. This may be null, so you should always check. Also, properties on the context object may also return null. </param>
 315       </Docs>
 316       <AssemblyInfo>
 317         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 318         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 319       </AssemblyInfo>
 320     </Member>
 321     <Member MemberName="GetStandardValuesSupported">
 322       <MemberSignature Language="C#" Value="public override bool GetStandardValuesSupported (System.ComponentModel.ITypeDescriptorContext context);" />
 323       <MemberType>Method</MemberType>
 324       <ReturnValue>
 325         <ReturnType>System.Boolean</ReturnType>
 326       </ReturnValue>
 327       <Parameters>
 328         <Parameter Name="context" Type="System.ComponentModel.ITypeDescriptorContext" />
 329       </Parameters>
 330       <Docs>
 331         <remarks>
 332           <attribution license="cc4" from="Microsoft" modified="false" />
 333           <para>The <paramref name="context" /> parameter is not used in the standard implementation of this method.</para>
 334         </remarks>
 335         <summary>
 336           <attribution license="cc4" from="Microsoft" modified="false" />
 337           <para>Gets a value indicating whether this object supports a standard set of values that can be picked from a list.</para>
 338         </summary>
 339         <returns>
 340           <attribution license="cc4" from="Microsoft" modified="false" />
 341           <para>Always returns true.</para>
 342         </returns>
 343         <param name="context">
 344           <attribution license="cc4" from="Microsoft" modified="false" />An <see cref="T:System.ComponentModel.ITypeDescriptorContext" /> that provides a format context, which can be used to extract additional information about the environment this converter is being invoked from. This parameter or properties of this parameter can be null. </param>
 345       </Docs>
 346       <AssemblyInfo>
 347         <AssemblyVersion>1.0.5000.0</AssemblyVersion>
 348         <AssemblyVersion>2.0.0.0</AssemblyVersion>
 349       </AssemblyInfo>
 350     </Member>
 351   </Members>
 352 </Type>