This documentation is archived and is not being maintained.

DataSourceDesigner.CanRefreshSchema Property

Gets a value indicating whether the RefreshSchema method can be called.

Namespace:  System.Web.UI.Design
Assembly:  System.Design (in System.Design.dll)

public virtual bool CanRefreshSchema { get; }

Property Value

Type: System.Boolean
true if the RefreshSchema can be called; otherwise, false. The default is false.



Use the CanRefreshSchema property in a derived class to enable or disable the ability to refresh the schema at design time for a specific data source. If your application requires an invariant data structure and the schema will never change, you want the CanRefreshSchema property to return false.

A design host such as Visual Studio 2005 uses the CanRefreshSchema property to determine whether a command to refresh the schema appears in the action list menu at design time.

In a design host such as Visual Studio 2005, you can see the CanRefreshSchema property in action by completing the following process:

  1. On your page, place a SqlDataSource or an AccessDataSource control.

  2. In Design view, on the action list, click Configure.

  3. Remove a few fields from the data source.

  4. On the action list, click Refresh Schema.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.