AddCustomization (Método) (String, String, String, String, Boolean) (2003 System)

Artículo
08/23/2008

Actualización: noviembre 2007

Agrega un nuevo manifiesto de aplicación al documento especificado.

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

Sintaxis

'Declaración
Public Shared Function AddCustomization ( _
    documentPath As String, _
    assemblyName As String, _
    deploymentManifestPath As String, _
    applicationVersion As String, _
    makePathsRelative As Boolean _
) As String
'Uso
Dim documentPath As String
Dim assemblyName As String
Dim deploymentManifestPath As String
Dim applicationVersion As String
Dim makePathsRelative As Boolean
Dim returnValue As String

returnValue = ServerDocument.AddCustomization(documentPath, _
    assemblyName, deploymentManifestPath, _
    applicationVersion, makePathsRelative)

public static string AddCustomization(
    string documentPath,
    string assemblyName,
    string deploymentManifestPath,
    string applicationVersion,
    bool makePathsRelative
)

Parámetros

documentPath
Tipo: System. . :: .String

Ruta de acceso del documento que desea personalizar.

assemblyName
Tipo: System. . :: .String

Ruta de acceso al ensamblado de soluciones que se va a asociar al documento.

deploymentManifestPath
Tipo: System. . :: .String

Dirección URL del manifiesto de implementación para la solución.

applicationVersion
Tipo: System. . :: .String

Versión del manifiesto de aplicación, que especifica la versión principal, la versión secundaria, el número de versión de compilación y número de revisión separados por puntos (.).

makePathsRelative
Tipo: System. . :: .Boolean

Es true para hacer todas las rutas de acceso del manifiesto de aplicación relativas a la posición del documento; es false para hacer todas las rutas de acceso absolutas.

Valor devuelto

Tipo: System. . :: .String

Cadena XML que incluye el contenido del manifiesto de aplicación nuevo.

Excepciones

Excepción	Condición
ArgumentNullException	El parámetro documentPath, assemblyName o applicationVersion es null Nothing nullptr referencia null (Nothing en Visual Basic) o está vacío.
FileNotFoundException	El parámetro documentPath o assemblyName hace referencia un archivo que no existe.
InvalidOperationException	El documento especificado por documentPath ya tiene una personalización de Visual Studio Tools para Office.
ArgumentException	El parámetro applicationVersion no tiene el formato válido.
COMException	El documento especificado por documentPath no tiene un control de almacenamiento en tiempo de ejecución y está en un equipo que no tiene instalada la aplicación de Microsoft Office apropiada para el documento.

Comentarios

El método AddCustomization(String, String, String, String, Boolean) agrega entradas al manifiesto de aplicación que indican el ensamblado de la solución especificada, el manifiesto de implementación y la versión del manifiesto de aplicación. Para obtener más información sobre los manifiestos de implementación y de aplicación, vea Manifiestos de implementación y aplicación en soluciones de Office.

Este método agrega un Control de almacenamiento en tiempo de ejecución al documento si éste no tiene ninguno. Este proceso requiere que el documento esté en un equipo que tenga instalado Microsoft Office Word (para documentos de Word) o Microsoft Office Excel (para libros de Excel). Para obtener más información sobre el Control de almacenamiento en tiempo de ejecución, vea Información general acerca del control de almacenamiento del motor en tiempo de ejecución.

Si el documento especificado no contiene el control que el ensamblado de la solución espera que tenga, el método AddCustomization(String, String, String, String, Boolean) funcionará correctamente, pero el ensamblado no se cargará cuando el usuario abra el documento.

El parámetro applicationVersion debe ser una cadena que especifique la versión principal, la versión secundaria, el número de versión de compilación y el número de revisión separados por puntos (.). Por ejemplo, 1.0.0 no es válido, pero 1.0.0.1 sí es válido.

Ejemplos

En el siguiente ejemplo de código se utiliza el método AddCustomization(String, String, String, String, Boolean) para agregar un manifiesto de aplicación nuevo al documento especificado, utilizando el ensamblado especificado y el manifiesto de implementación. En este ejemplo se necesita una referencia al ensamblado Microsoft.VisualStudio.Tools.Applications.Runtime y una instrucción Imports (para Visual Basic) o using (para C#) para el espacio de nombres Microsoft.VisualStudio.Tools.Applications.Runtime al principio del archivo de código.

Private Sub AddNewCustomization(ByVal fileName As String)
    If Not ServerDocument.IsCustomized(fileName) Then
        Dim assemblyName As String = "ExcelApplication1.dll"
        Dim deploymentManifestPath As String = _
            "\\servername\deployshare\ExcelApplication1.application"
        Dim applicationVersion As String = "1.0.0.1"
        Dim newManifest As String = ServerDocument.AddCustomization( _
            fileName, assemblyName, deploymentManifestPath, _
            applicationVersion, False)
        MsgBox("The document has been customized.")
    Else
        MsgBox("The specified document is already " + _
            "customized.")
    End If
End Sub

private void AddNewCustomization(string fileName)
{
    if (!ServerDocument.IsCustomized(fileName))
    {
        string assemblyName = "ExcelApplication1.dll";
        string deploymentManifestPath =
            @"\\servername\deployshare\ExcelApplication1.application";
        string applicationVersion = "1.0.0.1";

        string newManifest = ServerDocument.AddCustomization(
            fileName, assemblyName, deploymentManifestPath, 
            applicationVersion, false);

        MessageBox.Show("The document has been customized.");
    }
    else
    {
        MessageBox.Show("The specified document is already " +
            "customized.");
    }
}

Permisos

Plena confianza para el llamador inmediato. Un código de confianza parcial no puede utilizar este miembro. Para obtener más información, vea Utilizar bibliotecas de código que no es de plena confianza.