Condividi tramite

Metodo ServerDocument.GetCustomizationVersion

  • Articolo

Restituisce la versione di Runtime di Visual Studio Tools per Office utilizzata per creare la personalizzazione associata al documento specificato.

Spazio dei nomi:  Microsoft.VisualStudio.Tools.Applications
Assembly:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (in Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Sintassi

'Dichiarazione
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer

public static int GetCustomizationVersion(
    string documentPath
)

Parametri

  • documentPath
    Tipo: System.String
    Percorso completo del documento che si desidera verificare.

Valore restituito

Tipo: System.Int32
Numero che specifica la versione di Runtime di Visual Studio Tools per Office utilizzata per creare la personalizzazione associata.

Eccezioni

Eccezione Condizione
ArgumentNullException

Il parametro documentPath è nullriferimento null (Nothing in Visual Basic), vuoto, oppure composto unicamente da spazi vuoti.
FileNotFoundException

Il file specificato in documentPath non esiste.
UnknownCustomizationFileException

L'estensione di file specificata da documentPath non è supportata dal Runtime di Visual Studio Tools per Office.

Note

Le soluzioni Office create in diverse versioni di Visual Studio utilizzano diverse versioni di Runtime di Visual Studio Tools per Office. In ciascuna versione del runtime viene fornita una diversa versione della classe ServerDocument progettata per l'utilizzo con le soluzioni relative a tale versione del runtime. Questa versione della classe ServerDocument può essere utilizzata con soluzioni create tramite Visual Studio 2010 e con soluzioni di Microsoft Office 2007 create tramite Visual Studio 2008.

Nella tabella riportata di seguito viene specificato il significato dei valori restituiti per questo metodo.

Valore restituito

Oggetto di descrizione

0

Il documento non include una personalizzazione.

1

Il documento include una personalizzazione creata mediante Visual Studio Tools per Office, versione 2003.

2

Il documento dispone di una personalizzazione creata utilizzando Visual Studio 2005 Tools per Office Second Edition Runtime. Questa è la versione del runtime utilizzato dalle personalizzazioni per Microsoft Office 2003 in Visual Studio 2005 Tools per Office e Visual Studio 2008.

3

Il documento dispone di una personalizzazione creata con Visual Studio 2010 Tools per Office Runtime o Visual Studio Tools per Microsoft Office System (versione 3.0 Runtime). La versione 3.0 del runtime viene utilizzata dalle personalizzazioni per Microsoft Office System 2007 in Visual Studio 2008.

Per ulteriori informazioni sulle varie versioni del Runtime di Visual Studio Tools per Office, vedere Cenni preliminari su Visual Studio Tools per Office Runtime.

Esempi

Nell'esempio di codice seguente viene creato un nuovo oggetto ServerDocument che carica un documento specificato e quindi visualizza l'URL del manifesto di distribuzione per la personalizzazione associata al documento. Prima di creare l'oggetto, il metodo GetCustomizationVersion viene utilizzato dal codice per verificare che la personalizzazione sia stata creata utilizzando Visual Studio 2010 Tools per Office Runtime.

Per questo esempio sono necessari i seguenti requisiti:

  • Progetto di applicazione console o qualche altro progetto non-Office.

  • Riferimenti ai seguenti assembly:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.dll (se il progetto è destinato a .NET Framework 4).

      oppure

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll e Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (se il progetto è destinato a .NET Framework 3.5).

  • Istruzioni Imports (per Visual Basic) o using (per C#) per gli spazi dei nomi Microsoft.VisualStudio.Tools.Applications e Microsoft.VisualStudio.Tools.Applications.Runtime all'inizio del file di codice

Private Sub CreateServerDocumentFromPath(ByVal documentPath As String)
    Dim runtimeVersion As Integer = 0
    Dim serverDocument1 As ServerDocument = Nothing

    Try
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath)
        If runtimeVersion = 3 Then
            serverDocument1 = New ServerDocument(documentPath)
            MessageBox.Show("The URL of the deployment manifest is: " & vbLf & _
                serverDocument1.DeploymentManifestUrl.ToString())
        End If

    Catch ex As System.IO.FileNotFoundException
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.")
    Catch ex As UnknownCustomizationFileException
        System.Windows.Forms.MessageBox.Show("The specified document has a file " & _
            "extension that is not supported by Visual Studio Tools for Office.")
    Finally
        If Not (serverDocument1 Is Nothing) Then
            serverDocument1.Close()
        End If
    End Try
End Sub

private void CreateServerDocumentFromPath(string documentPath)
{
    int runtimeVersion = 0;
    ServerDocument serverDocument1 = null;

    try
    {
        runtimeVersion = ServerDocument.GetCustomizationVersion(documentPath);
        if (runtimeVersion == 3)
        {
            serverDocument1 = new ServerDocument(documentPath);
            MessageBox.Show("The URL of the deployment manifest is: \n" +
                serverDocument1.DeploymentManifestUrl.ToString());
        }
    }
    catch (System.IO.FileNotFoundException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document does not exist.");
    }
    catch (UnknownCustomizationFileException)
    {
        System.Windows.Forms.MessageBox.Show("The specified document has a file " +
            "extension that is not supported by Visual Studio Tools for Office.");
    }
    finally
    {
        if (serverDocument1 != null)
            serverDocument1.Close();
    }
}

Sicurezza di .NET Framework

Vedere anche

Riferimenti

ServerDocument Classe

Spazio dei nomi Microsoft.VisualStudio.Tools.Applications

Altre risorse

Gestione dei documenti di un server utilizzando la classe ServerDocument