IDtsComponentUI.Edit(IWin32Window, Variables, Connections) 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
当组件被编辑时调用。
public:
bool Edit(System::Windows::Forms::IWin32Window ^ parentWindow, Microsoft::SqlServer::Dts::Runtime::Variables ^ variables, Microsoft::SqlServer::Dts::Runtime::Connections ^ connections);
public bool Edit(System.Windows.Forms.IWin32Window parentWindow, Microsoft.SqlServer.Dts.Runtime.Variables variables, Microsoft.SqlServer.Dts.Runtime.Connections connections);
abstract member Edit : System.Windows.Forms.IWin32Window * Microsoft.SqlServer.Dts.Runtime.Variables * Microsoft.SqlServer.Dts.Runtime.Connections -> bool
Public Function Edit (parentWindow As IWin32Window, variables As Variables, connections As Connections) As Boolean
参数
- parentWindow
- IWin32Window
系统。Windows。Forms.IWin32SSIS设计器窗口。
- connections
- Connections
包含 Connections 该组件的数据流任务可访问的集合。
返回
值为真表示该组件已被修改。
示例
以下示例展示了该 Edit 方法的一个示例实现。 在这个示例中,会创建一个新窗口并以对话框的形式显示。 系统。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
注解
当在 SSIS 设计器中编辑组件时调用此方法。 使用该方法创建并显示实现组件用户界面的窗口。
该 connections 集合提供对 ConnectionManager 包中对象的访问。 你可以用这个集合来显示组件能够使用的对象列表 ConnectionManager 。
该方法的返回值 true 会通知设计者组件已被修改,导致包被标记为脏包,其他UI元素如 PropertyGrid也会被更新。
在SSIS设计器中显示窗口时,使用 parentWindow 参数确保窗口显示在设计器的客户端区域内。