IHierarchicalDataSourceDesigner.RefreshSchema(Boolean) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Refreshes the schema of the underlying data source.
public:
void RefreshSchema(bool preferSilent);
public void RefreshSchema (bool preferSilent);
abstract member RefreshSchema : bool -> unit
Public Sub RefreshSchema (preferSilent As Boolean)
Parameters
- preferSilent
- 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(Boolean) method should raise a NotSupportedException.
Typically, if the RefreshSchema(Boolean) 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
.