FileConnectionManagerUIArgs Constructor (String)

Article
12/03/2008

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

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 _
)

public FileConnectionManagerUIArgs (
    string fileFilter
)

public:
FileConnectionManagerUIArgs (
    String^ fileFilter
)

public FileConnectionManagerUIArgs (
    String fileFilter
)

public function FileConnectionManagerUIArgs (
    fileFilter : String
)

Parameters

fileFilter
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.

Platforms

Development Platforms

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

Target Platforms

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

Share via