Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
263 lines (234 sloc) 19.4 KB
<Type Name="UICuesEventArgs" FullName="System.Windows.Forms.UICuesEventArgs">
<TypeSignature Language="C#" Value="public class UICuesEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit UICuesEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:System.Windows.Forms.UICuesEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class UICuesEventArgs&#xA;Inherits EventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class UICuesEventArgs : EventArgs" />
<TypeSignature Language="F#" Value="type UICuesEventArgs = class&#xA; inherit EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides data for the <see cref="E:System.Windows.Forms.Control.ChangeUICues" /> event.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A <xref:System.Windows.Forms.UICuesEventArgs> specifies which user interface feature changed and its new value.
The <xref:System.Windows.Forms.Control.ChangeUICues> event occurs when the user interface changes by showing or hiding focus indicators or keyboard cues. This is usually when the user presses the TAB, ALT, or F10 keys.
For information about the event model, see [Handling and Raising Events](~/docs/standard/events/index.md).
## Examples
The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.Control.ChangeUICues> 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 <xref:System.Windows.Forms.MessageBox.Show%2A> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of a type that inherits from <xref:System.Windows.Forms.Control>, such as a <xref:System.Windows.Forms.Button> or <xref:System.Windows.Forms.ComboBox>. Then name the instance `Control1` and ensure that the event handler is associated with the <xref:System.Windows.Forms.Control.ChangeUICues> event.
[!code-csharp[System.Windows.Forms.EventExamples#67](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs#67)]
[!code-vb[System.Windows.Forms.EventExamples#67](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb#67)]
]]></format>
</remarks>
<altmember cref="E:System.Windows.Forms.Control.ChangeUICues" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UICuesEventArgs (System.Windows.Forms.UICues uicues);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Windows.Forms.UICues uicues) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Forms.UICuesEventArgs.#ctor(System.Windows.Forms.UICues)" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; UICuesEventArgs(System::Windows::Forms::UICues uicues);" />
<MemberSignature Language="F#" Value="new System.Windows.Forms.UICuesEventArgs : System.Windows.Forms.UICues -&gt; System.Windows.Forms.UICuesEventArgs" Usage="new System.Windows.Forms.UICuesEventArgs uicues" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="uicues" Type="System.Windows.Forms.UICues" />
</Parameters>
<Docs>
<param name="uicues">A bitwise combination of the <see cref="T:System.Windows.Forms.UICues" /> values.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Forms.UICuesEventArgs" /> class with the specified <see cref="T:System.Windows.Forms.UICues" />.</summary>
<remarks>To be added.</remarks>
<altmember cref="T:System.Windows.Forms.UICues" />
<altmember cref="T:System.Windows.Forms.Control" />
</Docs>
</Member>
<Member MemberName="Changed">
<MemberSignature Language="C#" Value="public System.Windows.Forms.UICues Changed { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Forms.UICues Changed" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.UICuesEventArgs.Changed" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Changed As UICues" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::Forms::UICues Changed { System::Windows::Forms::UICues get(); };" />
<MemberSignature Language="F#" Value="member this.Changed : System.Windows.Forms.UICues" Usage="System.Windows.Forms.UICuesEventArgs.Changed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Forms.UICues</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the bitwise combination of the <see cref="T:System.Windows.Forms.UICues" /> values.</summary>
<value>A bitwise combination of the <see cref="T:System.Windows.Forms.UICues" /> values. The default is <see cref="F:System.Windows.Forms.UICues.Changed" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> 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 <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of a type that inherits from <xref:System.Windows.Forms.Control>, such as a <xref:System.Windows.Forms.Button> or <xref:System.Windows.Forms.ComboBox>. Then name the instance `Control1` and ensure that the event handler is associated with the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> event.
[!code-csharp[System.Windows.Forms.EventExamples#67](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs#67)]
[!code-vb[System.Windows.Forms.EventExamples#67](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb#67)]
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.UICues" />
</Docs>
</Member>
<Member MemberName="ChangeFocus">
<MemberSignature Language="C#" Value="public bool ChangeFocus { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ChangeFocus" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.UICuesEventArgs.ChangeFocus" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ChangeFocus As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool ChangeFocus { bool get(); };" />
<MemberSignature Language="F#" Value="member this.ChangeFocus : bool" Usage="System.Windows.Forms.UICuesEventArgs.ChangeFocus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the state of the focus cues has changed.</summary>
<value>
<see langword="true" /> if the state of the focus cues has changed; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> 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 <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of a type that inherits from <xref:System.Windows.Forms.Control>, such as a <xref:System.Windows.Forms.Button> or <xref:System.Windows.Forms.ComboBox>. Then name the instance `Control1` and ensure that the event handler is associated with the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> event.
[!code-csharp[System.Windows.Forms.EventExamples#67](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs#67)]
[!code-vb[System.Windows.Forms.EventExamples#67](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb#67)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ShowFocus" />
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ChangeKeyboard" />
</Docs>
</Member>
<Member MemberName="ChangeKeyboard">
<MemberSignature Language="C#" Value="public bool ChangeKeyboard { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ChangeKeyboard" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.UICuesEventArgs.ChangeKeyboard" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ChangeKeyboard As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool ChangeKeyboard { bool get(); };" />
<MemberSignature Language="F#" Value="member this.ChangeKeyboard : bool" Usage="System.Windows.Forms.UICuesEventArgs.ChangeKeyboard" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the state of the keyboard cues has changed.</summary>
<value>
<see langword="true" /> if the state of the keyboard cues has changed; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> 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 <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of a type that inherits from <xref:System.Windows.Forms.Control>, such as a <xref:System.Windows.Forms.Button> or <xref:System.Windows.Forms.ComboBox>. Then name the instance `Control1` and ensure that the event handler is associated with the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> event.
[!code-csharp[System.Windows.Forms.EventExamples#67](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs#67)]
[!code-vb[System.Windows.Forms.EventExamples#67](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb#67)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ShowKeyboard" />
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ChangeFocus" />
</Docs>
</Member>
<Member MemberName="ShowFocus">
<MemberSignature Language="C#" Value="public bool ShowFocus { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ShowFocus" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.UICuesEventArgs.ShowFocus" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ShowFocus As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool ShowFocus { bool get(); };" />
<MemberSignature Language="F#" Value="member this.ShowFocus : bool" Usage="System.Windows.Forms.UICuesEventArgs.ShowFocus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether focus rectangles are shown after the change.</summary>
<value>
<see langword="true" /> if focus rectangles are shown after the change; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> 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 <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of a type that inherits from <xref:System.Windows.Forms.Control>, such as a <xref:System.Windows.Forms.Button> or <xref:System.Windows.Forms.ComboBox>. Then name the instance `Control1` and ensure that the event handler is associated with the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> event.
[!code-csharp[System.Windows.Forms.EventExamples#67](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs#67)]
[!code-vb[System.Windows.Forms.EventExamples#67](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb#67)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ChangeFocus" />
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ShowKeyboard" />
</Docs>
</Member>
<Member MemberName="ShowKeyboard">
<MemberSignature Language="C#" Value="public bool ShowKeyboard { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ShowKeyboard" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.UICuesEventArgs.ShowKeyboard" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ShowKeyboard As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property bool ShowKeyboard { bool get(); };" />
<MemberSignature Language="F#" Value="member this.ShowKeyboard : bool" Usage="System.Windows.Forms.UICuesEventArgs.ShowKeyboard" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether keyboard cues are underlined after the change.</summary>
<value>
<see langword="true" /> if keyboard cues are underlined after the change; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> 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 <xref:System.Windows.Forms.MessageBox.Show%2A?displayProperty=nameWithType> with <xref:System.Console.WriteLine%2A?displayProperty=nameWithType> or appending the message to a multiline <xref:System.Windows.Forms.TextBox>.
To run the example code, paste it into a project that contains an instance of a type that inherits from <xref:System.Windows.Forms.Control>, such as a <xref:System.Windows.Forms.Button> or <xref:System.Windows.Forms.ComboBox>. Then name the instance `Control1` and ensure that the event handler is associated with the <xref:System.Windows.Forms.Control.ChangeUICues?displayProperty=nameWithType> event.
[!code-csharp[System.Windows.Forms.EventExamples#67](~/samples/snippets/csharp/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/CS/EventExamples.cs#67)]
[!code-vb[System.Windows.Forms.EventExamples#67](~/samples/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.EventExamples/VB/EventExamples.vb#67)]
]]></format>
</remarks>
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ChangeKeyboard" />
<altmember cref="P:System.Windows.Forms.UICuesEventArgs.ShowFocus" />
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.