IDtsComponentUI.Edit(IWin32Window, Variables, Connections) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Called when a component is edited.
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
Parameters
- parentWindow
- IWin32Window
The System.Windows.Forms.IWin32Window of the SSIS Designer.
- variables
- Variables
The Variables collection that is accessible to the data flow task containing the component.
- connections
- Connections
The Connections collection that is accessible to the data flow task containing the component.
Returns
A value of true specifies that the component has been modified.
Examples
The following example demonstrates a sample implementation of the Edit method. In this sample, a new window is created and shown as a dialog box. The System.Windows.Forms.Form.DialogResult property is used to determine whether the component has been modified, controlling the return value of the function.
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
Remarks
This method is called when the component is edited in the SSIS Designer. Use this method to create and display the window that implements the user interface for your component.
The connections
collection provides access to the ConnectionManager objects in the package. You can use this collection to show a list of ConnectionManager objects that your component is able to use.
A return value of true
from this method notifies the designer that the component has been modified, causing the package to be flagged as dirty, and other UI elements, such as the PropertyGrid, to be updated.
When displaying a window in the SSIS Designer, use the parentWindow
parameter to ensure the window is shown within the client area of the designer.