-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
UrlPropertyAttribute.xml
216 lines (196 loc) · 12.7 KB
/
UrlPropertyAttribute.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
<Type Name="UrlPropertyAttribute" FullName="System.Web.UI.UrlPropertyAttribute">
<TypeSignature Language="C#" Value="public sealed class UrlPropertyAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit UrlPropertyAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.UrlPropertyAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class UrlPropertyAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type UrlPropertyAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class UrlPropertyAttribute 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.Property)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Property)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Defines the attribute that controls use to identify string properties containing URL values. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.UrlPropertyAttribute> attribute is an attribute applied to a control property that represents a URL. In addition to marking a string property as representing a URL, the <xref:System.Web.UI.UrlPropertyAttribute> attribute defines the <xref:System.Web.UI.UrlPropertyAttribute.Filter%2A> property that identifies specific file types that can be used to filter against the property.
## Examples
The following code example demonstrates a class that implements a URL-specific property. In this code example, a <xref:System.Web.UI.UrlPropertyAttribute> attribute is applied to the `TargetUrl` property of the `CustomHyperLinkControl` class. The attribute sets a specific file filter for ASP.NET files.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.UrlPropertyAttribute/CS/CustomHyperLinkControl.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.UrlPropertyAttribute/VB/CustomHyperLinkControl.vb" id="Snippet2":::
]]></format>
</remarks>
</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.UrlPropertyAttribute" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UrlPropertyAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.UrlPropertyAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 UrlPropertyAttribute();" />
<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 default instance of the <see cref="T:System.Web.UI.UrlPropertyAttribute" /> class.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A default instance of the <xref:System.Web.UI.UrlPropertyAttribute> class is initialized with the <xref:System.Web.UI.UrlPropertyAttribute.Filter%2A> property set to the value "*.\*".
## Examples
The following code example demonstrates a class that implements a URL-specific property. In this code example, a default <xref:System.Web.UI.UrlPropertyAttribute> attribute is applied to the `TargetUrl` property of the `CustomHyperLinkControl` class. The attribute indicates support for all URL types and specifies a default file filter set to "*.\*".
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.UrlPropertyAttribute/CS/CustomHyperLinkControl.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.UrlPropertyAttribute/VB/CustomHyperLinkControl.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public UrlPropertyAttribute (string filter);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filter) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.UrlPropertyAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (filter As String)" />
<MemberSignature Language="F#" Value="new System.Web.UI.UrlPropertyAttribute : string -> System.Web.UI.UrlPropertyAttribute" Usage="new System.Web.UI.UrlPropertyAttribute filter" />
<MemberSignature Language="C++ CLI" Value="public:
 UrlPropertyAttribute(System::String ^ filter);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="filter" Type="System.String" />
</Parameters>
<Docs>
<param name="filter">A file filter associated with the URL-specific property.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.UrlPropertyAttribute" /> class, setting the <see cref="P:System.Web.UI.UrlPropertyAttribute.Filter" /> property to the specified string.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
An instance of a <xref:System.Web.UI.UrlPropertyAttribute> class created with this constructor is initialized with the <xref:System.Web.UI.UrlPropertyAttribute.Filter%2A> property set to `filter`.
## Examples
The following code example demonstrates a class that implements a URL-specific property. In this code example, a <xref:System.Web.UI.UrlPropertyAttribute> attribute is applied to the `TargetUrl` property of the `CustomHyperLinkControl` class. The attribute sets a specific file filter for ASP.NET files.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.UrlPropertyAttribute/CS/CustomHyperLinkControl.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.UrlPropertyAttribute/VB/CustomHyperLinkControl.vb" id="Snippet2":::
]]></format>
</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.UrlPropertyAttribute.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="urlPropertyAttribute.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="Filter">
<MemberSignature Language="C#" Value="public string Filter { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Filter" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.UrlPropertyAttribute.Filter" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Filter As String" />
<MemberSignature Language="F#" Value="member this.Filter : string" Usage="System.Web.UI.UrlPropertyAttribute.Filter" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Filter { System::String ^ 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.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a file filter associated with the URL-specific property.</summary>
<value>A file filter associated with the URL-specific property. The default is "*.\*".</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A designer provides a filter in file selectors based on the <xref:System.Web.UI.UrlPropertyAttribute> attribute. By default, it is initialized to "*.\*", which specifies all files with a file extension. You can set the filter for more specific file types; for example, the filter "\*.aspx" indicates that only ASP.NET files are represented by the URL-specific property.
]]></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.UrlPropertyAttribute.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="urlPropertyAttribute.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>
</Members>
</Type>