/
SystemWebCachingSectionGroup.xml
269 lines (228 loc) · 17.8 KB
/
SystemWebCachingSectionGroup.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
<Type Name="SystemWebCachingSectionGroup" FullName="System.Web.Configuration.SystemWebCachingSectionGroup">
<TypeSignature Language="C#" Value="public sealed class SystemWebCachingSectionGroup : System.Configuration.ConfigurationSectionGroup" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit SystemWebCachingSectionGroup extends System.Configuration.ConfigurationSectionGroup" />
<TypeSignature Language="DocId" Value="T:System.Web.Configuration.SystemWebCachingSectionGroup" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class SystemWebCachingSectionGroup
Inherits ConfigurationSectionGroup" />
<TypeSignature Language="F#" Value="type SystemWebCachingSectionGroup = class
 inherit ConfigurationSectionGroup" />
<TypeSignature Language="C++ CLI" Value="public ref class SystemWebCachingSectionGroup sealed : System::Configuration::ConfigurationSectionGroup" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Configuration.ConfigurationSectionGroup</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Configures the <see langword="caching" /> group within a configuration file. This class cannot be inherited.</summary>
<remarks>
<format type="text/markdown"><).
The following list describes the two types of caching ASP.NET provides.
- The first is called output caching, which allows you to store dynamic page and user control responses. On subsequent requests, the page or user control code is not executed; the cached output is used to satisfy the request. You can access output caching settings using the <xref:System.Web.Configuration.SystemWebCachingSectionGroup.OutputCache%2A> and <xref:System.Web.Configuration.SystemWebCachingSectionGroup.OutputCacheSettings%2A> properties.
- The second type of caching is traditional application data caching, which you can use to programmatically store arbitrary objects to server memory so your application can save the time and resources it takes to recreate them. You can access these cache settings using the <xref:System.Web.Configuration.SystemWebCachingSectionGroup.Cache%2A> property.
## Examples
The following code example shows how to obtain the <xref:System.Web.Configuration.SystemWebCachingSectionGroup> object from the configuration file associated with an existing Web application. You can use this object to access the sections contained in the `caching` group.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/CS/SystemWebCachingSectionGroup.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/VB/SystemWebCachingSectionGroup.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.CacheSection" />
<altmember cref="T:System.Web.Configuration.OutputCacheSection" />
<altmember cref="T:System.Web.Configuration.OutputCacheSettingsSection" />
<altmember cref="T:System.Web.Configuration.SqlCacheDependencySection" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/xsbfdd8c(v=vs.100)">ASP.NET Caching Features</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SystemWebCachingSectionGroup ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.Configuration.SystemWebCachingSectionGroup.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SystemWebCachingSectionGroup();" />
<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>Creates a new instance of <see cref="T:System.Web.Configuration.SystemWebCachingSectionGroup" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.SystemWebCachingSectionGroup.%23ctor%2A> constructor is not intended to be used directly from your code. It is called by the ASP.NET configuration system. You obtain an instance of the <xref:System.Web.Configuration.SystemWebCachingSectionGroup> class by using the <xref:System.Configuration.Configuration.GetSection%2A> method.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Cache">
<MemberSignature Language="C#" Value="public System.Web.Configuration.CacheSection Cache { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Configuration.CacheSection Cache" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.SystemWebCachingSectionGroup.Cache" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Cache As CacheSection" />
<MemberSignature Language="F#" Value="member this.Cache : System.Web.Configuration.CacheSection" Usage="System.Web.Configuration.SystemWebCachingSectionGroup.Cache" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Configuration::CacheSection ^ Cache { System::Web::Configuration::CacheSection ^ get(); };" />
<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("cache")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("cache")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Configuration.CacheSection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see langword="cache" /> section contained within the configuration.</summary>
<value>The <see cref="T:System.Web.Configuration.CacheSection" /> object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.CacheSection> object refers to the `cache` section of the configuration file. You can use the <xref:System.Web.Configuration.CacheSection> class to modify the `cache` section programmatically.
## Examples
The following code example shows how to obtain the <xref:System.Web.Configuration.CacheSection> object from the configuration file of an existing Web application.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/CS/SystemWebCachingSectionGroup.cs" id="Snippet2":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/VB/SystemWebCachingSectionGroup.vb" id="Snippet2":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.CacheSection" />
</Docs>
</Member>
<Member MemberName="OutputCache">
<MemberSignature Language="C#" Value="public System.Web.Configuration.OutputCacheSection OutputCache { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Configuration.OutputCacheSection OutputCache" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.SystemWebCachingSectionGroup.OutputCache" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OutputCache As OutputCacheSection" />
<MemberSignature Language="F#" Value="member this.OutputCache : System.Web.Configuration.OutputCacheSection" Usage="System.Web.Configuration.SystemWebCachingSectionGroup.OutputCache" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Configuration::OutputCacheSection ^ OutputCache { System::Web::Configuration::OutputCacheSection ^ get(); };" />
<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("outputCache")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("outputCache")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Configuration.OutputCacheSection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see langword="outputCache" /> section contained within the configuration.</summary>
<value>The <see cref="T:System.Web.Configuration.OutputCacheSection" /> object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.OutputCacheSection> object refers to the `outputCache` section of the configuration file.
## Examples
The following code example shows how to obtain the <xref:System.Web.Configuration.OutputCacheSection> object from the configuration file of an existing Web application.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/CS/SystemWebCachingSectionGroup.cs" id="Snippet3":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/VB/SystemWebCachingSectionGroup.vb" id="Snippet3":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.OutputCacheSection" />
</Docs>
</Member>
<Member MemberName="OutputCacheSettings">
<MemberSignature Language="C#" Value="public System.Web.Configuration.OutputCacheSettingsSection OutputCacheSettings { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Configuration.OutputCacheSettingsSection OutputCacheSettings" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.SystemWebCachingSectionGroup.OutputCacheSettings" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property OutputCacheSettings As OutputCacheSettingsSection" />
<MemberSignature Language="F#" Value="member this.OutputCacheSettings : System.Web.Configuration.OutputCacheSettingsSection" Usage="System.Web.Configuration.SystemWebCachingSectionGroup.OutputCacheSettings" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Configuration::OutputCacheSettingsSection ^ OutputCacheSettings { System::Web::Configuration::OutputCacheSettingsSection ^ get(); };" />
<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("outputCacheSettings")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("outputCacheSettings")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Configuration.OutputCacheSettingsSection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see langword="outputCacheSettings" /> section contained within the configuration.</summary>
<value>The <see cref="T:System.Web.Configuration.OutputCacheSettingsSection" /> object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.OutputCacheSettingsSection> object refers to the `outputCacheSettings` section of the configuration file.
The output cache settings enable or disable disk-based persistent output cache, define the location for persisting the data to be cached, and specify the maximum size of the cache per application.
ASP.NET allows you to cache multiple versions of a page response declaratively by using attributes of the `@ OutputCache` directive and programmatically using the properties and methods of the <xref:System.Web.HttpCachePolicy> class.
You can achieve the same results by configuring the application using the <xref:System.Web.Configuration.OutputCacheSettingsSection> or the <xref:System.Web.Configuration.OutputCacheProfile> type.
## Examples
The following code example shows how to obtain the <xref:System.Web.Configuration.OutputCacheSettingsSection> object from the configuration file of an existing Web application.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/CS/SystemWebCachingSectionGroup.cs" id="Snippet4":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/VB/SystemWebCachingSectionGroup.vb" id="Snippet4":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.OutputCacheSettingsSection" />
</Docs>
</Member>
<Member MemberName="SqlCacheDependency">
<MemberSignature Language="C#" Value="public System.Web.Configuration.SqlCacheDependencySection SqlCacheDependency { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.Configuration.SqlCacheDependencySection SqlCacheDependency" />
<MemberSignature Language="DocId" Value="P:System.Web.Configuration.SystemWebCachingSectionGroup.SqlCacheDependency" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SqlCacheDependency As SqlCacheDependencySection" />
<MemberSignature Language="F#" Value="member this.SqlCacheDependency : System.Web.Configuration.SqlCacheDependencySection" Usage="System.Web.Configuration.SystemWebCachingSectionGroup.SqlCacheDependency" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::Configuration::SqlCacheDependencySection ^ SqlCacheDependency { System::Web::Configuration::SqlCacheDependencySection ^ get(); };" />
<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("sqlCacheDependency")]</AttributeName>
<AttributeName Language="F#">[<System.Configuration.ConfigurationProperty("sqlCacheDependency")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.Configuration.SqlCacheDependencySection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see langword="sqlCacheDependency" /> section contained within the configuration.</summary>
<value>The <see cref="T:System.Web.Configuration.SqlCacheDependencySection" /> object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.Configuration.SqlCacheDependencySection> object refers to the `sqlCacheDependency` section of the configuration file.
The SQL cache dependency establishes a relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table. An instance of the <xref:System.Web.Caching.SqlCacheDependency> class must monitor the table so that when the table changes the item will be automatically removed from the cache.
## Examples
The following code example shows how to obtain the <xref:System.Web.Configuration.SqlCacheDependencySection> object from the configuration file of an existing Web application.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/CS/SystemWebCachingSectionGroup.cs" id="Snippet5":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.SystemWebCachingSectionGroup/VB/SystemWebCachingSectionGroup.vb" id="Snippet5":::
]]></format>
</remarks>
<altmember cref="T:System.Web.Configuration.SqlCacheDependencySection" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/6hbbsfk6(v=vs.100)">Caching Application Data</related>
</Docs>
</Member>
</Members>
</Type>