1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="ConsoleKeyInfo" FullName="System.ConsoleKeyInfo">
<TypeSignature Language="C#" Value="public struct ConsoleKeyInfo" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi serializable sealed beforefieldinit ConsoleKeyInfo extends System.ValueType" />
<AssemblyInfo>
<AssemblyName>mscorlib</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="T:System.ConsoleKeyInfo" /> type is not intended to be created by users. Instead, it is returned to the user in response to calling the <see cref="M:System.Console.ReadKey" /> method.</para>
<para>The <see cref="T:System.ConsoleKeyInfo" /> object describes the <see cref="T:System.ConsoleKey" /> constant and Unicode character, if any, that correspond to the pressed console key. The <see cref="T:System.ConsoleKeyInfo" /> object also describes, in a bitwise combination of <see cref="T:System.ConsoleModifiers" /> values, whether one or more SHIFT, ALT, or CTRL modifier keys was pressed simultaneously with the console key.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Describes the console key that was pressed, including the character represented by the console key and the state of the SHIFT, ALT, and CTRL modifier keys.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsoleKeyInfo (char keyChar, ConsoleKey key, bool shift, bool alt, bool control);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(char keyChar, valuetype System.ConsoleKey key, bool shift, bool alt, bool control) cil managed" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="keyChar" Type="System.Char" />
<Parameter Name="key" Type="System.ConsoleKey" />
<Parameter Name="shift" Type="System.Boolean" />
<Parameter Name="alt" Type="System.Boolean" />
<Parameter Name="control" Type="System.Boolean" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>This type is not intended to be created by users. Instead, it is returned to the user in response to calling the <see cref="M:System.Console.ReadKey" /> method.</para>
<para>The <see cref="T:System.ConsoleKeyInfo" /> type does not specify whether the left or right SHIFT, ALT, or CTRL modifier key was pressed.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.ConsoleKeyInfo" /> structure using the specified character, console key, and modifier keys.</para>
</summary>
<param name="keyChar">
<attribution license="cc4" from="Microsoft" modified="false" />The Unicode character that corresponds to the <paramref name="key" /> parameter. </param>
<param name="key">
<attribution license="cc4" from="Microsoft" modified="false" />The console key that corresponds to the <paramref name="keyChar" /> parameter. </param>
<param name="shift">
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate that a SHIFT key was pressed; otherwise, false. </param>
<param name="alt">
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate that an ALT key was pressed; otherwise, false. </param>
<param name="control">
<attribution license="cc4" from="Microsoft" modified="false" />true to indicate that a CTRL key was pressed; otherwise, false. </param>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public bool Equals (ConsoleKeyInfo obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Equals(valuetype System.ConsoleKeyInfo obj) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.ConsoleKeyInfo" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Two <see cref="T:System.ConsoleKeyInfo" /> objects are equal if their corresponding <see cref="P:System.ConsoleKeyInfo.KeyChar" />, <see cref="P:System.ConsoleKeyInfo.Key" />, and <see cref="P:System.ConsoleKeyInfo.Modifiers" /> properties are equal.</para>
<para>The <see cref="M:System.ConsoleKeyInfo.Equals(System.ConsoleKeyInfo)" /> method performs slightly better than the <see cref="M:System.ConsoleKeyInfo.Equals(System.Object)" /> method because it does not have to convert <paramref name="obj" /> to an object.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the specified <see cref="T:System.ConsoleKeyInfo" /> object is equal to the current <see cref="T:System.ConsoleKeyInfo" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="obj" /> is equal to the current <see cref="T:System.ConsoleKeyInfo" /> object; otherwise, false.</para>
</returns>
<param name="obj">
<attribution license="cc4" from="Microsoft" modified="false" />An object to compare to the current <see cref="T:System.ConsoleKeyInfo" /> object.</param>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Two <see cref="T:System.ConsoleKeyInfo" /> objects are equal if their corresponding <see cref="P:System.ConsoleKeyInfo.KeyChar" />, <see cref="P:System.ConsoleKeyInfo.Key" />, and <see cref="P:System.ConsoleKeyInfo.Modifiers" /> properties are equal.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a value indicating whether the specified object is equal to the current <see cref="T:System.ConsoleKeyInfo" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="value" /> is a <see cref="T:System.ConsoleKeyInfo" /> object and is equal to the current <see cref="T:System.ConsoleKeyInfo" /> object; otherwise, false.</para>
</returns>
<param name="value">
<attribution license="cc4" from="Microsoft" modified="false" />An object to compare to the current <see cref="T:System.ConsoleKeyInfo" /> object.</param>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The value returned by the <see cref="M:System.ConsoleKeyInfo.GetHashCode" /> method is not suitable for distinguishing one <see cref="T:System.ConsoleKeyInfo" /> object from another. If your application needs a unique hash code, override the <see cref="M:System.ConsoleKeyInfo.GetHashCode" /> method with your own method.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns the hash code for the current <see cref="T:System.ConsoleKeyInfo" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A 32-bit signed integer hash code.</para>
</returns>
</Docs>
</Member>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public ConsoleKey Key { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ConsoleKey Key" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ConsoleKey</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the console key represented by the current <see cref="T:System.ConsoleKeyInfo" /> object.</para>
</summary>
</Docs>
</Member>
<Member MemberName="KeyChar">
<MemberSignature Language="C#" Value="public char KeyChar { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance char KeyChar" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>If the key pressed does not map to a Unicode character (for example, if the user presses the <ui>F1</ui> key or the <ui>Home</ui> key), the value of the <see cref="P:System.ConsoleKeyInfo.KeyChar" /> property is \U0000.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets the Unicode character represented by the current <see cref="T:System.ConsoleKeyInfo" /> object.</para>
</summary>
</Docs>
</Member>
<Member MemberName="Modifiers">
<MemberSignature Language="C#" Value="public ConsoleModifiers Modifiers { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ConsoleModifiers Modifiers" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.ConsoleModifiers</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets a bitwise combination of <see cref="T:System.ConsoleModifiers" /> values that specifies one or more modifier keys pressed simultaneously with the console key.</para>
</summary>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool op_Equality (ConsoleKeyInfo a, ConsoleKeyInfo b);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.ConsoleKeyInfo a, valuetype System.ConsoleKeyInfo b) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.ConsoleKeyInfo" />
<Parameter Name="b" Type="System.ConsoleKeyInfo" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Two <see cref="T:System.ConsoleKeyInfo" /> objects are equal if their corresponding <see cref="P:System.ConsoleKeyInfo.KeyChar" />, <see cref="P:System.ConsoleKeyInfo.Key" />, and <see cref="P:System.ConsoleKeyInfo.Modifiers" /> properties are equal.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the specified <see cref="T:System.ConsoleKeyInfo" /> objects are equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="a" /> is equal to <paramref name="b" />; otherwise, false.</para>
</returns>
<param name="a">
<attribution license="cc4" from="Microsoft" modified="false" />The first object to compare.</param>
<param name="b">
<attribution license="cc4" from="Microsoft" modified="false" />The second object to compare.</param>
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool op_Inequality (ConsoleKeyInfo a, ConsoleKeyInfo b);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.ConsoleKeyInfo a, valuetype System.ConsoleKeyInfo b) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="a" Type="System.ConsoleKeyInfo" />
<Parameter Name="b" Type="System.ConsoleKeyInfo" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Two <see cref="T:System.ConsoleKeyInfo" /> objects are equal if their corresponding <see cref="P:System.ConsoleKeyInfo.KeyChar" />, <see cref="P:System.ConsoleKeyInfo.Key" />, and <see cref="P:System.ConsoleKeyInfo.Modifiers" /> properties are equal.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates whether the specified <see cref="T:System.ConsoleKeyInfo" /> objects are not equal.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>true if <paramref name="a" /> is not equal to <paramref name="b" />; otherwise, false.</para>
</returns>
<param name="a">
<attribution license="cc4" from="Microsoft" modified="false" />The first object to compare.</param>
<param name="b">
<attribution license="cc4" from="Microsoft" modified="false" />The second object to compare.</param>
</Docs>
</Member>
</Members>
</Type>
|