This documentation is archived and is not being maintained.

IHierarchicalDataSourceDesigner::RefreshSchema Method

Refreshes the schema of the underlying data source.

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

void RefreshSchema(
	bool preferSilent
)

Parameters

preferSilent
Type: System::Boolean

true to suppress events raised while refreshing the schema; otherwise false.

Notes to Implementers:

If you implement the IHierarchicalDataSourceDesigner interface to create your own data source and the schema will never change, the CanRefreshSchema property should always return false and the RefreshSchema method should raise a NotSupportedException.

Typically, if the RefreshSchema is called by the design host as a result of user action, the preferSilent parameter would be false, because the user would expect to be notified of any problems with refreshing the schema. But, if the schema is refreshed implicitly, such as after a call to the Configure method, or if the refreshing process involves a number of steps, preferSilent should be set to true.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: