LanguageService.GetFormatFilterList Method

Returns a list of file extension filters suitable for a Save As dialog box.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)

Syntax

'Declaration
Public MustOverride Function GetFormatFilterList As String
public abstract string GetFormatFilterList()
public:
virtual String^ GetFormatFilterList() abstract
abstract GetFormatFilterList : unit -> string
public abstract function GetFormatFilterList() : String

Return Value

Type: String
If successful, returns a string containing the file extension filters; otherwise, returns an empty string.

Remarks

This method supplies a list of file extension filters formatted for a Save As dialog box. The extensions are formatted in pairs of descriptions and extensions, with each element separated by newlines or vertical bars ("|"). For example, a set of filters for C++ and C# files might be formatted as "C++ files (*.cpp)\n*.cpp\nC# files (*.cs)\n*.cs\n". Visual Studio always prepends the filter list "All Files (*.*)\n*.*\nText Files (*.txt)\n*.txt\n" to whatever is returned from this method.

The base method always returns an empty string. This means that the Save As dialog box will display the filters added by Visual Studio for all files and text files.

.NET Framework Security

See Also

Reference

LanguageService Class

Microsoft.VisualStudio.Package Namespace