FileConnectionManagerUIArgs Constructors

Definition

Namespace:

Microsoft.SqlServer.Dts.Runtime.Design

Assembly:

Microsoft.SqlServer.Dts.Design.dll

Initializes a new instance of the FileConnectionManagerUIArgs class.

Overloads

FileConnectionManagerUIArgs()	Initializes a new instance of the FileConnectionManagerUIArgs class.
FileConnectionManagerUIArgs(ICollection)	Initializes a new instance of the FileConnectionManagerUIArgs class using a collection of usage types specific to this connection.
FileConnectionManagerUIArgs(String)	Initializes a new instance of the FileConnectionManagerUIArgs class using a String to specify what file types are valid for this connection.
FileConnectionManagerUIArgs(String, ICollection)	Initializes a new instance of the FileConnectionManagerUIArgs class, initializing both the file type filter and the usage types.

FileConnectionManagerUIArgs()

Initializes a new instance of the FileConnectionManagerUIArgs class.

public:
 FileConnectionManagerUIArgs();

public FileConnectionManagerUIArgs ();

Public Sub New ()

FileConnectionManagerUIArgs(ICollection)

Initializes a new instance of the FileConnectionManagerUIArgs class using a collection of usage types specific to this connection.

public:
 FileConnectionManagerUIArgs(System::Collections::ICollection ^ supportedUsageTypes);

public FileConnectionManagerUIArgs (System.Collections.ICollection supportedUsageTypes);

new Microsoft.SqlServer.Dts.Runtime.Design.FileConnectionManagerUIArgs : System.Collections.ICollection -> Microsoft.SqlServer.Dts.Runtime.Design.FileConnectionManagerUIArgs

Public Sub New (supportedUsageTypes As ICollection)

Parameters

supportedUsageTypes

ICollection

A collection of DTSFileConnectionUsageType enumerations available to choose from.

Remarks

An empty collection implies that all usage types are supported.

The usage types are currently Create file, Existing file, Create folder, and Existing folder. The collection contains only those types that are valid for the connection. For example, in the FTP task, if the operation is to send files using FTP, then the local path can only be Existing file, as you can only transfer existing files.

FileConnectionManagerUIArgs(String)

Initializes a new instance of the FileConnectionManagerUIArgs class using a String to specify what file types are valid for this connection.

public:
 FileConnectionManagerUIArgs(System::String ^ fileFilter);

public FileConnectionManagerUIArgs (string fileFilter);

new Microsoft.SqlServer.Dts.Runtime.Design.FileConnectionManagerUIArgs : string -> Microsoft.SqlServer.Dts.Runtime.Design.FileConnectionManagerUIArgs

Public Sub New (fileFilter As String)

Parameters

fileFilter

String

A file filter restricts the types of files offered in a user interface, such as *.txt.

Remarks

The default is to show all files. To filter the the files that are shown to the user, enter a fileFilter string to specify those types that are valid for the connection. For example, in an XML task, you may want the user to select from among XML files only, so the fileFilter would be *.XML.

For each filtering option, the filter string contains a description of the filter, followed by the vertical bar (|) and the filter pattern. The strings for each part of the filtering option are separated by the vertical bar.

The following is an example of a filter string:

"Text files (*.txt)|*.txt|All files (*.*)|*.*"

You can add several filter patterns to a single filter option by separating the file types with semicolons. For example:

"Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*"

The format and syntax of this fileFilter string is identical to the Filter property found on the OpenFileDialog. For more information on the OpenFileDialog Class, see the .NET Framework Class Library.

FileConnectionManagerUIArgs(String, ICollection)

Initializes a new instance of the FileConnectionManagerUIArgs class, initializing both the file type filter and the usage types.

public:
 FileConnectionManagerUIArgs(System::String ^ fileFilter, System::Collections::ICollection ^ supportedUsageTypes);

public FileConnectionManagerUIArgs (string fileFilter, System.Collections.ICollection supportedUsageTypes);

new Microsoft.SqlServer.Dts.Runtime.Design.FileConnectionManagerUIArgs : string * System.Collections.ICollection -> Microsoft.SqlServer.Dts.Runtime.Design.FileConnectionManagerUIArgs

Public Sub New (fileFilter As String, supportedUsageTypes As ICollection)

Parameters

fileFilter

String

A file filter restricts the types of files offered in a user interface, such as *.txt.

supportedUsageTypes

ICollection

A collection of DTSFileConnectionUsageType enumerations available to choose from.

Remarks

For the fileFilter, the default is to show all files. To filter the files that are shown to the user, enter a fileFilter string to specify those types that are valid for the connection. For example, in an XML task, you may want the user to select only XML files, so the fileFilter would be *.XML.

For each filtering option, the filter string contains a description of the filter, followed by the vertical bar (|) and the filter pattern. If there are multiple filtering options, the strings for successive options are separated by additional vertical bars.

The following is an example of a filter string: "Text files (*.txt)|*.txt|All files (*.*)|*.*"

You can add several filter patterns to a filter by separating the file types with semicolons. For example: "Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*"

The format and syntax of this fileFilter string is identical to the Filter property found on the OpenFileDialog. For more information on the OpenFileDialog Class, see the .NET Framework Class Library.

For the supportedUsageTypes, an empty collection implies that all usage types are supported.

The usage types are currently Create file, Existing file, Create folder, and Existing folder. The collection contains only those types that are valid for the connection. For example, in the FTP task, if the operation is to send files using FTP, then the local path can only be Existing file, as you can only transfer existing files.