-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ToolboxDataAttribute.xml
218 lines (206 loc) · 12.6 KB
/
ToolboxDataAttribute.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
<Type Name="ToolboxDataAttribute" FullName="System.Web.UI.ToolboxDataAttribute">
<TypeSignature Language="C#" Value="public sealed class ToolboxDataAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit ToolboxDataAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.ToolboxDataAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class ToolboxDataAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type ToolboxDataAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class ToolboxDataAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<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>Specifies the default tag generated for a custom control when it is dragged from a toolbox in a tool such as Microsoft Visual Studio.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
By default, the visual designer of a tool such as Visual Studio, creates an empty tag. This is a tag representing a control in its default state, when the control is dropped from the toolbox of a visual designer onto the design surface. To specify initial default values, a control can make use of this attribute. You can use this attribute to customize the initial HTML content that is placed in the designer when the control is dragged from the toolbox onto the form.
## Examples
```
[ ToolboxData("<{0}:MyLabel runat= server Text=
MyLabel><{0}:MyLabel>") ]public class MyLabel : Label {...}
```
In the following code example, the previous code sets several properties specific to `MyLabel`. All occurrences of `{0}` are replaced, by the designer, with the tag prefix associated with the `MyLabel` class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/SystemWebUI_ToolboxDataAttribute/CS/toolboxdataattribute.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/SystemWebUI_ToolboxDataAttribute/VB/toolboxdataattribute.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Attribute" />
<related type="Article" href="/dotnet/standard/attributes/">Extending Metadata Using Attributes</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ToolboxDataAttribute (string data);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string data) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.ToolboxDataAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (data As String)" />
<MemberSignature Language="F#" Value="new System.Web.UI.ToolboxDataAttribute : string -> System.Web.UI.ToolboxDataAttribute" Usage="new System.Web.UI.ToolboxDataAttribute data" />
<MemberSignature Language="C++ CLI" Value="public:
 ToolboxDataAttribute(System::String ^ data);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<param name="data">The string to be set as the <see cref="P:System.Web.UI.ToolboxDataAttribute.Data" />.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.ToolboxDataAttribute" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Data">
<MemberSignature Language="C#" Value="public string Data { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Data" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.ToolboxDataAttribute.Data" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Data As String" />
<MemberSignature Language="F#" Value="member this.Data : string" Usage="System.Web.UI.ToolboxDataAttribute.Data" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Data { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</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 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.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the string representing the initial values of the control's property, which is used in a visual designer for creating an instance of the control.</summary>
<value>A string representing the initial values for this attribute.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Default">
<MemberSignature Language="C#" Value="public static readonly System.Web.UI.ToolboxDataAttribute Default;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Web.UI.ToolboxDataAttribute Default" />
<MemberSignature Language="DocId" Value="F:System.Web.UI.ToolboxDataAttribute.Default" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Default As ToolboxDataAttribute " />
<MemberSignature Language="F#" Value=" staticval mutable Default : System.Web.UI.ToolboxDataAttribute" Usage="System.Web.UI.ToolboxDataAttribute.Default" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Web::UI::ToolboxDataAttribute ^ Default;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.ToolboxDataAttribute</ReturnType>
</ReturnValue>
<Docs>
<summary>Represents the default <see cref="T:System.Web.UI.ToolboxDataAttribute" /> value for a custom control.</summary>
<remarks>To be added.</remarks>
</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.ToolboxDataAttribute.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="toolboxDataAttribute.Equals obj" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool Equals(System::Object ^ obj);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</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>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The object to compare to.</param>
<summary>Tests whether the <see cref="T:System.Web.UI.ToolboxDataAttribute" /> object is equal to the given object.</summary>
<returns>
<see langword="true" />, if the <see cref="T:System.Web.UI.ToolboxDataAttribute" /> object is equal to the given object; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.ToolboxDataAttribute.Equals%2A> method first compares the objects for equality. If the comparison returns `false`, the <xref:System.Web.UI.ToolboxDataAttribute.Equals%2A> method then compares the data of the <xref:System.Web.UI.ToolboxDataAttribute> object to the data of the given object after first testing the given object to make sure that the given object is not `null` and is also typed as <xref:System.Web.UI.ToolboxDataAttribute> object.
]]></format>
</remarks>
</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.ToolboxDataAttribute.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="toolboxDataAttribute.GetHashCode " />
<MemberSignature Language="C++ CLI" Value="public:
 override int GetHashCode();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<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 of the custom control.</summary>
<returns>A 32-bit signed <see langword="integer" /> representing the hash code.</returns>
<remarks>To be added.</remarks>
</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.ToolboxDataAttribute.IsDefaultAttribute" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function IsDefaultAttribute () As Boolean" />
<MemberSignature Language="F#" Value="override this.IsDefaultAttribute : unit -> bool" Usage="toolboxDataAttribute.IsDefaultAttribute " />
<MemberSignature Language="C++ CLI" Value="public:
 override bool IsDefaultAttribute();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</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>
<Parameters />
<Docs>
<summary>Tests whether the <see cref="T:System.Web.UI.ToolboxDataAttribute" /> object contains the default value for the <see cref="P:System.Web.UI.ToolboxDataAttribute.Data" /> property.</summary>
<returns>
<see langword="true" />, if the <see cref="T:System.Web.UI.ToolboxDataAttribute" /> contains the default value for the <see cref="P:System.Web.UI.ToolboxDataAttribute.Data" /> property; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The default is an empty string ("").
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>