Share via

  • Article

Sequence.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
Public Sub SetExpression ( _
    propertyName As String, _
    expression As String _
)
'Usage
Dim instance As Sequence
Dim propertyName As String
Dim expression As String

instance.SetExpression(propertyName, _
    expression)

public void SetExpression(
    string propertyName,
    string expression
)

public:
virtual void SetExpression(
    String^ propertyName, 
    String^ expression
) sealed

abstract SetExpression : 
        propertyName:string * 
        expression:string -> unit 
override SetExpression : 
        propertyName:string * 
        expression:string -> unit 

public final function SetExpression(
    propertyName : String, 
    expression : String
)

Parameters

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

Implements

IDTSPropertiesProvider.SetExpression(String, String)

Remarks

The propertyName can be any property available on the object.

Examples

The following code example uses SetExpression to modify the value of the Description on a Sequence container. Then GetExpression is used to retrieve the expression.

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

namespace Microsoft.SqlServer.SSIS.Sample
{
    class Program
    {
        static void Main(string[] args)
        {
            const String containerName = "Sequence";
            Package pkg = new Package();
            Sequence sequence = (Sequence)pkg.Executables.Add("STOCK:Sequence");
            DtsProperties seqProps = sequence.Properties;

            // View information about the Description property
            // before setting it using the SetExpression method.
            String desc = sequence.Description;
            Console.WriteLine("Original value of Description: {0}", desc);

            // Use SetExpression to give the Sequence a description.
            String myExpression = "\"Testing " + containerName + "\""; 
            sequence.SetExpression("Description", myExpression);
            // Note that I've tried using the Properties bag instead, with no change to the results.
            //seqProps["Description"].SetExpression(sequence, myExpression); 

            //Validate the package to set the expression onto the property.
            DTSExecResult valResult = pkg.Validate(null, null, null, null);

            // Retrieve the new value and the expression.
            String myNewDesc = sequence.Description;
            String myNewExpression = sequence.GetExpression("Description");
            Console.WriteLine("New value of Description: {0}", myNewDesc);
            Console.WriteLine("Expression for Description: {0}", myNewExpression);
        }
    }
}

Sample Output:

Original value of Description:

New value of Description: Testing Sequence

Expression for Description: "Testing Sequence"