/
MatchAttribute.xml
267 lines (235 loc) · 15.1 KB
/
MatchAttribute.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
<Type Name="MatchAttribute" FullName="System.Web.Services.Protocols.MatchAttribute">
<TypeSignature Language="C#" Value="public sealed class MatchAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit MatchAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:System.Web.Services.Protocols.MatchAttribute" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class MatchAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type MatchAttribute = class
 inherit Attribute" />
<TypeSignature Language="C++ CLI" Value="public ref class MatchAttribute sealed : Attribute" />
<AssemblyInfo>
<AssemblyName>System.Web.Services</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.All)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.All)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents the attributes of a match made using text pattern matching. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Text pattern matching allows an XML Web service to leverage existing HTML content by parsing it using regular expressions. an XML Web service specifies the content it wants to parse in a Service Description using match elements. These match elements specify several items: the regular expression for parsing the contents of an existing HTML page, whether the parsing must be case-insensitive, and how many instances of content that matches the regular expression should be returned. When a client builds a proxy class using the Wsdl.exe tool, methods of the proxy class include a <xref:System.Web.Services.Protocols.MatchAttribute> detailing the match elements found in the Service Description.
For more information on text pattern matching, see [How to: Create Web Services That Parse the Contents of a Web Page](https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/xxb0bsdh(v=vs.100)).
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet1":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet1":::
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public MatchAttribute (string pattern);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string pattern) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Services.Protocols.MatchAttribute.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (pattern As String)" />
<MemberSignature Language="F#" Value="new System.Web.Services.Protocols.MatchAttribute : string -> System.Web.Services.Protocols.MatchAttribute" Usage="new System.Web.Services.Protocols.MatchAttribute pattern" />
<MemberSignature Language="C++ CLI" Value="public:
 MatchAttribute(System::String ^ pattern);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="pattern" Type="System.String" />
</Parameters>
<Docs>
<param name="pattern">A string that represents the pattern to match.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.Services.Protocols.MatchAttribute" /> class with the specified pattern.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to create and initialize a new instance of the <xref:System.Web.Services.Protocols.MatchAttribute> class using the specified pattern.
The following table shows the initial property value for an instance of <xref:System.Web.Services.Protocols.MatchAttribute>.
|Property|Initial Value|
|--------------|-------------------|
|Pattern|The value of the `pattern` parameter.|
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet2":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet2":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Capture">
<MemberSignature Language="C#" Value="public int Capture { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Capture" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.MatchAttribute.Capture" />
<MemberSignature Language="VB.NET" Value="Public Property Capture As Integer" />
<MemberSignature Language="F#" Value="member this.Capture : int with get, set" Usage="System.Web.Services.Protocols.MatchAttribute.Capture" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Capture { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</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>
<Docs>
<summary>Gets or sets a value that represents the index of a match within a grouping.</summary>
<value>A value that represents the index of a match within a grouping.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet5":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet5":::
]]></format>
</remarks>
<altmember cref="P:System.Web.Services.Protocols.MatchAttribute.Group" />
</Docs>
</Member>
<Member MemberName="Group">
<MemberSignature Language="C#" Value="public int Group { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Group" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.MatchAttribute.Group" />
<MemberSignature Language="VB.NET" Value="Public Property Group As Integer" />
<MemberSignature Language="F#" Value="member this.Group : int with get, set" Usage="System.Web.Services.Protocols.MatchAttribute.Group" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Group { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</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>
<Docs>
<summary>Gets or sets a value that represents a grouping of related matches.</summary>
<value>A value that represents a grouping of related matches.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.Services.Protocols.MatchAttribute.Group%2A> property to specify a group that a match belongs to.
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet6":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet6":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet6":::
]]></format>
</remarks>
<altmember cref="P:System.Web.Services.Protocols.MatchAttribute.Capture" />
</Docs>
</Member>
<Member MemberName="IgnoreCase">
<MemberSignature Language="C#" Value="public bool IgnoreCase { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IgnoreCase" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.MatchAttribute.IgnoreCase" />
<MemberSignature Language="VB.NET" Value="Public Property IgnoreCase As Boolean" />
<MemberSignature Language="F#" Value="member this.IgnoreCase : bool with get, set" Usage="System.Web.Services.Protocols.MatchAttribute.IgnoreCase" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool IgnoreCase { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</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>
<Docs>
<summary>Gets or sets a value that indicates whether the pattern to match is case insensitive.</summary>
<value>
<see langword="true" /> if matching is case insensitive; otherwise, <see langword="false" />. The default value is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet3":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet3":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="MaxRepeats">
<MemberSignature Language="C#" Value="public int MaxRepeats { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaxRepeats" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.MatchAttribute.MaxRepeats" />
<MemberSignature Language="VB.NET" Value="Public Property MaxRepeats As Integer" />
<MemberSignature Language="F#" Value="member this.MaxRepeats : int with get, set" Usage="System.Web.Services.Protocols.MatchAttribute.MaxRepeats" />
<MemberSignature Language="C++ CLI" Value="public:
 property int MaxRepeats { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</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>
<Docs>
<summary>Gets or sets the maximum number of values to return from the match.</summary>
<value>The maximum number of values to return from the match. The default value is -1, which refers to returning all values.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
A value of 1 returns only the first match. A value of -1 returns all matches. Additionally, a value of -1 equates to an '*' in a regular expression.
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet7":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet7":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet7":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Pattern">
<MemberSignature Language="C#" Value="public string Pattern { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Pattern" />
<MemberSignature Language="DocId" Value="P:System.Web.Services.Protocols.MatchAttribute.Pattern" />
<MemberSignature Language="VB.NET" Value="Public Property Pattern As String" />
<MemberSignature Language="F#" Value="member this.Pattern : string with get, set" Usage="System.Web.Services.Protocols.MatchAttribute.Pattern" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Pattern { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web.Services</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a regular expression that represents the pattern to match.</summary>
<value>A regular expression that represents the pattern to match.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.Services.Protocols.MatchAttribute.Pattern%2A> property to specify a regular expression that represents the value to match.
## Examples
:::code language="cpp" source="~/snippets/cpp/VS_Snippets_Remoting/MatchAttribute/CPP/SvcClient_MatchAttribute.cpp" id="Snippet4":::
:::code language="csharp" source="~/snippets/csharp/System.Web.Services.Protocols/MatchAttribute/Overview/SvcClient_MatchAttribute.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Remoting/MatchAttribute/VB/SvcClient_MatchAttribute.vb" id="Snippet4":::
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>