Share via


ExtendedProperties.Contains Method

Returns a Boolean that indicates whether the items in the collection can be accessed using indexing without throwing an exception.

Namespace:  Microsoft.SqlServer.Dts.Runtime
Assembly:  Microsoft.SqlServer.ManagedDTS (in Microsoft.SqlServer.ManagedDTS.dll)

Syntax

'Declaration
Public Function Contains ( _
    index As Object _
) As Boolean
'Usage
Dim instance As ExtendedProperties 
Dim index As Object 
Dim returnValue As Boolean 

returnValue = instance.Contains(index)
public bool Contains(
    Object index
)
public:
bool Contains(
    Object^ index
)
member Contains : 
        index:Object -> bool
public function Contains(
    index : Object
) : boolean

Parameters

  • index
    Type: System.Object
    The name, identity, ID, or index to locate in the collection.

Return Value

Type: System.Boolean
A Boolean that indicates whether the collection can be accessed by name, description, ID, or index. A value of true indicates that the collection can be accessed by using the syntax ExtendedProperties[index]. A value of false indicates that indexing cannot be used to retrieve items from the ExtendedProperties collection; using this property throws an exception.

Examples

The following code sample uses Contains method to determine if an extended property with the GUID given is in the collection. The method returns a Boolean.

using System;
using System.Collections.Generic;
using System.Text;
using Microsoft.SqlServer.Dts.Runtime;

namespace ExtendedProperties_Testing
{
    class Program
    {
        static void Main(string[] args)
        {
            // The package is one of the SSIS samples.
            string mySample = @"C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx";
            // Create the application, and load the sample.
            Application app = new Application();
            Package pkg = app.LoadPackage(mySample, null);

            // Get the extended properties collection from the package.
            ExtendedProperties myExtProps = pkg.ExtendedProperties;

            // Use the ID.
            Boolean hasGUID = myExtProps.Contains("{F3B7314E-DB1E-4CCA-A856-2E617A1B3265}");
            Console.WriteLine("The extended property contains that GUID? {0}", hasGUID);
            Console.WriteLine();
        }
    }
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace ExtendedProperties_Testing
    Class Program
        Shared  Sub Main(ByVal args() As String)
            ' The package is one of the SSIS samples.
            Dim mySample As String =  "C:\Program Files\Microsoft SQL Server\100\Samples\Integration Services\Package Samples\CalculatedColumns Sample\CalculatedColumns\CalculatedColumns.dtsx" 
            ' Create the application, and load the sample.
            Dim app As Application =  New Application() 
            Dim pkg As Package =  app.LoadPackage(mySample,Nothing) 
 
            ' Get the extended properties collection from the package.
            Dim myExtProps As ExtendedProperties =  pkg.ExtendedProperties 
 
            ' Use the ID.
            Dim hasGUID As Boolean =  myExtProps.Contains("{F3B7314E-DB1E-4CCA-A856-2E617A1B3265}") 
            Console.WriteLine("The extended property contains that GUID? {0}", hasGUID)
            Console.WriteLine()
        End Sub
    End Class
End Namespace

Sample Output:

The extended property contains that GUID? True

See Also

Reference

ExtendedProperties Class

Microsoft.SqlServer.Dts.Runtime Namespace