UserDefinedMessageCollection UserDefinedMessageCollection UserDefinedMessageCollection Class

Definition

The UserDefinedMessageCollection class represents a collection of UserDefinedMessage objects that represent all the user-defined messages defined on a table.

public ref class UserDefinedMessageCollection sealed : Microsoft::SqlServer::Management::Smo::MessageCollectionBase
public sealed class UserDefinedMessageCollection : Microsoft.SqlServer.Management.Smo.MessageCollectionBase
Public NotInheritable Class UserDefinedMessageCollection
Inherits MessageCollectionBase
Inheritance

Examples

Using Collections

Remarks

A UserDefinedMessageCollection object can be used to gain access to a set of user-defined messages. You can use the Item[Int32, String] property to return a specific UserDefinedMessage 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.

Properties

Count Count Count

Gets the number of objects in the referenced collection.

(Inherited from SmoCollectionBase)
IsSynchronized IsSynchronized IsSynchronized

Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe.

(Inherited from SmoCollectionBase)
Item[Int32, String] Item[Int32, String] Item[Int32, String]

Gets a UserDefinedMessage object in the collection by message ID value and language.

Item[Int32] Item[Int32] Item[Int32]

Gets a UserDefinedMessage object in the collection by index number.

Parent Parent Parent

Gets the Server object that is the parent of the UserDefinedMessage object.

SyncRoot SyncRoot SyncRoot

Gets an object that can be used to synchronize access to the collection.

(Inherited from SmoCollectionBase)

Methods

AddExisting(SqlSmoObject) AddExisting(SqlSmoObject) AddExisting(SqlSmoObject)

Adds an object to the collection.

(Inherited from AbstractCollectionBase)
AddImpl(SqlSmoObject) AddImpl(SqlSmoObject) AddImpl(SqlSmoObject)

Adds the specified object to this collection

(Inherited from SortedListCollectionBase)
Contains(Int32, Int32) Contains(Int32, Int32) Contains(Int32, Int32)

Determines whether an object with the specified ID value and language ID value exists in the message collection object.

(Inherited from MessageCollectionBase)
Contains(Int32, String) Contains(Int32, String) Contains(Int32, String)

Determines whether an object with the specified ID value and language exists in the message collection object.

(Inherited from MessageCollectionBase)
CopyTo(UserDefinedMessage[], Int32) CopyTo(UserDefinedMessage[], Int32) CopyTo(UserDefinedMessage[], Int32)

Copies the collection objects to a one-dimensional array beginning at the index value specified.

GetCollectionElementType() GetCollectionElementType() GetCollectionElementType()

Gets the Collection Element Type.

(Inherited from SmoCollectionBase)
GetEnumerator() GetEnumerator() GetEnumerator()

Returns an IEnumerator interface that allows you to iterate through the objects in the collection.

(Inherited from SmoCollectionBase)
GetItemById(Int32) GetItemById(Int32) GetItemById(Int32)

Extracts a member from the referenced collection using a system-defined, unique identifier.

(Inherited from SmoCollectionBase)
GetItemById(Int32, String) GetItemById(Int32, String) GetItemById(Int32, String)

Extracts a member from the referenced collection using a system-defined, unique identifier and name.

(Inherited from SmoCollectionBase)
GetObjectByIndex(Int32) GetObjectByIndex(Int32) GetObjectByIndex(Int32)

Extracts a member from the referenced collection using a system-defined, unique identifier.

(Inherited from SmoCollectionBase)
ImplAddExisting(SqlSmoObject) ImplAddExisting(SqlSmoObject) ImplAddExisting(SqlSmoObject)

Adds an existing specified object to this collection

(Inherited from SortedListCollectionBase)
InitializeChildCollection() InitializeChildCollection() InitializeChildCollection()

Initializes the child collections of the referenced collection.

(Inherited from SmoCollectionBase)
InitializeChildCollection(Boolean) InitializeChildCollection(Boolean) 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() InitInnerCollection() InitInnerCollection()

This method supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from MessageCollectionBase)
ItemByIdAndLanguage(Int32, String) ItemByIdAndLanguage(Int32, String) ItemByIdAndLanguage(Int32, String)

Extracts a member from the UserDefinedMessageCollection collection using a system-defined, unique identifier and the specified language.

ItemByIdAndLanguageId(Int32, Int32) ItemByIdAndLanguageId(Int32, Int32) ItemByIdAndLanguageId(Int32, Int32)

Extracts a member from the UserDefinedMessageCollection collection using a system-defined, unique identifier and the specified language.

Refresh() Refresh() Refresh()

Refreshes the referenced collection.

(Inherited from SmoCollectionBase)
Refresh(Boolean) Refresh(Boolean) Refresh(Boolean)

Refreshes the referenced collection with the option to refresh child objects of the referenced collection.

(Inherited from SmoCollectionBase)
Remove(Int32) Remove(Int32) Remove(Int32)

Removes the object with the specified ID value from the message collection object.

(Inherited from MessageCollectionBase)
Remove(Int32, String) Remove(Int32, String) Remove(Int32, String)

Removes the object with the specified ID value and language from the message collection object.

(Inherited from MessageCollectionBase)
ValidateParentObject(SqlSmoObject) ValidateParentObject(SqlSmoObject) ValidateParentObject(SqlSmoObject)

Validates the parent object exists.

(Inherited from SmoCollectionBase)

Fields

initialized initialized initialized

This value supports the SMO infrastructure and is not intended to be used directly from your code.

(Inherited from AbstractCollectionBase)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32) ICollection.CopyTo(Array, Int32)

Copies the elements from an instance to an array beginning at the index indicated.

(Inherited from SmoCollectionBase)

Applies to