Edit

Share via

DataSourceControl.GetView(String) Method

  • Reference

Definition

Namespace:
System.Web.UI
Assembly:
System.Web.dll

Gets the named data source view associated with the data source control.

protected:
 abstract System::Web::UI::DataSourceView ^ GetView(System::String ^ viewName);
protected abstract System.Web.UI.DataSourceView GetView (string viewName);
abstract member GetView : string -> System.Web.UI.DataSourceView
Protected MustOverride Function GetView (viewName As String) As DataSourceView

Parameters

viewName
String

The name of the DataSourceView to retrieve. In data source controls that support only one view, such as SqlDataSource, this parameter is ignored.

Returns

DataSourceView

Returns the named DataSourceView associated with the DataSourceControl.

Examples

The following code example demonstrates how a data source control class that extends the DataSourceControl class implements the GetView method, returning a strongly typed instance of the DataSourceView class. Because the data source control supports only one view, it ignores the name and returns a view named with the default view name. This code example is part of a larger example provided for the DataSourceControl class.

// Return a strongly typed view for the current data source control.
private CsvDataSourceView view = null;
protected override DataSourceView GetView(string viewName) {
    if (null == view) {
        view = new CsvDataSourceView(this, String.Empty);
    }
    return view;
}

' Return a strongly typed view for the current data source control.
Private view As CsvDataSourceView = Nothing

Protected Overrides Function GetView(viewName As String) As DataSourceView
   If view Is Nothing Then
      view = New CsvDataSourceView(Me, String.Empty)
   End If
   Return view
End Function 'GetView

Remarks

You can enumerate through the set of views currently associated with the data source control by calling the GetViewNames method.

Data source control classes can support one or more views on their underlying data. These views are represented by instances of the DataSourceView class. The data source view defines the capabilities of a data source control, does all the work necessary to retrieve data from the underlying data store, and performs operations such as sorting, inserting, deleting, and updating.

Note

The DataSourceControl class's default implementation returns null. If you extend the DataSourceControl class, override the GetView method to return the specified DataSourceView object.

Applies to

See also