SqlCacheDependencySection.Enabled Property

Definition

Namespace:

System.Web.Configuration

Assembly:

System.Web.dll

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

public:
 property bool Enabled { bool get(); void set(bool value); };

[System.Configuration.ConfigurationProperty("enabled", DefaultValue=true)]
public bool Enabled { get; set; }

[<System.Configuration.ConfigurationProperty("enabled", DefaultValue=true)>]
member this.Enabled : bool with get, set

Public Property Enabled As Boolean

Property Value

Boolean

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

Attributes

ConfigurationPropertyAttribute

Examples

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;

' Get the current Enabled property value.
Dim enabledValue As [Boolean] = sqlDs.Enabled

' Set the Enabled property to false.
  sqlDs.Enabled = False

Remarks

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.

Note

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.

See also

• SqlCacheDependency
• Cache