ExtendedProperties.Remove(Object) Method

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime

Assembly:

Microsoft.SqlServer.ManagedDTS.dll

Removes an ExtendedProperty object from the ExtendedProperties collection.

public:
 void Remove(System::Object ^ index);

public void Remove (object index);

member this.Remove : obj -> unit

Public Sub Remove (index As Object)

Parameters

index

Object

The name, index, ID, or description of the ExtendedProperty object to remove.

Examples

The following example removes an extended property from the collection using the ID.

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;  

            // Give the count of the number of extended properties.  
            int numProps = myExtProps.Count;  
            Console.WriteLine("Current number of extended properties: {0}", numProps);  
            // Remove an extended property.  
            myExtProps.Remove("{A56842E2-11C1-487E-B670-33F25B534146}");  
            // Give the new count of the number of extended properties.  
            numProps = myExtProps.Count;  
            Console.WriteLine("New number of extended properties: {0}", numProps);  
            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   

            ' Give the count of the number of extended properties.  
            Dim numProps As Integer =  myExtProps.Count   
            Console.WriteLine("Current number of extended properties: {0}", numProps)  
            ' Remove an extended property.  
            myExtProps.Remove("{A56842E2-11C1-487E-B670-33F25B534146}")  
            ' Give the new count of the number of extended properties.  
            numProps = myExtProps.Count  
            Console.WriteLine("New number of extended properties: {0}", numProps)  
            Console.WriteLine()  
        End Sub  
    End Class  
End Namespace  

Sample Output:

Current number of extended properties: 7

New number of extended properties: 6