SqlCacheDependencySection.Enabled Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating whether the database table should be monitored for changes.

Namespace:   System.Web.Configuration
Assembly:  System.Web (in System.Web.dll)

[ConfigurationPropertyAttribute("enabled", DefaultValue = true)]
public bool Enabled { get; set; }

Property Value

Type: System.Boolean

true if SQL cache monitoring is enabled; otherwise, false. The default is true.

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 SqlCacheDependency class monitors the table so that when an item in the table changes the item is automatically removed from the cache.

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 SqlCacheDependency class.

System_CAPS_noteNote

Gets or sets a value indicating whether the database tables that have active SqlCacheDependency objects should be monitored for changes. This setting does not affect the row-level SqlCacheDependency objects.

The following code example shows how to use the Enabled property.


// Get the current Enabled property value.
Boolean enabledValue = sqlDs.Enabled;

// Set the Enabled property to false.
sqlDs.Enabled = false;

.NET Framework
Available since 2.0
Return to top
Show: