DataSourceControl.GetViewNames Method

Reference

Definition

Namespace:: System.Web.UI

Assembly:: System.Web.dll

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.

Gets a collection of names, representing the list of DataSourceView objects associated with the DataSourceControl control.

protected:
 virtual System::Collections::ICollection ^ GetViewNames();

protected virtual System.Collections.ICollection GetViewNames ();

abstract member GetViewNames : unit -> System.Collections.ICollection
override this.GetViewNames : unit -> System.Collections.ICollection

Protected Overridable Function GetViewNames () As ICollection

Returns

ICollection

An ICollection that contains the names of the DataSourceView objects associated with the DataSourceControl.

Examples

The following code example demonstrates how a class that extends the DataSourceControl class can override the default implementation, which returns null, to provide a collection of view names. The CsvDataSource class only supports one view; therefore, a collection of one element with the default view name is returned. This code example is part of a larger example provided for the DataSourceControl class.

    // The ListSourceHelper class calls GetList, which
    // calls the DataSourceControl.GetViewNames method.
    // Override the original implementation to return
    // a collection of one element, the default view name.
    protected override ICollection GetViewNames() {
        ArrayList al = new ArrayList(1);
        al.Add(CsvDataSourceView.DefaultViewName);
        return al as ICollection;
    }
}

   ' The ListSourceHelper class calls GetList, which
   ' calls the DataSourceControl.GetViewNames method.
   ' Override the original implementation to return
   ' a collection of one element, the default view name.
   Protected Overrides Function GetViewNames() As ICollection
      Dim al As New ArrayList(1)
      al.Add(CsvDataSourceView.DefaultViewName)
      Return CType(al, ICollection)
   End Function 'GetViewNames

End Class

Remarks

The ICollection collection of names is the allowable set of values that can be passed to the GetView method.

The ListSourceHelper class, which is used for the DataSourceControl class's IListSource implementation, checks the GetViewNames method for both the IListSource.ContainsListCollection and IListSource.GetList calls to determine whether the data source control is associated with one or more data source views. If GetViewNames returns null, which is the default implementation of the method, IListSource.ContainsListCollection returns false and IListSource.GetList returns null.

Note

The DataSourceControl class's default implementation returns null. If you extend the DataSourceControl class, override the GetViewNames method to return a collection of view names.

Applies to

Jaa