Share via

ServerDocument.GetCustomizationVersion (Método)

  • Artículo

Devuelve la versión de Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office que se usó para crear la personalización asociada al documento especificado.

Espacio de nombres:  Microsoft.VisualStudio.Tools.Applications
Ensamblado:  Microsoft.VisualStudio.Tools.Applications.ServerDocument (en Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll)

Sintaxis

'Declaración
Public Shared Function GetCustomizationVersion ( _
    documentPath As String _
) As Integer

public static int GetCustomizationVersion(
    string documentPath
)

Parámetros

  • documentPath
    Tipo: System.String
    Ruta de acceso completa del documento que desea comprobar.

Valor devuelto

Tipo: System.Int32
Un número que especifica la versión de Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office que se usó para crear la personalización asociada.

Excepciones

Excepción Condición
ArgumentNullException

El parámetro documentPath es nullreferencia null (Nothing en Visual Basic) o está vacío, o se compone únicamente de caracteres de espacio en blanco.
FileNotFoundException

El archivo especificado por documentPath no existe.
UnknownCustomizationFileException

El archivo especificado por documentPath tiene una extensión de nombre de archivo que no es compatible con Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Comentarios

Las soluciones de Office creadas en versiones diferentes de Visual Studio usan versiones diferentes de Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office. Cada versión del motor en tiempo de ejecución proporciona una versión diferente de la clase ServerDocument que está diseñada para trabajar con soluciones creadas en esa versión del tiempo de ejecución. Esta versión de la clase ServerDocument se puede usar con soluciones que se crean mediante Visual Studio 2010 y con soluciones de Microsoft Office 2007 que se crean con Visual Studio 2008.

En la tabla siguiente se especifica el significado de los valores devueltos para este método.

Valor devuelto

Descripción

0

El documento no tiene una personalización.

1

El documento tiene una personalización que se creó con Visual Studio Tools para Office, versión 2003.

2

El documento tiene una personalización que se creó con Visual Studio 2005 Tools para Office Second Edition Runtime. Las personalizaciones para Microsoft Office 2003 en Visual Studio 2005 Tools para Office y Visual Studio 2008, usan esta versión de runtime.

3

El documento tiene una personalización que se creó con Visual Studio 2010 Tools para Office Runtime o Visual Studio Tools para Microsoft Office System (versión 3.0 del runtime). Las personalizaciones para Microsoft Office System 2007 en Visual Studio 2008 usan la versión 3.0 del runtime.

Para obtener más información sobre las diferentes versiones de Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office, vea Información general sobre el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Ejemplos

En el ejemplo de código siguiente se crea un nuevo objeto ServerDocument que carga un documento específico y, a continuación, muestra la dirección URL del manifiesto de implementación de la personalización adjunta al documento. Antes de crear el objeto, el código utiliza el método GetCustomizationVersion para comprobar que la personalización se creó utilizando Visual Studio 2010 Tools para Office Runtime.

Este ejemplo necesita:

  • Un proyecto de aplicación de consola o algún otro proyecto que no es de Office.

  • Referencias a los siguientes ensamblados:

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll y Microsoft.VisualStudio.Tools.Applications.Runtime.dll (si el destino del proyecto es .NET Framework 4).

      O bien

    • Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll and Microsoft.VisualStudio.Tools.Applications.Runtime.v9.0.dll (si el proyecto está dirigido a .NET Framework 3.5).

  • Instrucciones Imports (para Visual Basic) o using (para C#) para los espacios de nombres Microsoft.VisualStudio.Tools.Applications y Microsoft.VisualStudio.Tools.Applications.Runtime en la parte superior de su archivo de código.

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();
    }
}

Seguridad de .NET Framework

Vea también

Referencia

ServerDocument Clase

Microsoft.VisualStudio.Tools.Applications (Espacio de nombres)

Otros recursos

Administrar documentos en un servidor mediante la clase ServerDocument