-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ToolTipEventArgs.xml
226 lines (201 loc) · 16.7 KB
/
ToolTipEventArgs.xml
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
<Type Name="ToolTipEventArgs" FullName="System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs">
<TypeSignature Language="C#" Value="public class ToolTipEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ToolTipEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class ToolTipEventArgs
Inherits EventArgs" />
<TypeSignature Language="F#" Value="type ToolTipEventArgs = class
 inherit EventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class ToolTipEventArgs : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Windows.Forms.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Used as a parameter object in the <see cref="E:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText" /> event of the root <see cref="T:System.Windows.Forms.DataVisualization.Charting.Chart" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class is exposed as the `e` parameter in the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event, and provides the mouse position, tooltip text, if any, and details about the chart element over which the mouse cursor is held when the event is raised.
The <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event is raised several seconds after the mouse cursor is held over a relevant chart element.
The <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs> class contains the following properties:
- The <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.X%2A> and <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Y%2A> properties, which are used to get the mouse coordinates.
- The <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Text%2A> property, which is used to get the tooltip for the chart element that the event is raised for. Note that many of the chart elements have a `ToolTip`, `LegendToolTip`, and/or `LabelToolTip` property that you can use to assign a tooltip. These elements include legends, annotations, data points, series, axes, titles, custom labels, and strip lines. This property can also be used to override the tooltip for a chart element, or to set a tooltip for a chart element that doesn't have a `ToolTip` property.
- The <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.HitTestResult%2A> property, which provides information on the chart element for which the event was raised.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolTipEventArgs (int x, int y, string text, System.Windows.Forms.DataVisualization.Charting.HitTestResult result);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 x, int32 y, string text, class System.Windows.Forms.DataVisualization.Charting.HitTestResult result) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.#ctor(System.Int32,System.Int32,System.String,System.Windows.Forms.DataVisualization.Charting.HitTestResult)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (x As Integer, y As Integer, text As String, result As HitTestResult)" />
<MemberSignature Language="F#" Value="new System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs : int * int * string * System.Windows.Forms.DataVisualization.Charting.HitTestResult -> System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs" Usage="new System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs (x, y, text, result)" />
<MemberSignature Language="C++ CLI" Value="public:
 ToolTipEventArgs(int x, int y, System::String ^ text, System::Windows::Forms::DataVisualization::Charting::HitTestResult ^ result);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="text" Type="System.String" />
<Parameter Name="result" Type="System.Windows.Forms.DataVisualization.Charting.HitTestResult" />
</Parameters>
<Docs>
<param name="x">X-coordinate of mouse.</param>
<param name="y">Y-coordinate of mouse.</param>
<param name="text">The tooltip text.</param>
<param name="result">The <see cref="T:System.Windows.Forms.DataVisualization.Charting.HitTestResult" /> object.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs" /> class with the specified <paramref name="x" />, <paramref name="y" />, <paramref name="text" /> and <paramref name="result" /> parameters.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HitTestResult">
<MemberSignature Language="C#" Value="public System.Windows.Forms.DataVisualization.Charting.HitTestResult HitTestResult { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Forms.DataVisualization.Charting.HitTestResult HitTestResult" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.HitTestResult" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property HitTestResult As HitTestResult" />
<MemberSignature Language="F#" Value="member this.HitTestResult : System.Windows.Forms.DataVisualization.Charting.HitTestResult" Usage="System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.HitTestResult" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Forms::DataVisualization::Charting::HitTestResult ^ HitTestResult { System::Windows::Forms::DataVisualization::Charting::HitTestResult ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Forms.DataVisualization.Charting.HitTestResult</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Windows.Forms.DataVisualization.Charting.HitTestResult" /> object, which provides information about the chart element that the <see cref="E:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText" /> event was raised for.</summary>
<value>A <see cref="T:System.Windows.Forms.DataVisualization.Charting.HitTestResult" /> object that represents information for the element the <see cref="E:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText" /> event was raised for.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is exposed in the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event of the root <xref:System.Windows.Forms.DataVisualization.Charting.Chart> object.
The <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.HitTestResult%2A> property can be used to get the object the event was raised for, the type of the chart element the event was raised for, and so forth. For further details, see the <xref:System.Windows.Forms.DataVisualization.Charting.HitTestResult> class overview.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public string Text { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Text" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Text" />
<MemberSignature Language="VB.NET" Value="Public Property Text As String" />
<MemberSignature Language="F#" Value="member this.Text : string with get, set" Usage="System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Text" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Text { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the tooltip, if any, of the chart element over which the mouse cursor is held. This property can also set a tooltip for this chart element.</summary>
<value>A <see langword="string" /> value that represents the tooltip text of the element the <see cref="E:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText" /> event was raised for.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is exposed in the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event of the root <xref:System.Windows.Forms.DataVisualization.Charting.Chart> object.
- The <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Text%2A> property, which is used to get the tooltip for the chart element that the event is raised for. Note that many of the chart elements have a `ToolTip`, `LegendToolTip`, and/or `LabelToolTip` property that you can use to assign a tooltip. These elements include legends, annotations, data points, series, axes, titles, custom labels, and strip lines.
- If you get this property, it will always return a zero-length string for any chart element items that do not have a tooltip.
You can set this property to:
- Override the tooltip for any of the chart elements capable of assigning tooltips.
- Assign a tooltip to a chart element that does not support tooltips.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="X">
<MemberSignature Language="C#" Value="public int X { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 X" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.X" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property X As Integer" />
<MemberSignature Language="F#" Value="member this.X : int" Usage="System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.X" />
<MemberSignature Language="C++ CLI" Value="public:
 property int X { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the X coordinate of the point the mouse cursor is held over when the <see cref="E:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText" /> event is raised.</summary>
<value>An <see langword="integer" /> value that represents the X coordinate of the mouse cursor.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is exposed in the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event of the root <xref:System.Windows.Forms.DataVisualization.Charting.Chart> object.
Use the <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.X%2A> property to get the X screen coordinate of the point the mouse cursor is held over when the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event is raised.
Note that the X coordinate is measured in pixels; the point (0,0) corresponds to the top-left corner of the chart.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Y">
<MemberSignature Language="C#" Value="public int Y { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Y" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Y" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Y As Integer" />
<MemberSignature Language="F#" Value="member this.Y : int" Usage="System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Y" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Y { int get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms.DataVisualization</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the Y coordinate of the point the mouse cursor is held over when the <see cref="E:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText" /> event is raised.</summary>
<value>An <see langword="integer" /> that represents the Y coordinate of the mouse cursor.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This property is exposed in the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event of the root <xref:System.Windows.Forms.DataVisualization.Charting.Chart> object.
Use the <xref:System.Windows.Forms.DataVisualization.Charting.ToolTipEventArgs.Y%2A> property to get the Y screen coordinate of the point the mouse cursor is held over when the <xref:System.Windows.Forms.DataVisualization.Charting.Chart.GetToolTipText> event is raised.
Note that the Y coordinate is measured in pixels; the point (0,0) corresponds to the top-left corner of the chart.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>