次の方法で共有

  • [アーティクル]

Edit メソッド

コンポーネントの編集時に呼び出されます。

名前空間:  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
'使用
Dim instance As IDtsComponentUI
Dim parentWindow As IWin32Window
Dim variables As Variables
Dim connections As Connections
Dim returnValue As Boolean

returnValue = instance.Edit(parentWindow, _
    variables, connections)

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

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

abstract Edit : 
        parentWindow:IWin32Window * 
        variables:Variables * 
        connections:Connections -> bool 

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

パラメーター

戻り値

型: System. . :: . .Boolean
値が 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