Share via


IDTSPropertiesProvider.SetExpression Method

Assigns the specified expression to the property. Specify nulla null reference (Nothing in Visual Basic) to remove an existing expression from the property.

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

Syntax

'Declaration
Sub SetExpression ( _
    propertyName As String, _
    expression As String _
)
'Usage
Dim instance As IDTSPropertiesProvider 
Dim propertyName As String 
Dim expression As String

instance.SetExpression(propertyName, _
    expression)
void SetExpression(
    string propertyName,
    string expression
)
void SetExpression(
    String^ propertyName, 
    String^ expression
)
abstract SetExpression : 
        propertyName:string * 
        expression:string -> unit
function SetExpression(
    propertyName : String, 
    expression : String
)

Parameters

  • propertyName
    Type: System.String
    The name of the property to which to assign the expression.

Remarks

The propertyName can be any property available on the object.

Examples

The ConnectionManager class inherits from the IDTSPropertiesProvider interface. The following code example shows the ConnectionManager class using the SetExpression and GetExpression methods that it inherited.

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

namespace ConnMgr_Properties_Collection
{
    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 an application and load the sample.
            Application app = new Application();
            Package pkg = app.LoadPackage(mySample, null);
            Connections myConns = pkg.Connections;

            // Get the Properties collection from the connection manager.
            ConnectionManager myConnMgr = myConns[0];
            DtsProperties connProperties = myConnMgr.Properties;

            // View information about the RetainSameConnection property 
            // before setting it using the SetExpression method.
            Boolean hasProperty = connProperties.Contains("RetainSameConnection");
            Console.WriteLine("has RetainSameConnection? {0}", hasProperty);
            Object myValue = myConnMgr.Properties["RetainSameConnection"].GetValue(myConnMgr);
            String mySValue = myValue.ToString();
            Console.WriteLine("value before is {0}", mySValue);String myTrueString = "true";

            // Use SetExpression to set the value to true.
myConnMgr.Properties["RetainSameConnection"].SetExpression(myConnMgr, myTrueString);
            
            // Validate the package to set the expression on the property.
            DTSExecResult valResult = pkg.Validate(myConns, null, null, null);
            
            // Now that the value has been set, retrieve the value
            // and the expression.
            myValue = myConnMgr.Properties["RetainSameConnection"].GetValue(myConnMgr);
            mySValue = myValue.ToString();
            String myExpression = myConnMgr.Properties["RetainSameConnection"].GetExpression(myConnMgr);
            String mySExpression = myExpression.ToString();
            Console.WriteLine("value and expression is {0}, {1}", mySValue, mySExpression); 
        }
    }
}
Imports System
Imports System.Collections.Generic
Imports System.Text
Imports Microsoft.SqlServer.Dts.Runtime
 
Namespace ConnMgr_Properties_Collection
    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 an application and load the sample.
        Dim app As New Application()
        Dim pkg As Package = app.LoadPackage(mySample, Nothing)
        Dim myConns As Connections = pkg.Connections

        ' Get the Properties collection from the connection manager.
        Dim myConnMgr As ConnectionManager = myConns(0)
        Dim connProperties As DtsProperties = myConnMgr.Properties

        ' View information about the RetainSameConnection property 
        ' before setting it using the SetExpression method.
        Dim hasProperty As [Boolean] = connProperties.Contains("RetainSameConnection")
        Console.WriteLine("has RetainSameConnection? {0}", hasProperty)
        Dim myValue As [Object] = myConnMgr.Properties("RetainSameConnection").GetValue(myConnMgr)
        Dim mySValue As String = myValue.ToString()
        Console.WriteLine("value before is {0}", mySValue)
        Dim myTrueString As String = "true"

        ' Use SetExpression to set the value to true.
myConnMgr.Properties("RetainSameConnection").SetExpression(myConnMgr, myTrueString)

        ' Validate the package to set the expression on the property.
        Dim valResult As DTSExecResult = pkg.Validate(myConns, Nothing, Nothing, Nothing)

        ' Now that the value has been set, retrieve the value
        ' and the expression.
        myValue = myConnMgr.Properties("RetainSameConnection").GetValue(myConnMgr)
        mySValue = myValue.ToString()
        Dim myExpression As String = myConnMgr.Properties("RetainSameConnection").GetExpression(myConnMgr)
        Dim mySExpression As String = myExpression.ToString()
        Console.WriteLine("value and expression is {0}, {1}", mySValue, mySExpression) 
        End Sub
    End Class
End Namespace

Sample Output:

has RetainSameConnection? True

value before is False

value and expression is True, true

See Also

Reference

IDTSPropertiesProvider Interface

Microsoft.SqlServer.Dts.Runtime Namespace