次の方法で共有

IDtsComponentUI.Edit Method

  • [アーティクル]

コンポーネントの編集時に呼び出されます。 このメソッドは、CLS に準拠していません。

名前空間: Microsoft.SqlServer.Dts.Pipeline.Design
アセンブリ: Microsoft.SqlServer.Dts.Design (microsoft.sqlserver.dts.design.dll 内)

構文

'宣言
Function Edit ( _
    parentWindow As IWin32Window, _
    variables As Variables, _
    connections As Connections _
) As Boolean

bool Edit (
    IWin32Window parentWindow,
    Variables variables,
    Connections connections
)

bool Edit (
    IWin32Window^ parentWindow, 
    Variables^ variables, 
    Connections^ connections
)

boolean Edit (
    IWin32Window parentWindow, 
    Variables variables, 
    Connections connections
)

function Edit (
    parentWindow : IWin32Window, 
    variables : Variables, 
    connections : Connections
) : boolean

パラメータ

  • parentWindow
    SSIS デザイナの System.Windows.Forms.IWin32Window です。
  • variables
    コンポーネントを含むデータ フロー タスクにアクセスできる Variables コレクションです。
  • connections
    コンポーネントを含むデータ フロー タスクにアクセスできる Connections コレクションです。

戻り値

値が true の場合、コンポーネントが変更されたことを示しています。

解説

このメソッドは、コンポーネントを SSIS デザイナで編集するときに呼び出されます。このメソッドを使用して、コンポーネントのユーザー インターフェイスを実装するウィンドウを作成し、表示します。

connections コレクションは、パッケージ内の ConnectionManager オブジェクトへのアクセスを提供します。このコレクションでは、コンポーネントで使用できる ConnectionManager オブジェクトの一覧を表示できます。

このメソッドからの戻り値が true である場合、コンポーネントが変更されたことがデザイナに通知されます。その結果、該当のパッケージには dirty のフラグが付けられ、[PropertyGrid] など他の UI 要素が更新されます。

SSIS デザイナにウィンドウを表示したら、parentWindow パラメータを使用し、ウィンドウがデザイナのクライアント領域内に表示されることを確認します。

使用例

次の使用例は、Editメソッドのサンプル実装を示しています。この例では、新しいウィンドウが作成され、ダイアログ ボックスとして表示されます。System.Windows.Forms.Form.DialogResult プロパティは、関数の戻り値を制御し、コンポーネントが変更されたかどうかを調べるために使用します。

public bool Edit(IWin32Window parentWindow, Microsoft.SqlServer.Dts.Runtime.Variables variables, Microsoft.SqlServer.Dts.Runtime.Connections connections)
{
// Pass the dtsComponentMetaData parameter received
// in the Initialize method.
MyUI myUI = new MyUI(dtsComponentMetaData);

if (myUI.ShowDialog(parentWindow) == DialogResult.OK)
    return true;
else
    return false;
}

Public Function Edit(ByVal parentWindow As IWin32Window, ByVal variables As Microsoft.SqlServer.Dts.Runtime.Variables, ByVal connections As Microsoft.SqlServer.Dts.Runtime.Connections) As Boolean 
 Dim myUI As MyUI = New MyUI(dtsComponentMetaData) 
 If myUI.ShowDialog(parentWindow) = DialogResult.OK Then 
   Return True 
 Else 
   Return False 
 End If 
End Function

スレッド セーフ

この型の public static (Microsoft Visual Basic では共有 ) メンバは、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

開発プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

対象プラットフォーム

サポートされているプラットフォームの一覧については、「SQL Server 2005 のインストールに必要なハードウェアおよびソフトウェア」を参照してください。

参照

関連項目

IDtsComponentUI Interface
IDtsComponentUI Members
Microsoft.SqlServer.Dts.Pipeline.Design Namespace