-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
TimeSpanValidator.xml
305 lines (277 loc) · 19.2 KB
/
TimeSpanValidator.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
<Type Name="TimeSpanValidator" FullName="System.Configuration.TimeSpanValidator">
<TypeSignature Language="C#" Value="public class TimeSpanValidator : System.Configuration.ConfigurationValidatorBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TimeSpanValidator extends System.Configuration.ConfigurationValidatorBase" />
<TypeSignature Language="DocId" Value="T:System.Configuration.TimeSpanValidator" />
<TypeSignature Language="VB.NET" Value="Public Class TimeSpanValidator
Inherits ConfigurationValidatorBase" />
<TypeSignature Language="F#" Value="type TimeSpanValidator = class
 inherit ConfigurationValidatorBase" />
<TypeSignature Language="C++ CLI" Value="public ref class TimeSpanValidator : System::Configuration::ConfigurationValidatorBase" />
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.1.0</AssemblyVersion>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.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>
<TypeForwardingChain>
<TypeForwarding From="System.Configuration.ConfigurationManager" FromVersion="9.0.0.0" To="System.Configuration" ToVersion="4.0.0.0" FrameworkAlternate="netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1" />
</TypeForwardingChain>
<Base>
<BaseTypeName>System.Configuration.ConfigurationValidatorBase</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides validation of a <see cref="T:System.TimeSpan" /> object.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Configuration.TimeSpanValidator> class is used to ensure that a <xref:System.TimeSpan> object meets specific criteria. The <xref:System.Configuration.TimeSpanValidator.%23ctor%2A> constructor with two parameters ensures that both a minimum and a maximum <xref:System.TimeSpan> value are adhered to. The <xref:System.Configuration.TimeSpanValidator.%23ctor%2A> constructor with three parameters checks both the minimum and maximum <xref:System.TimeSpan> values, as well as whether the validation range is exclusive. The <xref:System.Configuration.TimeSpanValidator.%23ctor%2A> constructor with four parameters checks the previous three parameters and also checks whether the <xref:System.TimeSpan> value is equal to a specific number of seconds.
The <xref:System.Configuration.TimeSpanValidator.CanValidate%2A> method determines whether the object type being validated matches the expected type. The object being validated is passed as a parameter of the <xref:System.Configuration.TimeSpanValidator.Validate%2A> method.
## Examples
The following code example demonstrates how to use the <xref:System.Configuration.TimeSpanValidator> type.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/CS/TimeSpanValidator.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/VB/TimeSpanValidator.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ConfigurationValidatorBase" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Configuration.TimeSpanValidator" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TimeSpanValidator (TimeSpan minValue, TimeSpan maxValue);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan minValue, valuetype System.TimeSpan maxValue) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TimeSpanValidator.#ctor(System.TimeSpan,System.TimeSpan)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (minValue As TimeSpan, maxValue As TimeSpan)" />
<MemberSignature Language="F#" Value="new System.Configuration.TimeSpanValidator : TimeSpan * TimeSpan -> System.Configuration.TimeSpanValidator" Usage="new System.Configuration.TimeSpanValidator (minValue, maxValue)" />
<MemberSignature Language="C++ CLI" Value="public:
 TimeSpanValidator(TimeSpan minValue, TimeSpan maxValue);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.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>
<Parameters>
<Parameter Name="minValue" Type="System.TimeSpan" />
<Parameter Name="maxValue" Type="System.TimeSpan" />
</Parameters>
<Docs>
<param name="minValue">A <see cref="T:System.TimeSpan" /> object that specifies the minimum time allowed to pass validation.</param>
<param name="maxValue">A <see cref="T:System.TimeSpan" /> object that specifies the maximum time allowed to pass validation.</param>
<summary>Initializes a new instance of the <see cref="T:System.Configuration.TimeSpanValidator" /> class, based on supplied parameters.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the <xref:System.Configuration.TimeSpanValidator.%23ctor%2A> constructor with two parameters is used, the <xref:System.Configuration.TimeSpanValidator> object validates that a <xref:System.TimeSpan> value adheres to a specific range.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TimeSpanValidator (TimeSpan minValue, TimeSpan maxValue, bool rangeIsExclusive);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan minValue, valuetype System.TimeSpan maxValue, bool rangeIsExclusive) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TimeSpanValidator.#ctor(System.TimeSpan,System.TimeSpan,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (minValue As TimeSpan, maxValue As TimeSpan, rangeIsExclusive As Boolean)" />
<MemberSignature Language="F#" Value="new System.Configuration.TimeSpanValidator : TimeSpan * TimeSpan * bool -> System.Configuration.TimeSpanValidator" Usage="new System.Configuration.TimeSpanValidator (minValue, maxValue, rangeIsExclusive)" />
<MemberSignature Language="C++ CLI" Value="public:
 TimeSpanValidator(TimeSpan minValue, TimeSpan maxValue, bool rangeIsExclusive);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.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>
<Parameters>
<Parameter Name="minValue" Type="System.TimeSpan" />
<Parameter Name="maxValue" Type="System.TimeSpan" />
<Parameter Name="rangeIsExclusive" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="minValue">A <see cref="T:System.TimeSpan" /> object that specifies the minimum time allowed to pass validation.</param>
<param name="maxValue">A <see cref="T:System.TimeSpan" /> object that specifies the maximum time allowed to pass validation.</param>
<param name="rangeIsExclusive">A <see cref="T:System.Boolean" /> value that specifies whether the validation range is exclusive.</param>
<summary>Initializes a new instance of the <see cref="T:System.Configuration.TimeSpanValidator" /> class, based on supplied parameters.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Configuration.TimeSpanValidator.%23ctor%2A> constructor checks both the minimum and maximum <xref:System.TimeSpan> values, as well as whether the validation range is exclusive. When the `rangeIsExclusive` parameter is set to `true`, the <xref:System.TimeSpan> value must not be between the `minValue` and `maxValue` values.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TimeSpanValidator (TimeSpan minValue, TimeSpan maxValue, bool rangeIsExclusive, long resolutionInSeconds);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.TimeSpan minValue, valuetype System.TimeSpan maxValue, bool rangeIsExclusive, int64 resolutionInSeconds) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TimeSpanValidator.#ctor(System.TimeSpan,System.TimeSpan,System.Boolean,System.Int64)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (minValue As TimeSpan, maxValue As TimeSpan, rangeIsExclusive As Boolean, resolutionInSeconds As Long)" />
<MemberSignature Language="F#" Value="new System.Configuration.TimeSpanValidator : TimeSpan * TimeSpan * bool * int64 -> System.Configuration.TimeSpanValidator" Usage="new System.Configuration.TimeSpanValidator (minValue, maxValue, rangeIsExclusive, resolutionInSeconds)" />
<MemberSignature Language="C++ CLI" Value="public:
 TimeSpanValidator(TimeSpan minValue, TimeSpan maxValue, bool rangeIsExclusive, long resolutionInSeconds);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.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>
<Parameters>
<Parameter Name="minValue" Type="System.TimeSpan" />
<Parameter Name="maxValue" Type="System.TimeSpan" />
<Parameter Name="rangeIsExclusive" Type="System.Boolean" />
<Parameter Name="resolutionInSeconds" Type="System.Int64" />
</Parameters>
<Docs>
<param name="minValue">A <see cref="T:System.TimeSpan" /> object that specifies the minimum time allowed to pass validation.</param>
<param name="maxValue">A <see cref="T:System.TimeSpan" /> object that specifies the maximum time allowed to pass validation.</param>
<param name="rangeIsExclusive">A <see cref="T:System.Boolean" /> value that specifies whether the validation range is exclusive.</param>
<param name="resolutionInSeconds">An <see cref="T:System.Int64" /> value that specifies a number of seconds.</param>
<summary>Initializes a new instance of the <see cref="T:System.Configuration.TimeSpanValidator" /> class, based on supplied parameters.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When the `resolutionInSeconds` parameter is specified, the <xref:System.TimeSpan> object being validated must be equal to this value in order to pass validation.
## Examples
The following code example demonstrates how to use the <xref:System.Configuration.TimeSpanValidator.%23ctor%2A> constructor. This code example is part of a larger example provided for the <xref:System.Configuration.TimeSpanValidator> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/CS/TimeSpanValidator.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/VB/TimeSpanValidator.vb" id="Snippet2":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">
<paramref name="resolutionInSeconds" /> is less than <see langword="0" />.
-or-
<paramref name="minValue" /> is greater than <paramref name="maxValue" />.</exception>
</Docs>
</Member>
<Member MemberName="CanValidate">
<MemberSignature Language="C#" Value="public override bool CanValidate (Type type);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanValidate(class System.Type type) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TimeSpanValidator.CanValidate(System.Type)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanValidate (type As Type) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanValidate : Type -> bool" Usage="timeSpanValidator.CanValidate type" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanValidate(Type ^ type);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.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.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<param name="type">The type of the object.</param>
<summary>Determines whether the type of the object can be validated.</summary>
<returns>
<see langword="true" /> if the <paramref name="type" /> parameter matches a <see cref="T:System.TimeSpan" /> value; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following code example demonstrates how to use the <xref:System.Configuration.TimeSpanValidator.CanValidate%2A> method. This code example is part of a larger example provided for the <xref:System.Configuration.TimeSpanValidator> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/CS/TimeSpanValidator.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/VB/TimeSpanValidator.vb" id="Snippet3":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public override void Validate (object value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate(object value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Configuration.TimeSpanValidator.Validate(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate (value As Object)" />
<MemberSignature Language="F#" Value="override this.Validate : obj -> unit" Usage="timeSpanValidator.Validate value" />
<MemberSignature Language="C++ CLI" Value="public:
 override void Validate(System::Object ^ value);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Configuration</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Configuration.ConfigurationManager</AssemblyName>
<AssemblyVersion>4.0.2.0</AssemblyVersion>
<AssemblyVersion>4.0.3.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.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Object" />
</Parameters>
<Docs>
<param name="value">The value of an object.</param>
<summary>Determines whether the value of an object is valid.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Configuration.TimeSpanValidator> object contains the rules necessary to validate a <xref:System.TimeSpan> object. The rules are established when an instance of the <xref:System.Configuration.TimeSpanValidator> class is created. The object to validate is passed as a parameter of the <xref:System.Configuration.TimeSpanValidator.Validate%2A> method.
## Examples
The following code example demonstrates how to use the <xref:System.Configuration.TimeSpanValidator.Validate%2A> method. This code example is part of a larger example provided for the <xref:System.Configuration.TimeSpanValidator> class.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/CS/TimeSpanValidator.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Configuration.TimeSpanValidator/VB/TimeSpanValidator.vb" id="Snippet4":::
]]></format>
</remarks>
<altmember cref="T:System.Configuration.ConfigurationValidatorBase" />
</Docs>
</Member>
</Members>
</Type>