Salvare i dati nei file di progetto

  • Articolo

Un sottotipo di progetto può salvare e recuperare dati specifici del sottotipo nel file di progetto. Managed Package Framework (MPF) fornisce due interfacce per eseguire questa attività:

  • L'interfaccia IVsBuildPropertyStorage consente di accedere ai valori delle proprietà dalla sezione MSBuild del file di progetto. I metodi forniti da IVsBuildPropertyStorage possono essere chiamati da qualsiasi utente ogni volta che l'utente deve caricare o salvare i dati correlati alla compilazione.

  • Viene IPersistXMLFragment utilizzato per rendere persistenti i dati non correlati alla compilazione in formato libero XML. I metodi forniti da IPersistXMLFragment vengono chiamati da Visual Studio ogni volta che Visual Studio deve rendere persistenti i dati non correlati alla compilazione nel file di progetto.

    Per altre informazioni su come rendere persistenti i dati correlati alla compilazione e non alla compilazione, vedere Rendere persistenti i dati nel file di progetto MSBuild.

  • Chiamare il SetPropertyValue metodo per salvare un percorso completo del file di progetto.

    private SpecializedProject project;
IVsBuildPropertyStorage projectStorage = (IVsBuildPropertyStorage)project;
string newFullPath = GetNewFullPath();
// Set a full path of the project file.
ErrorHandler.ThrowOnFailure(projectStorage.SetPropertyValue(
    "MSBuildProjectDirectory",
    String.Empty,
    (uint)_PersistStorageType.PST_PROJECT_FILE, newFullPath));

  • Chiamare il GetPropertyValue metodo per recuperare un percorso completo del file di progetto.

    private SpecializedProject project;
IVsBuildPropertyStorage projectStorage = (IVsBuildPropertyStorage)project;
string fullPath;
// Get a full path of the project file.
ErrorHandler.ThrowOnFailure(projectStorage.GetPropertyValue(
    "MSBuildProjectDirectory",
    String.Empty,
    (uint)_PersistStorageType.PST_PROJECT_FILE, out fullPath));

  1. Implementare il IsFragmentDirty metodo per determinare se un frammento XML è stato modificato dall'ultimo salvataggio nel file corrente.

    public int IsFragmentDirty(uint storage, out int pfDirty)
{
    pfDirty = 0;
    switch (storage)
    {
        case (uint)_PersistStorageType.PST_PROJECT_FILE:
        {
            if (isDirty)
                pfDirty |= 1;
            break;
        }
        case (uint)_PersistStorageType.PST_USER_FILE:
        {
            // We do not store anything in the user file.
            break;
        }
    }

    // Forward the call to inner flavor(s)
    if (pfDirty == 0 && innerCfg != null && this.innerCfg is IPersistXMLFragment)
        return ((IPersistXMLFragment)this.innerCfg).IsFragmentDirty(storage, out pfDirty);

    return VSConstants.S_OK;

}

  2. Implementare il Save metodo per salvare i dati XML nel file di progetto.

    public int Save(ref Guid guidFlavor, uint storage, out string pbstrXMLFragment, int fClearDirty)
{
    pbstrXMLFragment = null;

    if (IsMyFlavorGuid(ref guidFlavor))
    {
        switch (storage)
        {
            case (uint)_PersistStorageType.PST_PROJECT_FILE:
            {
                // Create XML for our data.
                XmlDocument doc = new XmlDocument();
                XmlNode root = doc.CreateElement(this.GetType().Name);

                XmlNode node = doc.CreateElement(targetsTag);
                node.AppendChild(doc.CreateTextNode(this.TargetsToExecute));
                root.AppendChild(node);

                node = doc.CreateElement(updateTargetsTag);
                node.AppendChild(doc.CreateTextNode(this.UpdateTargetList.ToString()));
                root.AppendChild(node);

                doc.AppendChild(root);
                // Get XML fragment representing our data
                pbstrXMLFragment = doc.InnerXml;

                if (fClearDirty != 0)
                    isDirty = false;
                break;
            }
            case (uint)_PersistStorageType.PST_USER_FILE:
            {
                // We do not store anything in the user file.
                break;
            }
        }
    }

    // Forward the call to inner flavor(s)
    if (this.innerCfg != null && this.innerCfg is IPersistXMLFragment)
        return ((IPersistXMLFragment)this.innerCfg).Save(ref guidFlavor, storage, out pbstrXMLFragment, fClearDirty);

    return VSConstants.S_OK;
}

  1. Implementare il InitNew metodo per inizializzare le proprietà dell'estensione del progetto e altri dati indipendenti dalla compilazione. Questo metodo viene chiamato se non sono presenti dati di configurazione XML nel file di progetto.

    public int InitNew(ref Guid guidFlavor, uint storage)
{
    //Return,if it is our guid.
    if (IsMyFlavorGuid(ref guidFlavor))
        return VSConstants.S_OK;

    //Forward the call to inner flavor(s).
    if (this.innerCfg != null && this.innerCfg is IPersistXMLFragment)
        return ((IPersistXMLFragment)this.innerCfg).InitNew(ref guidFlavor, storage);

    return VSConstants.S_OK;

  2. Implementare il Load metodo per caricare i dati XML dal file di progetto.

    public int Load(ref Guid guidFlavor, uint storage, string pszXMLFragment)
{
    if (IsMyFlavorGuid(ref guidFlavor))
    {
        switch (storage)
        {
            case (uint)_PersistStorageType.PST_PROJECT_FILE:
            {
                // Load our data from the XML fragment.
                XmlDocument doc = new XmlDocument();
                XmlNode node = doc.CreateElement(this.GetType().Name);
                node.InnerXml = pszXMLFragment;
                if (node == null
                    || node.FirstChild == null
                    || node.FirstChild.ChildNodes.Count == 0
                    || node.FirstChild.ChildNodes[0].Name != targetsTag)
                    break;
                this.TargetsToExecute = node.FirstChild.ChildNodes[0].InnerText;

                if (node.FirstChild.ChildNodes.Count <= 1
                    || node.FirstChild.ChildNodes[1].Name != updateTargetsTag)
                    break;
                this.UpdateTargetList = bool.Parse(node.FirstChild.ChildNodes[1].InnerText);
                break;
            }
            case (uint)_PersistStorageType.PST_USER_FILE:
            {
                // We do not store anything in the user file.
                break;
            }
        }
    }

    // Forward the call to inner flavor(s)
    if (this.innerCfg != null && this.innerCfg is IPersistXMLFragment)
        return ((IPersistXMLFragment)this.innerCfg).Load(ref guidFlavor, storage, pszXMLFragment);

    return VSConstants.S_OK;
}

Nota

Tutti gli esempi di codice forniti in questo argomento sono parti di un esempio più ampio negli esempi di VSSDK.

Contenuto correlato