-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathOutputCacheProfile.xml
More file actions
628 lines (544 loc) · 39.6 KB
/
Copy pathOutputCacheProfile.xml
File metadata and controls
628 lines (544 loc) · 39.6 KB
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
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
<Type Name="OutputCacheProfile" FullName="System.Web.Configuration.OutputCacheProfile">
<TypeSignature Language="C#" Value="public sealed class OutputCacheProfile : System.Configuration.ConfigurationElement" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed OutputCacheProfile extends System.Configuration.ConfigurationElement" />
<TypeSignature Language="DocId" Value="T:System.Web.Configuration.OutputCacheProfile" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class OutputCacheProfile
Inherits ConfigurationElement" />
<TypeSignature Language="F#" Value="type OutputCacheProfile = class
 inherit ConfigurationElement" />
<TypeSignature Language="C++ CLI" Value="public ref class OutputCacheProfile sealed : System::Configuration::ConfigurationElement" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationElement</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Configures the output cache profile that can be used by the application pages. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
> [!IMPORTANT]
> Output caching is a performance optimization feature. The `VaryBy` settings are designed to cache alternate representations of a resource based on request characteristics; they are not designed to isolate audiences or classes of content. Do not rely on cache variation to separate personalized, tenant-specific, authorization-dependent, or otherwise sensitive responses. Enforce any required isolation between request contexts independently of the cache configuration.
The <xref:System.Web.Configuration.OutputCacheProfile> class provides a way to programmatically access and modify the `add` element of the `outputCacheProfiles` section in the `caching` section of a configuration file.
The <xref:System.Web.Configuration.OutputCacheProfile> object centralizes frequently used configuration settings such as dependencies, cache location, and cache expiration time, eliminating the need to specify them on every page.
The <xref:System.Web.Configuration.OutputCacheProfile> can be applied to a page using the `CacheProfile` attribute of the `@ OutputCache` directive.
> [!NOTE]
> The `@ OutputCache` directive can override all the settings contained by an <xref:System.Web.Configuration.OutputCacheProfile> object except for the <xref:System.Web.Configuration.OutputCacheProfile.Enabled%2A> attribute. This is to enable or disable the <xref:System.Web.Configuration.OutputCacheProfile> without having to modify the directives in all the pages that might have overridden it.
The <xref:System.Web.Caching.CacheDependency> class monitors the dependencies so that when any cached item changes, the cached item will be automatically removed.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheSettingsSection.OutputCacheProfiles%2A> collection to access its <xref:System.Web.Configuration.OutputCacheProfile> objects.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.OutputCacheProfileCollection" />
<altmember cref="T:System.Web.Caching.CacheDependency" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/6hbbsfk6(v=vs.100)">Caching Application Data</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/zd1ysf1y(v=vs.100)">How to: Set a Page's Cacheability Declaratively</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/z852zf6b(v=vs.100)">How to: Set a Page's Cacheability Programmatically</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public OutputCacheProfile (string name);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.OutputCacheProfile.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String)" />
<MemberSignature Language="F#" Value="new System.Web.Configuration.OutputCacheProfile : string -> System.Web.Configuration.OutputCacheProfile" Usage="new System.Web.Configuration.OutputCacheProfile name" />
<MemberSignature Language="C++ CLI" Value="public:
 OutputCacheProfile(System::String ^ name);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name value to use.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.Configuration.OutputCacheProfile" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Duration">
<MemberSignature Language="C#" Value="public int Duration { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Duration" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.Duration" />
<MemberSignature Language="VB.NET" Value="Public Property Duration As Integer" />
<MemberSignature Language="F#" Value="member this.Duration : int with get, set" Usage="System.Web.Configuration.OutputCacheProfile.Duration" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Duration { int get(); void set(int value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("duration", DefaultValue=-1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("duration", DefaultValue=-1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the time duration during which the page or control is cached.</summary>
<value>The time duration in seconds.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.OutputCacheProfile.Duration%2A> represents the time in seconds that the page or user control is cached. Setting this property establishes an expiration policy for HTTP responses from the page or control to which it applies and will automatically cause the caching of their output.
> [!NOTE]
> The <xref:System.Web.Configuration.OutputCacheProfile.Duration%2A> must be defined in either the profile or the `@ OutputCache` directive of a page using the profile.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.Duration%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet10":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet10":::
]]></format>
</remarks>
<altmember cref="T:System.Web.HttpCachePolicy" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)">Caching ASP.NET Pages</related>
</Docs>
</Member>
<Member MemberName="Enabled">
<MemberSignature Language="C#" Value="public bool Enabled { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Enabled" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.Enabled" />
<MemberSignature Language="VB.NET" Value="Public Property Enabled As Boolean" />
<MemberSignature Language="F#" Value="member this.Enabled : bool with get, set" Usage="System.Web.Configuration.OutputCacheProfile.Enabled" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Enabled { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("enabled", DefaultValue=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("enabled", DefaultValue=true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether caching is enabled.</summary>
<value>
<see langword="true" /> if caching is enabled; otherwise, <see langword="false" />. The default value is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.OutputCacheProfile.Enabled%2A> property allows enabling or disabling the caching mechanism in one place only. It affects all the pages or controls that use this <xref:System.Web.Configuration.OutputCacheProfile>.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.Enabled%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet12":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet12":::
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)">Caching ASP.NET Pages</related>
</Docs>
</Member>
<Member MemberName="Location">
<MemberSignature Language="C#" Value="public System.Web.UI.OutputCacheLocation Location { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.OutputCacheLocation Location" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.Location" />
<MemberSignature Language="VB.NET" Value="Public Property Location As OutputCacheLocation" />
<MemberSignature Language="F#" Value="member this.Location : System.Web.UI.OutputCacheLocation with get, set" Usage="System.Web.Configuration.OutputCacheProfile.Location" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::UI::OutputCacheLocation Location { System::Web::UI::OutputCacheLocation get(); void set(System::Web::UI::OutputCacheLocation value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("location")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("location")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.OutputCacheLocation</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the output cache location.</summary>
<value>One of the <see cref="T:System.Web.UI.OutputCacheLocation" /> enumeration values. The default is <see langword="Any" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
If <xref:System.Web.Configuration.OutputCacheProfile.Location%2A> is set to `Any`, the output cache can be located on the browser client, where the request originated; on a proxy server, or any other server, participating in the request; or on the server where the request was processed.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.Location%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet5":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.OutputCacheLocation" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)">Caching ASP.NET Pages</related>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.Name" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.TypeConverter(typeof(System.Configuration.WhiteSpaceTrimStringConverter))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.TypeConverter(typeof(System.Configuration.WhiteSpaceTrimStringConverter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true, IsRequired=true)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("name", DefaultValue="", IsKey=true, IsRequired=true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Configuration.StringValidator(MinLength=1)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.StringValidator(MinLength=1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.Web.Configuration.OutputCacheProfile" /> name.</summary>
<value>The <see cref="T:System.Web.Configuration.OutputCacheProfile" /> name.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You use the <xref:System.Web.Configuration.OutputCacheProfile.Name%2A> to assign a value to the `CacheProfile` attribute of the `@ OutputCache` directive if you want to apply the <xref:System.Web.Configuration.OutputCacheProfile> values to a page or control.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.Name%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet11":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet11":::
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="NoStore">
<MemberSignature Language="C#" Value="public bool NoStore { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool NoStore" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.NoStore" />
<MemberSignature Language="VB.NET" Value="Public Property NoStore As Boolean" />
<MemberSignature Language="F#" Value="member this.NoStore : bool with get, set" Usage="System.Web.Configuration.OutputCacheProfile.NoStore" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool NoStore { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("noStore", DefaultValue=false)]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("noStore", DefaultValue=false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value indicating whether secondary storage is enabled.</summary>
<value>
<see langword="true" /> if secondary storage is enabled; otherwise, <see langword="false" />. The default value is <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The page that has the <xref:System.Web.Configuration.OutputCacheProfile.NoStore%2A?displayProperty=nameWithType> property set to `true` issues a response specifying in its header to prevent secondary storage of sensitive information.
Setting this attribute to `true` is equivalent to invoking the <xref:System.Web.HttpCachePolicy.SetNoStore%2A?displayProperty=nameWithType> method during a Web request.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.NoStore%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet4":::
]]></format>
</remarks>
<altmember cref="T:System.Web.HttpCachePolicy" />
</Docs>
</Member>
<Member MemberName="Properties">
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Configuration.ConfigurationPropertyCollection Properties" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.Properties" />
<MemberSignature Language="VB.NET" Value="Protected Overrides ReadOnly Property Properties As ConfigurationPropertyCollection" />
<MemberSignature Language="F#" Value="member this.Properties : System.Configuration.ConfigurationPropertyCollection" Usage="System.Web.Configuration.OutputCacheProfile.Properties" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual property System::Configuration::ConfigurationPropertyCollection ^ Properties { System::Configuration::ConfigurationPropertyCollection ^ 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.Configuration.ConfigurationPropertyCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SqlDependency">
<MemberSignature Language="C#" Value="public string SqlDependency { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SqlDependency" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.SqlDependency" />
<MemberSignature Language="VB.NET" Value="Public Property SqlDependency As String" />
<MemberSignature Language="F#" Value="member this.SqlDependency : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.SqlDependency" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ SqlDependency { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("sqlDependency")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("sqlDependency")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="P:System.Web.Configuration.OutputCacheProfile.SqlDependency" /> property.</summary>
<value>The <see cref="P:System.Web.Configuration.OutputCacheProfile.SqlDependency" /> value.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.OutputCacheProfile.SqlDependency%2A> defines a relationship between a Web application and an instance of SQL Server, allowing the detection of changes in the data at the server. The <xref:System.Web.Configuration.OutputCacheProfile.SqlDependency%2A> ensures that output cached pages are removed from the cache whenever the SQL table on which they depend changes.
> [!NOTE]
> The <xref:System.Web.Caching.SqlCacheDependency> class monitors the table so that when the table changes, the item will be automatically removed from the Cache. This class cannot be inherited.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.SqlDependency%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet7":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet7":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Caching.SqlCacheDependency" />
</Docs>
</Member>
<Member MemberName="VaryByContentEncoding">
<MemberSignature Language="C#" Value="public string VaryByContentEncoding { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string VaryByContentEncoding" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.VaryByContentEncoding" />
<MemberSignature Language="VB.NET" Value="Public Property VaryByContentEncoding As String" />
<MemberSignature Language="F#" Value="member this.VaryByContentEncoding : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.VaryByContentEncoding" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ VaryByContentEncoding { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("varyByContentEncoding")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("varyByContentEncoding")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the semicolon-delimited set of content encodings to be cached.</summary>
<value>The list of content encodings.</value>
<remarks>
<format type="text/markdown"><.
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.OutputCacheParameters.VaryByContentEncoding" />
</Docs>
</Member>
<Member MemberName="VaryByControl">
<MemberSignature Language="C#" Value="public string VaryByControl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string VaryByControl" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.VaryByControl" />
<MemberSignature Language="VB.NET" Value="Public Property VaryByControl As String" />
<MemberSignature Language="F#" Value="member this.VaryByControl : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.VaryByControl" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ VaryByControl { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("varyByControl")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("varyByControl")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByControl" /> property.</summary>
<value>The <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByControl" /> value.</value>
<remarks>
<format type="text/markdown"><.
> [!NOTE]
> The <xref:System.Web.Configuration.OutputCacheProfile.VaryByControl%2A> settings are the same ones used by the `VaryByControl` attribute of the `@ OutputCache` directive.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.VaryByControl%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet3":::
]]></format>
</remarks>
<related type="Article" href="https://msdn.microsoft.com/library/7f7d839a-c060-4d2a-9c4e-7fd1080ec0ad">Caching Multiple Versions of User Control Output</related>
<related type="Article" href="https://msdn.microsoft.com/library/1bcaf2d0-0803-49be-a831-c0714a60e81c">How to: Cache Multiple Versions of a User Control, Based on Parameters</related>
</Docs>
</Member>
<Member MemberName="VaryByCustom">
<MemberSignature Language="C#" Value="public string VaryByCustom { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string VaryByCustom" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.VaryByCustom" />
<MemberSignature Language="VB.NET" Value="Public Property VaryByCustom As String" />
<MemberSignature Language="F#" Value="member this.VaryByCustom : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.VaryByCustom" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ VaryByCustom { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("varyByCustom")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("varyByCustom")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByCustom" /> property.</summary>
<value>The <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByCustom" /> value.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.OutputCacheProfile.VaryByCustom%2A> can be any text that represents custom output-caching requirements. If a custom string is entered, you must override the <xref:System.Web.HttpApplication.GetVaryByCustomString%2A> method in the application's Global.asax file.
> [!NOTE]
> The <xref:System.Web.Configuration.OutputCacheProfile.VaryByCustom%2A> settings are the same ones used by the `VaryByCustom` attribute of the `@ OutputCache` directive.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.VaryByCustom%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet9":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet9":::
]]></format>
</remarks>
<altmember cref="M:System.Web.HttpApplication.GetVaryByCustomString(System.Web.HttpContext,System.String)" />
<related type="Article" href="https://msdn.microsoft.com/library/7f7d839a-c060-4d2a-9c4e-7fd1080ec0ad">Caching Multiple Versions of User Control Output</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)">Caching ASP.NET Pages</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/5ecf4420(v=vs.100)">How to: Cache Versions of a Page, Based on Custom Strings</related>
</Docs>
</Member>
<Member MemberName="VaryByHeader">
<MemberSignature Language="C#" Value="public string VaryByHeader { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string VaryByHeader" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.VaryByHeader" />
<MemberSignature Language="VB.NET" Value="Public Property VaryByHeader As String" />
<MemberSignature Language="F#" Value="member this.VaryByHeader : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.VaryByHeader" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ VaryByHeader { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("varyByHeader")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("varyByHeader")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByHeader" /> property.</summary>
<value>The <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByHeader" /> value.</value>
<remarks>
<format type="text/markdown"><).
> [!NOTE]
> The <xref:System.Web.Configuration.OutputCacheProfile.VaryByHeader%2A> settings are the same ones used by the `VaryByHeader` attribute of the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)). Varying by all headers by setting the value of "\*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.VaryByHeader%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet2":::
]]></format>
</remarks>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)">Caching ASP.NET Pages</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/xadzbzd6(v=vs.100)">Caching Multiple Versions of a Page</related>
</Docs>
</Member>
<Member MemberName="VaryByParam">
<MemberSignature Language="C#" Value="public string VaryByParam { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string VaryByParam" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.OutputCacheProfile.VaryByParam" />
<MemberSignature Language="VB.NET" Value="Public Property VaryByParam As String" />
<MemberSignature Language="F#" Value="member this.VaryByParam : string with get, set" Usage="System.Web.Configuration.OutputCacheProfile.VaryByParam" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ VaryByParam { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Configuration.ConfigurationProperty("varyByParam")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("varyByParam")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByParam" /> property.</summary>
<value>The <see cref="P:System.Web.Configuration.OutputCacheProfile.VaryByParam" /> value.</value>
<remarks>
<format type="text/markdown"><.
The <xref:System.Web.Configuration.OutputCacheProfile.VaryByParam%2A> setting must be defined in either the profile or the `@ OutputCache` directive of the page using the profile.
> [!NOTE]
> The <xref:System.Web.Configuration.OutputCacheProfile.VaryByParam%2A?displayProperty=nameWithType> settings are the same ones used by the `VaryByParam` attribute of the [@ OutputCache](https://learn.microsoft.com/previous-versions/dotnet/netframework-4.0/hdxfb6cy(v=vs.100)). Varying by all parameters by setting the value of "\*" is not recommended. It can result in cache overflow or a denial of service attack on the Web server.
## Examples
The following code example shows how to use the <xref:System.Web.Configuration.OutputCacheProfile.VaryByParam%2A> property.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/CS/OutputCacheProfile.cs" id="Snippet8":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.OutputCacheProfile/VB/OutputCacheProfile.vb" id="Snippet8":::
]]></format>
</remarks>
<altmember cref="T:System.Web.HttpCacheVaryByParams" />
<altmember cref="P:System.Web.HttpCachePolicy.VaryByParams" />
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/06bh14hk(v=vs.100)">Caching ASP.NET Pages</related>
<related type="Article" href="https://learn.microsoft.com/previous-versions/aspnet/xadzbzd6(v=vs.100)">Caching Multiple Versions of a Page</related>
<related type="Article" href="https://msdn.microsoft.com/library/1bcaf2d0-0803-49be-a831-c0714a60e81c">How to: Cache Multiple Versions of a User Control, Based on Parameters</related>
</Docs>
</Member>
</Members>
</Type>