-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ToolStripItemRenderEventArgs.xml
273 lines (242 loc) · 18.4 KB
/
ToolStripItemRenderEventArgs.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
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
<Type Name="ToolStripItemRenderEventArgs" FullName="System.Windows.Forms.ToolStripItemRenderEventArgs">
<TypeSignature Language="C#" Value="public class ToolStripItemRenderEventArgs : EventArgs" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ToolStripItemRenderEventArgs extends System.EventArgs" />
<TypeSignature Language="DocId" Value="T:System.Windows.Forms.ToolStripItemRenderEventArgs" />
<TypeSignature Language="VB.NET" Value="Public Class ToolStripItemRenderEventArgs
Inherits EventArgs" />
<TypeSignature Language="F#" Value="type ToolStripItemRenderEventArgs = class
 inherit EventArgs" />
<TypeSignature Language="C++ CLI" Value="public ref class ToolStripItemRenderEventArgs : EventArgs" />
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.EventArgs</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Provides data for the events that render the background of objects derived from <see cref="T:System.Windows.Forms.ToolStripItem" /> in the <see cref="T:System.Windows.Forms.ToolStripRenderer" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Windows.Forms.ToolStripItemRenderEventArgs> class provides data for the following events:
- <xref:System.Windows.Forms.ToolStripRenderer.RenderButtonBackground>
- <xref:System.Windows.Forms.ToolStripRenderer.RenderDropDownButtonBackground>
- <xref:System.Windows.Forms.ToolStripRenderer.RenderItemBackground>
- <xref:System.Windows.Forms.ToolStripRenderer.RenderLabelBackground>
- <xref:System.Windows.Forms.ToolStripRenderer.RenderMenuItemBackground>
- <xref:System.Windows.Forms.ToolStripRenderer.RenderOverflowButtonBackground>
- <xref:System.Windows.Forms.ToolStripRenderer.RenderSplitButtonBackground>
In addition, it provides data for the following methods:
- <xref:System.Windows.Forms.ToolStripRenderer.DrawButtonBackground%2A>
- <xref:System.Windows.Forms.ToolStripRenderer.DrawDropDownButtonBackground%2A>
- <xref:System.Windows.Forms.ToolStripRenderer.DrawItemBackground%2A>
- <xref:System.Windows.Forms.ToolStripRenderer.DrawLabelBackground%2A>
- <xref:System.Windows.Forms.ToolStripRenderer.DrawMenuItemBackground%2A>
- <xref:System.Windows.Forms.ToolStripRenderer.DrawOverflowButtonBackground%2A>
- <xref:System.Windows.Forms.ToolStripRenderer.DrawSplitButton%2A>
## Examples
The following code example demonstrates how to override the <xref:System.Windows.Forms.ToolStripRenderer.OnRenderButtonBackground%2A> method to draw a border around a <xref:System.Windows.Forms.ToolStripButton> control's <xref:System.Windows.Forms.ToolStripItem.Image%2A>. This code example is part of a larger example provided for the <xref:System.Windows.Forms.ToolStripRenderer> class.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LayoutSettings/Overview/GridStrip.cs" id="Snippet14":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ToolStrip.GridStrip/VB/GridStrip.vb" id="Snippet14":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.ToolStripRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripProfessionalRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripSystemRenderer" />
<related type="Article" href="/dotnet/framework/winforms/controls/how-to-implement-a-custom-toolstriprenderer">How to: Implement a Custom ToolStripRenderer</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolStripItemRenderEventArgs (System.Drawing.Graphics g, System.Windows.Forms.ToolStripItem item);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Drawing.Graphics g, class System.Windows.Forms.ToolStripItem item) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Forms.ToolStripItemRenderEventArgs.#ctor(System.Drawing.Graphics,System.Windows.Forms.ToolStripItem)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (g As Graphics, item As ToolStripItem)" />
<MemberSignature Language="F#" Value="new System.Windows.Forms.ToolStripItemRenderEventArgs : System.Drawing.Graphics * System.Windows.Forms.ToolStripItem -> System.Windows.Forms.ToolStripItemRenderEventArgs" Usage="new System.Windows.Forms.ToolStripItemRenderEventArgs (g, item)" />
<MemberSignature Language="C++ CLI" Value="public:
 ToolStripItemRenderEventArgs(System::Drawing::Graphics ^ g, System::Windows::Forms::ToolStripItem ^ item);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="g" Type="System.Drawing.Graphics" />
<Parameter Name="item" Type="System.Windows.Forms.ToolStripItem" />
</Parameters>
<Docs>
<param name="g">The <see cref="T:System.Drawing.Graphics" /> object used to draw the item.</param>
<param name="item">The <see cref="T:System.Windows.Forms.ToolStripItem" /> to be drawn.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Forms.ToolStripItemRenderEventArgs" /> class for the specified <see cref="T:System.Windows.Forms.ToolStripItem" /> and using the specified <see cref="T:System.Drawing.Graphics" />.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="g" /> or <paramref name="item" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="Graphics">
<MemberSignature Language="C#" Value="public System.Drawing.Graphics Graphics { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Drawing.Graphics Graphics" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.ToolStripItemRenderEventArgs.Graphics" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Graphics As Graphics" />
<MemberSignature Language="F#" Value="member this.Graphics : System.Drawing.Graphics" Usage="System.Windows.Forms.ToolStripItemRenderEventArgs.Graphics" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Drawing::Graphics ^ Graphics { System::Drawing::Graphics ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.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.Drawing.Graphics</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the graphics used to paint the <see cref="T:System.Windows.Forms.ToolStripItem" />.</summary>
<value>The <see cref="T:System.Drawing.Graphics" /> used to paint the <see cref="T:System.Windows.Forms.ToolStripItem" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to override the <xref:System.Windows.Forms.ToolStripRenderer.OnRenderButtonBackground%2A> method to draw a border around a <xref:System.Windows.Forms.ToolStripButton> control's <xref:System.Windows.Forms.ToolStripItem.Image%2A>. This code example is part of a larger example provided for the <xref:System.Windows.Forms.ToolStripRenderer> class.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LayoutSettings/Overview/GridStrip.cs" id="Snippet14":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ToolStrip.GridStrip/VB/GridStrip.vb" id="Snippet14":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.ToolStripRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripProfessionalRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripSystemRenderer" />
<related type="Article" href="/dotnet/framework/winforms/controls/how-to-implement-a-custom-toolstriprenderer">How to: Implement a Custom ToolStripRenderer</related>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public System.Windows.Forms.ToolStripItem Item { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Forms.ToolStripItem Item" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.ToolStripItemRenderEventArgs.Item" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Item As ToolStripItem" />
<MemberSignature Language="F#" Value="member this.Item : System.Windows.Forms.ToolStripItem" Usage="System.Windows.Forms.ToolStripItemRenderEventArgs.Item" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Forms::ToolStripItem ^ Item { System::Windows::Forms::ToolStripItem ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.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.ToolStripItem</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Windows.Forms.ToolStripItem" /> to paint.</summary>
<value>The <see cref="T:System.Windows.Forms.ToolStripItem" /> to paint.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to override the <xref:System.Windows.Forms.ToolStripRenderer.OnRenderButtonBackground%2A> method to draw a border around a <xref:System.Windows.Forms.ToolStripButton> control's <xref:System.Windows.Forms.ToolStripItem.Image%2A>. This code example is part of a larger example provided for the <xref:System.Windows.Forms.ToolStripRenderer> class.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LayoutSettings/Overview/GridStrip.cs" id="Snippet14":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ToolStrip.GridStrip/VB/GridStrip.vb" id="Snippet14":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.ToolStripRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripProfessionalRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripSystemRenderer" />
<related type="Article" href="/dotnet/framework/winforms/controls/how-to-implement-a-custom-toolstriprenderer">How to: Implement a Custom ToolStripRenderer</related>
</Docs>
</Member>
<Member MemberName="ToolStrip">
<MemberSignature Language="C#" Value="public System.Windows.Forms.ToolStrip ToolStrip { get; }" FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1;windowsdesktop-3.0;windowsdesktop-3.1;windowsdesktop-5.0;windowsdesktop-6.0" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Forms.ToolStrip ToolStrip" />
<MemberSignature Language="DocId" Value="P:System.Windows.Forms.ToolStripItemRenderEventArgs.ToolStrip" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ToolStrip As ToolStrip" />
<MemberSignature Language="F#" Value="member this.ToolStrip : System.Windows.Forms.ToolStrip" Usage="System.Windows.Forms.ToolStripItemRenderEventArgs.ToolStrip" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Forms::ToolStrip ^ ToolStrip { System::Windows::Forms::ToolStrip ^ get(); };" />
<MemberSignature Language="C#" Value="public System.Windows.Forms.ToolStrip? ToolStrip { get; }" FrameworkAlternate="windowsdesktop-7.0;windowsdesktop-8.0;windowsdesktop-9.0" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Windows.Forms</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(2)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="windowsdesktop-8.0;windowsdesktop-9.0">
<AttributeName Language="C#">[get: System.Runtime.CompilerServices.NullableContext(2)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.CompilerServices.NullableContext(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.Forms.ToolStrip</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value of the <see cref="P:System.Windows.Forms.ToolStripItem.Owner" /> property for the <see cref="T:System.Windows.Forms.ToolStripItem" /> to paint.</summary>
<value>The <see cref="T:System.Windows.Forms.ToolStrip" /> that is the owner of the <see cref="T:System.Windows.Forms.ToolStripItem" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If the <xref:System.Windows.Forms.ToolStripItem> is in the overflow area of the <xref:System.Windows.Forms.Form>, the <xref:System.Windows.Forms.ToolStripItemRenderEventArgs.ToolStrip%2A> property returns an empty string.
## Examples
The following code example demonstrates how to override the <xref:System.Windows.Forms.ToolStripRenderer.OnRenderButtonBackground%2A> method to draw a border around a <xref:System.Windows.Forms.ToolStripButton> control's <xref:System.Windows.Forms.ToolStripItem.Image%2A>. This code example is part of a larger example provided for the <xref:System.Windows.Forms.ToolStripRenderer> class.
:::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/LayoutSettings/Overview/GridStrip.cs" id="Snippet14":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/System.Windows.Forms.ToolStrip.GridStrip/VB/GridStrip.vb" id="Snippet14":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.ToolStripRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripProfessionalRenderer" />
<altmember cref="T:System.Windows.Forms.ToolStripSystemRenderer" />
<related type="Article" href="/dotnet/framework/winforms/controls/how-to-implement-a-custom-toolstriprenderer">How to: Implement a Custom ToolStripRenderer</related>
</Docs>
</Member>
</Members>
</Type>