/
NonVisualControlAttribute.xml
334 lines (309 loc) · 21 KB
/
NonVisualControlAttribute.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
<Type Name="NonVisualControlAttribute" FullName="System.Web.UI.NonVisualControlAttribute">
<TypeSignature Language="C#" Value="public sealed class NonVisualControlAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit NonVisualControlAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.NonVisualControlAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class NonVisualControlAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type NonVisualControlAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class NonVisualControlAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Class)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Class)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Defines the attribute that indicates whether a control is treated as a visual or non-visual control during design time. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.NonVisualControlAttribute> attribute is applied to controls that are not rendered to the client, such as data source controls and the <xref:System.Web.UI.WebControls.WebParts.WebPartManager> control. During design time, a page developer might decide to hide all non-visual controls. The designer would mark as invisible all of the controls with the <xref:System.Web.UI.NonVisualControlAttribute> attribute set to `true`.
Examples of controls that employ the <xref:System.Web.UI.NonVisualControlAttribute> attribute are <xref:System.Web.UI.DataSourceControl>, <xref:System.Web.UI.HierarchicalDataSourceControl>, <xref:System.Web.UI.WebControls.HiddenField>, and <xref:System.Web.UI.WebControls.WebParts.WebPartManager>.
## Examples
The following code example demonstrates how you can apply the <xref:System.Web.UI.NonVisualControlAttribute> attribute to a class. In this example, the default <xref:System.Web.UI.NonVisualControlAttribute> attribute is applied to a data source control. This is equivalent to the <xref:System.Web.UI.NonVisualControlAttribute.NonVisual> field.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.NonVisualControlAttribute/CS/nonvisualcontrolattribute1.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.NonVisualControlAttribute/VB/nonvisualcontrolattribute1.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.DataSourceControl" />
<altmember cref="T:System.Web.UI.HierarchicalDataSourceControl" />
<altmember cref="T:System.Web.UI.WebControls.HiddenField" />
<altmember cref="T:System.Web.UI.WebControls.WebParts.WebPartManager" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.NonVisualControlAttribute" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NonVisualControlAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.NonVisualControlAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 NonVisualControlAttribute();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.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 />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.NonVisualControlAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A default instance of the <xref:System.Web.UI.NonVisualControlAttribute> class is equivalent to the <xref:System.Web.UI.NonVisualControlAttribute.NonVisual> field, or passing `true` to the <xref:System.Web.UI.NonVisualControlAttribute.%23ctor%28System.Boolean%29?displayProperty=nameWithType> constructor.
## Examples
The following code example demonstrates how you can apply the <xref:System.Web.UI.NonVisualControlAttribute> attribute to a class. In this example, the default <xref:System.Web.UI.NonVisualControlAttribute> attribute is applied to a data source control. This is equivalent to the <xref:System.Web.UI.NonVisualControlAttribute.NonVisual> field.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.NonVisualControlAttribute/CS/nonvisualcontrolattribute1.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.NonVisualControlAttribute/VB/nonvisualcontrolattribute1.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="F:System.Web.UI.NonVisualControlAttribute.NonVisual" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public NonVisualControlAttribute (bool nonVisual);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool nonVisual) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.NonVisualControlAttribute.#ctor(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (nonVisual As Boolean)" />
<MemberSignature Language="F#" Value="new System.Web.UI.NonVisualControlAttribute : bool -> System.Web.UI.NonVisualControlAttribute" Usage="new System.Web.UI.NonVisualControlAttribute nonVisual" />
<MemberSignature Language="C++ CLI" Value="public:
 NonVisualControlAttribute(bool nonVisual);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.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="nonVisual" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="nonVisual">
<see langword="true" /> to initialize the <see cref="T:System.Web.UI.NonVisualControlAttribute" /> to represent a Web control that is not rendered to the client at run time; otherwise, <see langword="false" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.NonVisualControlAttribute" /> class, using the specified Boolean value to determine whether the attribute represents a visual or non-visual control.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Passing `true` to this constructor is equivalent to using the <xref:System.Web.UI.NonVisualControlAttribute.NonVisual> field, and passing `false` is equivalent to using the <xref:System.Web.UI.NonVisualControlAttribute.Visual> field.
## Examples
The following code example demonstrates how you can apply the <xref:System.Web.UI.NonVisualControlAttribute> attribute to a class. In this example, a data source control is designated as a non-visual control by passing `true` to the attribute.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.NonVisualControlAttribute/CS/nonvisualcontrolattribute2.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.NonVisualControlAttribute/VB/nonvisualcontrolattribute2.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.NonVisualControlAttribute Default;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Web.UI.NonVisualControlAttribute Default" />
<MemberSignature Language="DocId" Value="F:System.Web.UI.NonVisualControlAttribute.Default" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Default As NonVisualControlAttribute " />
<MemberSignature Language="F#" Value=" staticval mutable Default : System.Web.UI.NonVisualControlAttribute" Usage="System.Web.UI.NonVisualControlAttribute.Default" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Web::UI::NonVisualControlAttribute ^ Default;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.NonVisualControlAttribute</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a <see cref="T:System.Web.UI.NonVisualControlAttribute" /> instance that represents the application-defined default value of the attribute. This field is read-only.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A default instance of the <xref:System.Web.UI.NonVisualControlAttribute> class is equivalent to the <xref:System.Web.UI.NonVisualControlAttribute.Visual> field.
]]></format>
</remarks>
<altmember cref="F:System.Web.UI.NonVisualControlAttribute.Visual" />
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.NonVisualControlAttribute.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="nonVisualControlAttribute.Equals obj" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool Equals(System::Object ^ obj);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<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.Object" />
</Parameters>
<Docs>
<param name="obj">An <see cref="T:System.Object" /> to compare with this instance or a null reference (<see langword="Nothing" /> in Visual Basic).</param>
<summary>Returns a value that indicates whether this instance is equal to a specified object.</summary>
<returns>
<see langword="true" /> if <paramref name="obj" /> equals the type and value of this instance; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Attribute.Equals(System.Object)" />
</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" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.NonVisualControlAttribute.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="nonVisualControlAttribute.GetHashCode " />
<MemberSignature Language="C++ CLI" Value="public:
 override int GetHashCode();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the hash code for this instance.</summary>
<returns>A 32-bit signed integer hash code.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Attribute.GetHashCode" />
</Docs>
</Member>
<Member MemberName="IsDefaultAttribute">
<MemberSignature Language="C#" Value="public override bool IsDefaultAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool IsDefaultAttribute() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.NonVisualControlAttribute.IsDefaultAttribute" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function IsDefaultAttribute () As Boolean" />
<MemberSignature Language="F#" Value="override this.IsDefaultAttribute : unit -> bool" Usage="nonVisualControlAttribute.IsDefaultAttribute " />
<MemberSignature Language="C++ CLI" Value="public:
 override bool IsDefaultAttribute();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a value indicating whether the current instance is equivalent to a default instance of the <see cref="T:System.Web.UI.NonVisualControlAttribute" /> class.</summary>
<returns>
<see langword="true" /> if the current instance is equivalent to a <see cref="F:System.Web.UI.NonVisualControlAttribute.Default" /> instance of the class; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsNonVisual">
<MemberSignature Language="C#" Value="public bool IsNonVisual { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsNonVisual" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.NonVisualControlAttribute.IsNonVisual" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsNonVisual As Boolean" />
<MemberSignature Language="F#" Value="member this.IsNonVisual : bool" Usage="System.Web.UI.NonVisualControlAttribute.IsNonVisual" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IsNonVisual { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<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.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the control is non-visual.</summary>
<value>
<see langword="true" /> if the control has been marked as non-visual; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NonVisual">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.NonVisualControlAttribute NonVisual;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Web.UI.NonVisualControlAttribute NonVisual" />
<MemberSignature Language="DocId" Value="F:System.Web.UI.NonVisualControlAttribute.NonVisual" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly NonVisual As NonVisualControlAttribute " />
<MemberSignature Language="F#" Value=" staticval mutable NonVisual : System.Web.UI.NonVisualControlAttribute" Usage="System.Web.UI.NonVisualControlAttribute.NonVisual" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Web::UI::NonVisualControlAttribute ^ NonVisual;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.NonVisualControlAttribute</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a <see cref="T:System.Web.UI.NonVisualControlAttribute" /> instance that is applied to a Web control to be treated as a non-visual control during design time. This field is read-only.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.NonVisualControlAttribute.NonVisual> field is equivalent to creating an instance of the attribute using the <xref:System.Web.UI.NonVisualControlAttribute.%23ctor%28System.Boolean%29?displayProperty=nameWithType> constructor and passing `true` as the parameter value.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Visual">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.NonVisualControlAttribute Visual;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Web.UI.NonVisualControlAttribute Visual" />
<MemberSignature Language="DocId" Value="F:System.Web.UI.NonVisualControlAttribute.Visual" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Visual As NonVisualControlAttribute " />
<MemberSignature Language="F#" Value=" staticval mutable Visual : System.Web.UI.NonVisualControlAttribute" Usage="System.Web.UI.NonVisualControlAttribute.Visual" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Web::UI::NonVisualControlAttribute ^ Visual;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.NonVisualControlAttribute</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a <see cref="T:System.Web.UI.NonVisualControlAttribute" /> instance that is applied to a Web control to be treated as a visual control during design time.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.NonVisualControlAttribute.Visual> field is equivalent to creating an instance of the attribute using the default <xref:System.Web.UI.NonVisualControlAttribute.%23ctor?displayProperty=nameWithType> constructor, or creating an instance of the attribute using the <xref:System.Web.UI.NonVisualControlAttribute.%23ctor%28System.Boolean%29?displayProperty=nameWithType> constructor and passing `false` as the parameter value.
]]></format>
</remarks>
<altmember cref="F:System.Web.UI.NonVisualControlAttribute.Default" />
</Docs>
</Member>
</Members>
</Type>