IPersistFileFormat Interface
Obtains file format information about items that require saving, and enables the programmatic loading or saving of an object in a format specified by the user.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
<GuidAttribute("3AFAE242-B530-11D0-8199-00A0C91BBEE3")> _
<InterfaceTypeAttribute()> _
Public Interface IPersistFileFormat _
Inherits IPersist
'Usage
Dim instance As IPersistFileFormat
[GuidAttribute("3AFAE242-B530-11D0-8199-00A0C91BBEE3")]
[InterfaceTypeAttribute()]
public interface IPersistFileFormat : IPersist
[GuidAttribute(L"3AFAE242-B530-11D0-8199-00A0C91BBEE3")]
[InterfaceTypeAttribute()]
public interface class IPersistFileFormat : IPersist
public interface IPersistFileFormat extends IPersist
Remarks
The IPersistFileFormat interface is based on the standard IPersistFile interface and augments it in the following ways:
Shows you how to properly specify a new, untitled file to the InitNew method.
Shows you that the file should be opened as a read-only file.
Eliminates the unnecessary Save As prompt string from GetCurFile.
Returns an error code when Save(null) is called on an untitled object.
IPersistFileFormat provides enough information for the client of an object to implement the Save As dialog box—that is, to fill in the Save As Type drop-down list and manage the initial file extension but still give complete flexibility to the object. Thus, the object owns all aspects of its file and format, including the name of its format.
See illustrations of the implementation and/or calling of this interface in the samples Basic Edit Sample, Basic Project, Figures Language Service, and Figures Project.
Notes to Implementers:
When saving documents or document editors that use the standard Save As dialog box implementation of the environment.