DocData.FormatList Property

Gets a list of formats.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
Protected MustOverride ReadOnly Property FormatList As String
protected abstract string FormatList { get; }
protected:
virtual property String^ FormatList {
    String^ get () abstract;
}
abstract FormatList : string with get
abstract function get FormatList () : String

Property Value

Type: System.String
The list of formats.

Remarks

Each string should be terminated with a newline (\n) character. The last string in the buffer must also be terminated with a newline character.

The caller can replace each newline character with a null (\0) character. Then, the caller can have a string that is the same as the lpstrFilter member of the WinAPI OPENFILENAME structure.

The first string in each pair is a display string that describes the filter, such as Text Only (*.txt). The second string specifies the filter pattern, such as *.txt. For example: Text File (*.txt)\n*.txt\n.

To specify multiple filter patterns for a single display string, use a semicolon to separate the patterns. For example: *.htm;*.html;*.asp.

A pattern string can include a combination of valid file name characters and the asterisk (*) wildcard character. Do not include spaces in the pattern string. The following string is an example of a file pattern string: HTML File (*.htm; *.html; *.asp)\n*.htm;*.html;*.asp\nText File (*.txt)\n*.txt\n.

.NET Framework Security

See Also

Reference

DocData Class

Microsoft.VisualStudio.Modeling.Shell Namespace