/
TreeNodeStates.xml
292 lines (283 loc) · 15.5 KB
/
TreeNodeStates.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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
<Type Name="TreeNodeStates" FullName="System.Windows.Forms.TreeNodeStates">
<TypeSignature Language="C#" Value="public enum TreeNodeStates" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed TreeNodeStates extends System.Enum" />
<TypeSignature Language="DocId" Value="T:System.Windows.Forms.TreeNodeStates" />
<TypeSignature Language="VB.NET" Value="Public Enum TreeNodeStates" />
<TypeSignature Language="F#" Value="type TreeNodeStates = " />
<TypeSignature Language="C++ CLI" Value="public enum class TreeNodeStates" />
<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.Enum</BaseTypeName>
</Base>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Flags]</AttributeName>
<AttributeName Language="F#">[<System.Flags>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Defines constants that represent the possible states of a <see cref="T:System.Windows.Forms.TreeNode" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This enumeration is used by the <xref:System.Windows.Forms.DrawTreeNodeEventArgs.State%2A> property of the <xref:System.Windows.Forms.DrawTreeNodeEventArgs> class. For more information, see the <xref:System.Windows.Forms.TreeView.DrawNode?displayProperty=nameWithType> event.
## Examples
The following example demonstrates how to customize a <xref:System.Windows.Forms.TreeView> control using owner drawing. The <xref:System.Windows.Forms.TreeView> control in the example displays optional node tags alongside the normal node labels. Node tags are specified using the <xref:System.Windows.Forms.TreeNode.Tag%2A?displayProperty=nameWithType> property. The <xref:System.Windows.Forms.TreeView> control also uses custom colors, including a custom highlight color.
You can customize most of the <xref:System.Windows.Forms.TreeView> colors by setting color properties, but the selection highlight color is not available as a property. Additionally, the default selection highlight rectangle extends only around a node label. Owner drawing must be used to draw the node tags and to draw a customized highlight rectangle large enough to include a node tag.
In the example, a handler for the <xref:System.Windows.Forms.TreeView.DrawNode?displayProperty=nameWithType> event draws unselected nodes by calling methods of the <xref:System.Windows.Forms.DrawTreeNodeEventArgs> class. These methods provide the default appearance for <xref:System.Windows.Forms.TreeView> elements that do not need customization. The handler draws the node tags and the custom selection highlight manually.
For the complete example, see the <xref:System.Windows.Forms.TreeView.DrawNode?displayProperty=nameWithType> reference topic.
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/TreeViewOwnerDraw/CPP/treeviewownerdraw.cpp" id="Snippet3":::
:::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DrawTreeNodeEventArgs/Overview/treeviewownerdraw.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/TreeViewOwnerDraw/VB/treeviewownerdraw.vb" id="Snippet3":::
]]></format>
</remarks>
<altmember cref="T:System.Windows.Forms.DrawTreeNodeEventArgs" />
<altmember cref="P:System.Windows.Forms.DrawTreeNodeEventArgs.State" />
<altmember cref="E:System.Windows.Forms.TreeView.DrawNode" />
</Docs>
<Members>
<Member MemberName="Checked">
<MemberSignature Language="C#" Value="Checked" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Checked = int32(8)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Checked" />
<MemberSignature Language="VB.NET" Value="Checked" />
<MemberSignature Language="F#" Value="Checked = 8" Usage="System.Windows.Forms.TreeNodeStates.Checked" />
<MemberSignature Language="C++ CLI" Value="Checked" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>The node is checked.</summary>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="Default" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Default = int32(32)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Default" />
<MemberSignature Language="VB.NET" Value="Default" />
<MemberSignature Language="F#" Value="Default = 32" Usage="System.Windows.Forms.TreeNodeStates.Default" />
<MemberSignature Language="C++ CLI" Value="Default" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>32</MemberValue>
<Docs>
<summary>The node is in its default state.</summary>
</Docs>
</Member>
<Member MemberName="Focused">
<MemberSignature Language="C#" Value="Focused" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Focused = int32(16)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Focused" />
<MemberSignature Language="VB.NET" Value="Focused" />
<MemberSignature Language="F#" Value="Focused = 16" Usage="System.Windows.Forms.TreeNodeStates.Focused" />
<MemberSignature Language="C++ CLI" Value="Focused" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>16</MemberValue>
<Docs>
<summary>The node has focus.</summary>
</Docs>
</Member>
<Member MemberName="Grayed">
<MemberSignature Language="C#" Value="Grayed" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Grayed = int32(2)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Grayed" />
<MemberSignature Language="VB.NET" Value="Grayed" />
<MemberSignature Language="F#" Value="Grayed = 2" Usage="System.Windows.Forms.TreeNodeStates.Grayed" />
<MemberSignature Language="C++ CLI" Value="Grayed" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>The node is disabled.</summary>
</Docs>
</Member>
<Member MemberName="Hot">
<MemberSignature Language="C#" Value="Hot" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Hot = int32(64)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Hot" />
<MemberSignature Language="VB.NET" Value="Hot" />
<MemberSignature Language="F#" Value="Hot = 64" Usage="System.Windows.Forms.TreeNodeStates.Hot" />
<MemberSignature Language="C++ CLI" Value="Hot" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>64</MemberValue>
<Docs>
<summary>The node is hot. This state occurs when the <see cref="P:System.Windows.Forms.TreeView.HotTracking" /> property is set to <see langword="true" /> and the mouse pointer is over the node.</summary>
</Docs>
</Member>
<Member MemberName="Indeterminate">
<MemberSignature Language="C#" Value="Indeterminate" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Indeterminate = int32(256)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Indeterminate" />
<MemberSignature Language="VB.NET" Value="Indeterminate" />
<MemberSignature Language="F#" Value="Indeterminate = 256" Usage="System.Windows.Forms.TreeNodeStates.Indeterminate" />
<MemberSignature Language="C++ CLI" Value="Indeterminate" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>256</MemberValue>
<Docs>
<summary>The node in an indeterminate state.</summary>
</Docs>
</Member>
<Member MemberName="Marked">
<MemberSignature Language="C#" Value="Marked" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Marked = int32(128)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Marked" />
<MemberSignature Language="VB.NET" Value="Marked" />
<MemberSignature Language="F#" Value="Marked = 128" Usage="System.Windows.Forms.TreeNodeStates.Marked" />
<MemberSignature Language="C++ CLI" Value="Marked" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>128</MemberValue>
<Docs>
<summary>The node is marked.</summary>
</Docs>
</Member>
<Member MemberName="Selected">
<MemberSignature Language="C#" Value="Selected" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates Selected = int32(1)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.Selected" />
<MemberSignature Language="VB.NET" Value="Selected" />
<MemberSignature Language="F#" Value="Selected = 1" Usage="System.Windows.Forms.TreeNodeStates.Selected" />
<MemberSignature Language="C++ CLI" Value="Selected" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The node is selected.</summary>
</Docs>
</Member>
<Member MemberName="ShowKeyboardCues">
<MemberSignature Language="C#" Value="ShowKeyboardCues" />
<MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Forms.TreeNodeStates ShowKeyboardCues = int32(512)" />
<MemberSignature Language="DocId" Value="F:System.Windows.Forms.TreeNodeStates.ShowKeyboardCues" />
<MemberSignature Language="VB.NET" Value="ShowKeyboardCues" />
<MemberSignature Language="F#" Value="ShowKeyboardCues = 512" Usage="System.Windows.Forms.TreeNodeStates.ShowKeyboardCues" />
<MemberSignature Language="C++ CLI" Value="ShowKeyboardCues" />
<MemberType>Field</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>
<ReturnValue>
<ReturnType>System.Windows.Forms.TreeNodeStates</ReturnType>
</ReturnValue>
<MemberValue>512</MemberValue>
<Docs>
<summary>The node should indicate a keyboard shortcut.</summary>
</Docs>
</Member>
</Members>
</Type>