Administrar documentos en un servidor mediante la clase ServerDocument
Actualización: noviembre 2007
Se aplica a |
|---|
La información de este tema sólo se aplica a los proyectos y versiones especificados de Visual Studio Tools para Office de Microsoft Office. Tipo de proyecto
Versión de Microsoft Office
Para obtener más información, vea Características disponibles por aplicación y tipo de proyecto. |
Puede utilizar la clase ServerDocument para administrar varios aspectos de personalización en el 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 la personalización de Visual Studio Tools para Office para un documento. Para obtener más información, vea Administrar la personalización de documentos.
Descripción de la clase ServerDocument
Hay dos versiones diferentes de la clase ServerDocument, una para cada versión de Visual Studio Tools para Office en tiempo de ejecución. Debe usar la que corresponda a la versión de la solución de Microsoft Office:
Utilice la clase Microsoft.VisualStudio.Tools.Applications.ServerDocument con personalizaciones para Excel 2007 y Word 2007. Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime) proporciona esta clase.
Utilice la clase Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument con personalizaciones para Excel 2003 y Word 2003. Visual Studio 2005 Tools para Office Second Edition runtime proporciona esta clase.
Aunque las dos versiones de la clase ServerDocument comparten gran parte de la misma funcionalidad, existen diferencias en los espacios de nombres, los ensamblados y los miembros. Para obtener más información, vea Diferencias de ServerDocument.
La clase ServerDocument está diseñada para funcionar en los equipos que no tienen Microsoft Office instalados. Por tanto, esta clase se utiliza habitualmente en proyectos que no se integran con Microsoft Office, como proyectos de consola o proyectos de formularios Windows Forms, en lugar de proyectos de Visual Studio Tools para Office.
Para obtener información sobre las diferentes versiones del motor en tiempo de ejecución de Visual Studio Tools para Office, vea Información general sobre el motor en tiempo de ejecución de Microsoft Visual Studio Tools para Office.
Trabajar en el documento con datos almacenados en la memoria caché
Ambas versiones de la clase ServerDocument proporcionan miembros que puede usar para trabajar con la 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 |
Proyectos de Excel 2007 y Word 2007 |
Proyectos de Excel 2003 y Word 2003 |
|---|---|---|
Determinar si un documento tiene una caché de datos de Visual Studio Tools para Office. |
Método IsCacheEnabled en Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime). |
Método IsCacheEnabled en Visual Studio 2005 Tools para Office Second Edition runtime. |
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 en Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime). |
Propiedad CachedData en Visual Studio 2005 Tools para Office Second Edition runtime. |
Administrar la personalización de documentos
Puede utilizar miembros de la clase ServerDocument para administrar la personalización de Visual Studio Tools para Office para un documento. Por ejemplo, puede quitar mediante programación la personalización de un documento de forma que éste ya no forme parte de una personalización de Visual Studio Tools para Office.
En la tabla siguiente se enumeran los miembros que puede usar para administrar el ensamblado de personalización.
Tarea |
Proyectos de Excel 2007 y Word 2007 |
Proyectos de Excel 2003 y Word 2003 |
|---|---|---|
Determinar si un documento tiene una personalización de Visual Studio Tools para Office. |
Método GetCustomizationVersion en Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime). |
Método IsCustomized en Visual Studio 2005 Tools para Office Second Edition runtime. |
Asociar mediante programación una personalización a un documento en tiempo de ejecución. Para obtener más información, vea: |
Uno de los métodos AddCustomization de Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime). |
Uno de los métodos AddCustomization de Visual Studio 2005 Tools para Office Second Edition runtime. |
Quitar mediante programación una personalización de un documento en tiempo de ejecución. Para obtener más información, vea: |
Método RemoveCustomization en Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime). |
Método RemoveCustomization en Visual Studio 2005 Tools para Office Second Edition runtime. |
Obtener la dirección URL del manifiesto de implementación asociado con el documento. |
Propiedad DeploymentManifestUrl en Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime). |
Visual Studio 2005 Tools para Office Second Edition runtime no incluye esta propiedad, ya que el manifiesto de implementación es opcional en soluciones en el nivel de documento para Excel 2003 y Word 2003; en su lugar, estas soluciones siempre tienen un manifiesto de aplicación incrustado. |
Tener acceso al manifiesto de aplicación incrustado en el documento. |
Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime) no incluye esta propiedad, porque las soluciones en el nivel de documento para Excel 2007 y Word 2007 no tienen un manifiesto de aplicación incrustado. |
Propiedad AppManifest en Visual Studio 2005 Tools para Office Second Edition runtime. |
Diferencias de ServerDocument
Las dos versiones de la clase ServerDocument y las clases relacionadas que proporcionan el modelo de objetos para los datos en caché (como CachedDataHostItem y CachedDataItem) se definen en ensamblados y espacios de nombres diferentes. Además, algunos miembros y sobrecargas de método sólo se proporcionan en una versión de la clase. Debe ser consciente de estas diferencias en los escenarios siguientes:
Desea migrar código que utiliza la clase ServerDocument en Visual Studio 2005 Tools para Office Second Edition runtime para que funcione con soluciones de Excel 2007 y Word 2007.
Desea utilizar la clase ServerDocument en código que funcione con personalizaciones en el nivel de documento para Microsoft Office System 2003 y 2007.
Para obtener un ejemplo donde se muestra cómo se utilizan ambas versiones de la clase ServerDocument en el mismo código, vea Cómo: Escribir código que utilice ambas versiones de la clase ServerDocument.
Diferencias de espacio de nombres y ensamblado
En la tabla siguiente se enumeran las diferencias de espacio de nombres y ensamblado en ambas versiones de la clase ServerDocument y las clases que proporcionan el modelo de objetos para los datos en caché.
Versión del motor en tiempo de ejecución |
Namespace |
Assembly |
|---|---|---|
Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime) |
Microsoft.VisualStudio.Tools.Applications.ServerDocument.v9.0.dll |
|
Visual Studio 2005 Tools para Office Second Edition runtime |
Microsoft.VisualStudio.Tools.Applications.Runtime.dll |
Diferencias de miembro
Los miembros siguientes sólo se proporcionan en la clase ServerDocument en Microsoft Visual Studio Tools para Microsoft Office System (versión 3.0 Runtime):
Los miembros siguientes sólo se proporcionan en la clase ServerDocument en Visual Studio 2005 Tools para Office Second Edition runtime:
Vea también
Tareas
Cómo: Escribir código que utilice ambas versiones de la clase ServerDocument
Cómo: Asociar extensiones de código administrado a documentos (2007 System)
Cómo: Asociar extensiones de código administrado a documentos (2003 System)
Cómo: Quitar extensiones de código administrado de documentos (2007 System)
Cómo: Quitar extensiones de código administrado de documentos (2003 System)
Conceptos
Referencia
Microsoft.VisualStudio.Tools.Applications.ServerDocument
Microsoft.VisualStudio.Tools.Applications.Runtime.ServerDocument