DtsProperties.Item Property

Syntax

'Declaration
Public ReadOnly Default Property Item ( _
    index As Object _
) As DtsProperty
    Get
'Usage
Dim instance As DtsProperties
Dim index As Object
Dim value As DtsProperty

value = instance(index)

public DtsProperty this[
    Object index
] { get; }

public:
property DtsProperty^ default[Object^ index] {
    DtsProperty^ get (Object^ index);
}

member Item : DtsProperty

JScript supports the use of indexed properties, but not the declaration of new ones.

Remarks

If the call to Contains method returns true, you can access the specified element in the collection by using the syntax DtsProperties[index]. If Contains method returns false, this property throws an exception. In C#, this property is the indexer for the DtsProperties class.

Examples

The following code sample retrieves an item from the collection by using the DtsProperties[x] syntax to retrieve the name of the fifth object in the collection.

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

namespace DtsProperties_API
{
    class Program
    {
        static void Main(string[] args)
        {
            Package pkg = new Package();

            // Get the Properties collection from the package.
            // This shows the default properties set on new packages.
            DtsProperties pkgProperties = pkg.Properties;

           // Create the enumerator.
            PropertyEnumerator myEnumerator = pkgProperties.GetEnumerator();

            // Show the use of the Contains method.
            Boolean containsCertObj = pkgProperties.Contains("CertificateObject");
            Console.WriteLine("Contains CertificateObject? {0}", containsCertObj);

            // Show the use of the item[x] syntax.
            String aName = pkgProperties[5].Name;
            Console.WriteLine("Property 5 is {0}", aName);

            // Show the use of the MoveNext and Current methods.
            int i = 0;
            while ((myEnumerator.MoveNext()) && (myEnumerator.Current != null))
            {
                Console.WriteLine("[{0}] {1}", i++, myEnumerator.Current.Name);
            }
        }
    }
}

Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace DtsProperties_API
    Class Program
        Shared  Sub Main(ByVal args() As String)
            Dim pkg As Package =  New Package() 
 
            ' Get the Properties collection from the package.
            ' This shows the default properties set on new packages.
            Dim pkgProperties As DtsProperties =  pkg.Properties 
 
           ' Create the enumerator.
            Dim myEnumerator As PropertyEnumerator =  pkgProperties.GetEnumerator() 
 
            ' Show the use of the Contains method.
            Dim containsCertObj As Boolean =  pkgProperties.Contains("CertificateObject") 
            Console.WriteLine("Contains CertificateObject? {0}", containsCertObj)
 
            ' Show the use of the item[x] syntax.
            Dim aName As String =  pkgProperties(5).Name 
            Console.WriteLine("Property 5 is {0}", aName)
 
            ' Show the use of the MoveNext and Current methods.
            Dim i As Integer =  0 
            While (myEnumerator.MoveNext()) &&(myEnumerator.Current <> Nothing)
                Console.WriteLine("[{0}] {1}",i = Console.WriteLine("[{0}] {1}",i + 1
            End While
        End Sub
    End Class
End Namespace

Sample Output:

Contains CertificateObject? True

Property 5 is Configurations

[0] CertificateContext

[1] CertificateObject

[2] CheckpointFileName

[3] CheckpointUsage

[4] CheckSignatureOnLoad

[5] Configurations

[6] Connections

[7] CreationDate

[8] CreationName

[9] CreatorComputerName

[10] CreatorName

[11] DelayValidation

. . .

[63] VersionGUID

[64] VersionMajor

[65] VersionMinor

[66] Warnings

See Also

Reference