FileConnectionManagerUIArgs Constructor (String, ICollection)
Initializes a new instance of the FileConnectionManagerUIArgs class, initializing both the file type filter and the usage types.
Namespace: Microsoft.SqlServer.Dts.Runtime.Design
Assembly: Microsoft.SqlServer.Dts.Design (in Microsoft.SqlServer.Dts.Design.dll)
Syntax
'Declaration
Public Sub New ( _
fileFilter As String, _
supportedUsageTypes As ICollection _
)
'Usage
Dim fileFilter As String
Dim supportedUsageTypes As ICollection
Dim instance As New FileConnectionManagerUIArgs(fileFilter, _
supportedUsageTypes)
public FileConnectionManagerUIArgs(
string fileFilter,
ICollection supportedUsageTypes
)
public:
FileConnectionManagerUIArgs(
String^ fileFilter,
ICollection^ supportedUsageTypes
)
new :
fileFilter:string *
supportedUsageTypes:ICollection -> FileConnectionManagerUIArgs
public function FileConnectionManagerUIArgs(
fileFilter : String,
supportedUsageTypes : ICollection
)
Parameters
- fileFilter
Type: System.String
A file filter restricts the types of files offered in a user interface, such as *.txt.
- supportedUsageTypes
Type: System.Collections.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.