UserDefinedAggregateCollection Class
The UserDefinedAggregateCollection class represents a collection of UserDefinedAggregate objects that represent all the database user-defined aggregates that are defined on a database.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
Microsoft.SqlServer.Management.Smo.SmoCollectionBase
Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
Microsoft.SqlServer.Management.Smo.SchemaCollectionBase
Microsoft.SqlServer.Management.Smo.UserDefinedAggregateCollection
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
Public NotInheritable Class UserDefinedAggregateCollection _
Inherits SchemaCollectionBase
'Usage
Dim instance As UserDefinedAggregateCollection
public sealed class UserDefinedAggregateCollection : SchemaCollectionBase
public ref class UserDefinedAggregateCollection sealed : public SchemaCollectionBase
[<SealedAttribute>]
type UserDefinedAggregateCollection =
class
inherit SchemaCollectionBase
end
public final class UserDefinedAggregateCollection extends SchemaCollectionBase
The UserDefinedAggregateCollection type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Count | Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.) |
|
IsSynchronized | Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.) |
|
Item[Int32] | Gets a UserDefinedAggregate object in the collection by index number. |
|
Item[String] | Gets a UserDefinedAggregate object in the collection by name. |
|
Item[String, String] | Gets a UserDefinedAggregate object in the collection by name and schema. |
|
Parent | Gets the Database object that is the parent of the UserDefinedAggregate object. |
|
SyncRoot | Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.) |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
Add | Adds a user-defined aggregate to the collection. |
.gif "Protected method") |
AddExisting | Adds an object to the collection. (Inherited from AbstractCollectionBase.) |
|
AddImpl | Adds the specified object to this collection (Inherited from SortedListCollectionBase.) |
|
Contains(String) | Validates whether the parameter collection contains a member with a name equal to the specified string. (Inherited from SchemaCollectionBase.) |
|
Contains(String, String) | Validates whether the parameter collection contains a member with a name equal to the specified string and with the specified schema. (Inherited from SchemaCollectionBase.) |
|
CopyTo | Copies the collection objects to a one-dimensional array starting at the specified index value. |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetCollectionElementType | Gets the Collection Element Type. (Inherited from SmoCollectionBase.) |
|
GetEnumerator | Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.) |
|
GetHashCode | (Inherited from Object.) |
|
GetItemById(Int32) | Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.) |
|
GetItemById(Int32, String) | Extracts a member from the referenced collection using a system-defined, unique identifier and name. (Inherited from SmoCollectionBase.) |
|
GetObjectByIndex | Extracts a member from the referenced collection using a system-defined, unique identifier. (Inherited from SmoCollectionBase.) |
|
GetType | (Inherited from Object.) |
|
ImplAddExisting | Adds an existing specified object to this collection (Inherited from SortedListCollectionBase.) |
|
InitializeChildCollection() | Initializes the child collections of the referenced collection. (Inherited from SmoCollectionBase.) |
|
InitializeChildCollection(Boolean) | Initializes the child collections of the referenced collection with the option to refresh the properties of the referenced collection. (Inherited from SmoCollectionBase.) |
|
InitInnerCollection | Initializes the collection. (Inherited from SchemaCollectionBase.) |
|
ItemById | Extracts a member from the UserDefinedAggregateCollection object by using a system-defined, unique identifier. |
|
MemberwiseClone | (Inherited from Object.) |
|
Refresh() | Refreshes the referenced collection. (Inherited from SmoCollectionBase.) |
|
Refresh(Boolean) | Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.) |
|
ToString | (Inherited from Object.) |
|
ValidateParentObject | Validates the parent object exists. (Inherited from SmoCollectionBase.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
initialized | This value supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from AbstractCollectionBase.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ICollection.CopyTo | Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.) |
Top
Remarks
A UserDefinedAggregateCollection object can be used to gain access to a set of database user-defined aggregates. You can use the Item property to return a specific UserDefinedAggregate object.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
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.