DataObjectEnumerator Class
Provides the ability to enumerate data objects.
Inheritance Hierarchy
System.Object
Microsoft.VisualStudio.Data.ObjectWithSite
Microsoft.VisualStudio.Data.DataObjectEnumerator
Microsoft.VisualStudio.Data.AdoDotNet.AdoDotNetObjectEnumerator
Namespace: Microsoft.VisualStudio.Data
Assembly: Microsoft.VisualStudio.Data (in Microsoft.VisualStudio.Data.dll)
Syntax
'Declaration
Public MustInherit Class DataObjectEnumerator _
Inherits ObjectWithSite
public abstract class DataObjectEnumerator : ObjectWithSite
public ref class DataObjectEnumerator abstract : public ObjectWithSite
[<AbstractClass>]
type DataObjectEnumerator =
class
inherit ObjectWithSite
end
public abstract class DataObjectEnumerator extends ObjectWithSite
The DataObjectEnumerator type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
DataObjectEnumerator | Class constructor. Instantiates a new instance of the DataObjectEnumerator class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
Connection | Retrieves the current data connection. |
.gif "Public property") |
Site | Retrieves or sets the object site. (Inherited from ObjectWithSite.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
EnumerateObjects | Enumerates items for a set of data objects of the specified type with the specified restrictions and sort string, if supported. |
|
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Serves as the default hash function. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnSiteChanged | Raises the SiteChanged event. (Inherited from ObjectWithSite.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
SiteChanged | Event that is raised when the Site property is changed. (Inherited from ObjectWithSite.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IObjectWithSite.GetSite | Retrieves the last site set using the IObjectWithSite.SetSite method. In cases where there is no known site, the object returns an exception. (Inherited from ObjectWithSite.) |
|
IObjectWithSite.SetSite | Provides the site's pointer to the site object. (Inherited from ObjectWithSite.) |
Top
Remarks
Use this class in cases where a data provider must implement a custom enumeration mechanism, typically when no base enumeration mechanism (such as ADO.NET object enumerator) exists.
Classes derived from DataObjectEnumerator should implement the EnumerateObjects method using the protected Connection property to the level of support expected by the particular implementation. Any client of this class is expected to understand the format of parameters passed to the implementation.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.