Administrar documentos en un servidor mediante la clase ServerDocument

Puede utilizar la clase ServerDocument en el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office para administrar varios aspectos de la personalización de nivel de documento, aun cuando Microsoft Office Word y Microsoft Office Excel no estén instalados. Puede realizar las tareas siguientes:

  • Tener acceso a datos en la caché de datos de un documento o libro o modificarlos. Para obtener más información, vea Trabajar en el documento con datos almacenados en la memoria caché.

  • Administrar el ensamblado de personalización asociado a un documento. Para obtener más información, vea Administrar la personalización de documentos.

Se aplica a: la información de este tema se aplica a los proyectos de nivel de documento para las siguientes aplicaciones: Excel 2007 y Excel 2010; Word 2007 y Word 2010. Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto de Office.

Descripción de la clase ServerDocument

La clase ServerDocument está diseñada para usarla en los equipos que no tienen Office instalado. Por tanto, esta clase se utiliza habitualmente en aplicaciones que no se integran con Microsoft Office, como proyectos de consola o proyectos de Windows Forms, en lugar de proyectos de Office.

Hay dos versiones diferentes de la clase ServerDocument en Visual Studio 2010 Tools para Office Runtime. La versión que debe utilizar depende de la versión de .NET Framework de destino de la aplicación en la que desee utilizar la clase:

  • Para las aplicaciones destinadas a .NET Framework 4, utilice la clase Microsoft.VisualStudio.Tools.Applications.ServerDocument en el ensamblado Microsoft.VisualStudio.Tools.Applications.ServerDocument.dll. 

  • Para las aplicaciones destinadas a .NET Framework 3.5, use la clase Microsoft.VisualStudio.Tools.Applications.ServerDocument en el ensamblado Microsoft.VisualStudio.Tools.Applications.ServerDocument.v10.0.dll.

Ambas versiones de la clase ServerDocument se pueden utilizar para las personalizaciones de nivel de documento que se crearon con Visual Studio 2010 o las personalizaciones de nivel de documento para Excel 2007 y Word 2007 que se crearon con Visual Studio 2008.

Para obtener más información sobre el Visual Studio 2010 Tools para Office Runtime y las extensiones de Office para .NET Framework, vea Información general sobre el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.

Nota

Si tiene una aplicación heredada que utilice la clase ServerDocument en Visual Studio Tools para Office system (versión 3.0 Runtime), Visual Studio Tools para Office system (versión 3.0 Runtime) debe estar instalado en los equipos que ejecuten la aplicación. Visual Studio 2010 Tools para Office Runtime no puede ejecutar estas aplicaciones.

Trabajar en el documento con datos almacenados en la memoria caché

La clase ServerDocument proporciona miembros que se pueden usar para trabajar con la memoria caché de datos en documentos personalizados. Para obtener más información sobre los datos en caché, vea Almacenar datos en caché y Acceso a datos de documentos en el servidor.

En la tabla siguiente se enumeran los miembros que puede usar para trabajar con datos en caché.

Tarea

Miembro que se utiliza

Determinar si un documento tiene una caché de datos.

Método IsCacheEnabled.

Tener acceso a los datos en caché en un documento.

Para obtener más información, vea Acceso a datos de documentos en el servidor.

Propiedad CachedData.

Administrar la personalización de documentos

Puede usar miembros de la clase ServerDocument para administrar el ensamblado de personalización asociado a un documento. Por ejemplo, puede quitar mediante programación la personalización de un documento de forma que este ya no forme parte de una personalización.

En la tabla siguiente se enumeran los miembros que puede usar para administrar el ensamblado de personalización.

Tarea

Miembro que se utiliza

Determinar si un documento forma parte de una personalización de nivel de documento.

Método GetCustomizationVersion.

Asociar mediante programación una personalización a un documento en tiempo de ejecución.

Para obtener más información, vea Cómo: Adjuntar extensiones de código administrado a documentos.

Uno de los métodos AddCustomization.

Quitar mediante programación una personalización de un documento en tiempo de ejecución.

Para obtener más información, vea Cómo: Quitar extensiones de código administrado de documentos.

Método RemoveCustomization.

Obtener la dirección URL del manifiesto de implementación asociado con el documento.

Propiedad DeploymentManifestUrl.

Vea también

Tareas

Cómo: Adjuntar extensiones de código administrado a documentos

Cómo: Quitar extensiones de código administrado de documentos

Referencia

Microsoft.VisualStudio.Tools.Applications.ServerDocument

Conceptos

Información general sobre el Motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office

Almacenar datos en caché