MultiFileConnectionManagerUIArgs Constructor (String, ICollection)
Initializes a new instance of the MultiFileConnectionManagerUIArgs 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 MultiFileConnectionManagerUIArgs(fileFilter, _
supportedUsageTypes)
public MultiFileConnectionManagerUIArgs(
string fileFilter,
ICollection supportedUsageTypes
)
public:
MultiFileConnectionManagerUIArgs(
String^ fileFilter,
ICollection^ supportedUsageTypes
)
new :
fileFilter:string *
supportedUsageTypes:ICollection -> MultiFileConnectionManagerUIArgs
public function MultiFileConnectionManagerUIArgs(
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 for usage types.
Remarks
For the fileFilter, the default filter, if no other filter is specified, is to show all files. To limit the files shown, the fileFilter string can specify only those types that are valid for the connection. For example, in an XML task, you may only want the user to select 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. The strings for different filtering options 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 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 class. For more information , see the "OpenFileDialog Class" in 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.
See Also
Reference
MultiFileConnectionManagerUIArgs Class