FileConnectionManagerUIArgs.FileFilter Property
Gets or sets a pipe-delimited String containing the file types that are valid for the connection.
Namespace: Microsoft.SqlServer.Dts.Runtime.Design
Assembly: Microsoft.SqlServer.Dts.Design (in Microsoft.SqlServer.Dts.Design.dll)
Syntax
'Declaration
Public Property FileFilter As String
Get
Set
'Usage
Dim instance As FileConnectionManagerUIArgs
Dim value As String
value = instance.FileFilter
instance.FileFilter = value
public string FileFilter { get; set; }
public:
property String^ FileFilter {
String^ get ();
void set (String^ value);
}
member FileFilter : string with get, set
function get FileFilter () : String
function set FileFilter (value : String)
Property Value
Type: System.String
A String containing the file types that are valid for the connection.
Remarks
For the fileFilter, the default filter, if not 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. For more information on the "OpenFileDialog Class", see the .NET Framework Class Library.