IDtsComponentUI.Edit Method
Called when a component is edited.
Namespace: Microsoft.SqlServer.Dts.Pipeline.Design
Assembly: Microsoft.SqlServer.Dts.Design (in Microsoft.SqlServer.Dts.Design.dll)
Syntax
'Declaration
Function Edit ( _
parentWindow As IWin32Window, _
variables As Variables, _
connections As Connections _
) As Boolean
'Usage
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
Parameters
- parentWindow
Type: System.Windows.Forms.IWin32Window
The System.Windows.Forms.IWin32Window of the SSIS Designer.
- variables
Type: Microsoft.SqlServer.Dts.Runtime.Variables
The Variables collection that is accessible to the data flow task containing the component.
- connections
Type: Microsoft.SqlServer.Dts.Runtime.Connections
The Connections collection that is accessible to the data flow task containing the component.
Return Value
Type: System.Boolean
A value of true specifies that the component has been modified.
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.
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