183 lines
10 KiB
XML
183 lines
10 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
||
<Type Name="SqlCacheDependencySection" FullName="System.Web.Configuration.SqlCacheDependencySection">
|
||
<TypeSignature Language="C#" Value="public sealed class SqlCacheDependencySection : System.Configuration.ConfigurationSection" />
|
||
<AssemblyInfo>
|
||
<AssemblyName>System.Web</AssemblyName>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
<Base>
|
||
<BaseTypeName>System.Configuration.ConfigurationSection</BaseTypeName>
|
||
</Base>
|
||
<Interfaces />
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="T:System.Web.Configuration.SqlCacheDependencySection" /> allows you to programmatically access and modify the sqlCacheDependency element of the cache configuration section. </para>
|
||
<para>The SQL cache dependency allows the cached data to be synchronized with the original source. After you configure the relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table, an instance of the <see cref="T:System.Web.Caching.SqlCacheDependency" /> class monitors the table so that when an item in the table changes, the item is automatically removed from the cache.</para>
|
||
<para>The settings in this element only affect the table-based version of the <see cref="T:System.Web.Caching.SqlCacheDependency" /> object. The row-level <see cref="T:System.Web.Caching.SqlCacheDependency" /> objects used with sqprsqlong and above are not affected by these settings. </para>
|
||
<block subset="none" type="note">
|
||
<para>The <see cref="T:System.Web.Configuration.SqlCacheDependencySection" /> can write information into the related section of the configuration file according to the restrictions defined by the section property <see cref="P:System.Configuration.SectionInformation.AllowDefinition" /> whose value is <see cref="F:System.Configuration.ConfigurationAllowDefinition.MachineToApplication" />. Any attempt to write in a configuration file at a level not allowed in the hierarchy will result in an error message generated by the parser. However, you can use this class to read configuration information at any level in the hierarchy.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Configures the SQL cache dependencies for an ASP.NET application. This class cannot be inherited. </para>
|
||
</summary>
|
||
</Docs>
|
||
<Members>
|
||
<Member MemberName=".ctor">
|
||
<MemberSignature Language="C#" Value="public SqlCacheDependencySection ();" />
|
||
<MemberType>Constructor</MemberType>
|
||
<Parameters />
|
||
<Docs>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="M:System.Web.Configuration.SqlCacheDependencySection.#ctor" /> 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 <see cref="T:System.Web.Configuration.SqlCacheDependencySection" /> class by using the <see cref="M:System.Configuration.Configuration.GetSection(System.String)" /> method.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Initializes a new instance of the <see cref="T:System.Web.Configuration.SqlCacheDependencySection" /> class.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Databases">
|
||
<MemberSignature Language="C#" Value="public System.Web.Configuration.SqlCacheDependencyDatabaseCollection Databases { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<Attributes>
|
||
<Attribute>
|
||
<AttributeName>System.Configuration.ConfigurationProperty("databases")</AttributeName>
|
||
</Attribute>
|
||
</Attributes>
|
||
<ReturnValue>
|
||
<ReturnType>System.Web.Configuration.SqlCacheDependencyDatabaseCollection</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="P:System.Web.Configuration.SqlCacheDependencySection.Databases" /> property allows you to programmatically access the databases element of the <format type="text/html"><a href="3ffabd95-87b6-4a52-b753-9d298d43841d">sqlCacheDependency Element for caching (ASP.NET Settings Schema)</a></format> of the cache section a configuration file. </para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets the collection of <see cref="T:System.Web.Configuration.SqlCacheDependencyDatabase" /> objects stored within the <see cref="T:System.Web.Configuration.SqlCacheDependencySection" />.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="ElementProperty">
|
||
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationElementProperty ElementProperty { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Configuration.ConfigurationElementProperty</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Enabled">
|
||
<MemberSignature Language="C#" Value="public bool Enabled { set; get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<Attributes>
|
||
<Attribute>
|
||
<AttributeName>System.Configuration.ConfigurationProperty("enabled", DefaultValue="True")</AttributeName>
|
||
</Attribute>
|
||
</Attributes>
|
||
<ReturnValue>
|
||
<ReturnType>System.Boolean</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>After you configure the relationship between an item stored in an ASP.NET application's cache and a specific SQL Server database table, an instance of the <see cref="T:System.Web.Caching.SqlCacheDependency" /> class monitors the table so that when an item in the table changes the item is automatically removed from the cache.</para>
|
||
<para>For this class to work correctly, the database and any tables on which you want to set dependencies must have notifications enabled. For more information, see the remarks provided for the <see cref="T:System.Web.Caching.SqlCacheDependency" /> class.</para>
|
||
<block subset="none" type="note">
|
||
<para>Gets or sets a value indicating whether the database tables that have active <see cref="T:System.Web.Caching.SqlCacheDependency" /> objects should be monitored for changes. This setting does not affect the row-level <see cref="T:System.Web.Caching.SqlCacheDependency" /> objects.</para>
|
||
</block>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets or sets a value indicating whether the database table should be monitored for changes.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="PollTime">
|
||
<MemberSignature Language="C#" Value="public int PollTime { set; get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<Attributes>
|
||
<Attribute>
|
||
<AttributeName>System.Configuration.ConfigurationProperty("pollTime", DefaultValue="60000")</AttributeName>
|
||
</Attribute>
|
||
</Attributes>
|
||
<ReturnValue>
|
||
<ReturnType>System.Int32</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<value>To be added.</value>
|
||
<since version=".NET 2.0" />
|
||
<remarks>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>The <see cref="P:System.Web.Configuration.SqlCacheDependencySection.PollTime" /> property defines the time frequency with which ASP.NET polls the database for changes in the table linked to the cached item.</para>
|
||
<para>Note The frequency can be overridden on a database level in the databases element of the sqlCacheDependency in the cache configuration section.</para>
|
||
</remarks>
|
||
<summary>
|
||
<attribution license="cc4" from="Microsoft" modified="false" />
|
||
<para>Gets or sets the frequency with which the <see cref="T:System.Web.Caching.SqlCacheDependency" /> polls the database table for changes.</para>
|
||
</summary>
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="PostDeserialize">
|
||
<MemberSignature Language="C#" Value="protected override void PostDeserialize ();" />
|
||
<MemberType>Method</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Void</ReturnType>
|
||
</ReturnValue>
|
||
<Parameters />
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
<Member MemberName="Properties">
|
||
<MemberSignature Language="C#" Value="protected override System.Configuration.ConfigurationPropertyCollection Properties { get; }" />
|
||
<MemberType>Property</MemberType>
|
||
<ReturnValue>
|
||
<ReturnType>System.Configuration.ConfigurationPropertyCollection</ReturnType>
|
||
</ReturnValue>
|
||
<Docs>
|
||
<summary>To be added.</summary>
|
||
<value>To be added.</value>
|
||
<remarks>To be added.</remarks>
|
||
<since version=".NET 2.0" />
|
||
</Docs>
|
||
<AssemblyInfo>
|
||
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
||
</AssemblyInfo>
|
||
</Member>
|
||
</Members>
|
||
</Type> |