IPersistFileFormat Interface

  • Article

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

[GuidAttribute("3AFAE242-B530-11D0-8199-00A0C91BBEE3")]
[InterfaceTypeAttribute()]
public interface IPersistFileFormat : IPersist

[GuidAttribute(L"3AFAE242-B530-11D0-8199-00A0C91BBEE3")]
[InterfaceTypeAttribute()]
public interface class IPersistFileFormat : IPersist

[<GuidAttribute("3AFAE242-B530-11D0-8199-00A0C91BBEE3")>]
[<InterfaceTypeAttribute()>]
type IPersistFileFormat =  
    interface
        interface IPersist
    end

public interface IPersistFileFormat extends IPersist

The IPersistFileFormat type exposes the following members.

Methods

  Name Description
Public method GetClassID
Public method GetCurFile Returns the path to an object's current working file, or, if there is not a current working file, the object's default file name prompt.
Public method GetFormatList Provides the caller with the information necessary to open the standard common Save As dialog box (using the GetSaveFileNameViaDlg function) on behalf of the object.
Public method InitNew Instructs the object to initialize itself in the untitled state.
Public method IsDirty Determines whether an object has changed since being saved to its current file.
Public method Load Opens a specified file and initializes an object from the file contents.
Public method Save Saves a copy of the object into the specified file.
Public method SaveCompleted Notifies the object that it has concluded the Save transaction and that the object can write to its file.

Top

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.

Notes to Implementers

When saving documents or document editors that use the standard Save As dialog box implementation of the environment.

See Also

Reference

Microsoft.VisualStudio.Shell.Interop Namespace