FileConnectionManagerUIArgs.FileFilter Property

Artikkeli
12/03/2008

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

public string FileFilter { get; set; }

public:
property String^ FileFilter {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_FileFilter ()

/** @property */
public void set_FileFilter (String value)

public function get FileFilter () : String

public function set FileFilter (value : String)

Property Value

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.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms