Share via

SoapPayloadMethodCollection Class

  • Article

The SoapPayloadMethodCollection class represents a collection of SoapPayloadMethod objects that represent all the SOAP payload methods defined on a table.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.AbstractCollectionBase
    Microsoft.SqlServer.Management.Smo.SmoCollectionBase
      Microsoft.SqlServer.Management.Smo.SortedListCollectionBase
        Microsoft.SqlServer.Management.Smo.SimpleObjectCollectionBase
          Microsoft.SqlServer.Management.Smo.SoapMethodCollectionBase
            Microsoft.SqlServer.Management.Smo.SoapPayloadMethodCollection

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public NotInheritable Class SoapPayloadMethodCollection _
    Inherits SoapMethodCollectionBase
'Usage
Dim instance As SoapPayloadMethodCollection

public sealed class SoapPayloadMethodCollection : SoapMethodCollectionBase

public ref class SoapPayloadMethodCollection sealed : public SoapMethodCollectionBase

[<SealedAttribute>]
type SoapPayloadMethodCollection =  
    class 
        inherit SoapMethodCollectionBase 
    end

public final class SoapPayloadMethodCollection extends SoapMethodCollectionBase

The SoapPayloadMethodCollection type exposes the following members.

Properties

  Name Description
Public property Count Gets the number of objects in the referenced collection. (Inherited from SmoCollectionBase.)
Public property IsSynchronized Gets the Boolean property value that specifies whether access to the collection is synchronized and therefore thread-safe. (Inherited from SmoCollectionBase.)
Public property Item[Int32] Gets a SoapPayloadMethod object in the collection by index number.
Public property Item[String] Gets a SoapPayloadMethod object in the collection by name.
Public property Item[String, String] Gets a SoapPayloadMethod object in the specified collection by name.
Public property Parent Gets the SoapPayload object that is the parent of the SoapPayloadMethodCollection object.
Public property SyncRoot Gets an object that can be used to synchronize access to the collection. (Inherited from SmoCollectionBase.)

Top

Methods

  Name Description
Public method Add Adds a SoapPayloadMethod object to the SoapPayloadMethodCollection collection.
Protected method AddExisting Adds an object to the collection. (Inherited from AbstractCollectionBase.)
Public method Contains(String) Verifies whether the specified object exists in the collection. (Inherited from SoapMethodCollectionBase.)
Public method Contains(String, String) Verifies whether the specified object exists in the referenced collection. (Inherited from SoapMethodCollectionBase.)
Public method CopyTo Copies the collection objects to a one-dimensional array starting at the index value specified.
Public method Equals (Inherited from Object.)
Public method GetEnumerator Returns an IEnumerator interface that allows you to iterate through the objects in the collection. (Inherited from SmoCollectionBase.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method Refresh() Refreshes the referenced collection. (Inherited from SmoCollectionBase.)
Public method Refresh(Boolean) Refreshes the referenced collection with the option to refresh child objects of the referenced collection. (Inherited from SmoCollectionBase.)
Public method Remove(String) Removes the specified object from the referenced collection. (Inherited from SoapMethodCollectionBase.)
Public method Remove(SoapPayloadMethod) Removes a SoapPayloadMethod object from the collection.
Public method Remove(String, String) Removes the specified object from the referenced collection. (Inherited from SoapMethodCollectionBase.)
Public method ToString (Inherited from Object.)

Top

Fields

  Name Description
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
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements from an instance to an array beginning at the index indicated. (Inherited from SmoCollectionBase.)

Top

Remarks

A SoapPayloadMethodCollection object can be used to gain access to a set of SOAP payload methods. You can use the Item property to return a specific SoapPayloadMethod 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.

Examples

Using Collections

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.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace