Inicio rápido

Renderiza tu primer documento en minutos

Esta guía lleva una aplicación ASP.NET Core desde un Program.cs vacío hasta un documento renderizado en el navegador: registro del servidor, el paquete completo del Viewer (barra de herramientas del Viewer, montaje del Viewer y cintas opcionales de Búsqueda/Anotación), referencias de recursos, inicialización del cliente, apertura del documento y ejecución.

Configuración del servidor

AddDoconut() registra los servicios; UseDoconutResources() y UseDoconut() conectan el middleware. La llamada a los recursos debe ser la primera. UseDoconut() responde a cada solicitud que le llega, así que móntalo en su propia rama con app.Map. Las llamadas de sesión también son necesarias — la seguridad de documentos predeterminada de Doconut valida cada solicitud de página contra el estado de sesión de ASP.NET. El estado de sesión necesita una caché: AddDistributedMemoryCache() proporciona una. Una aplicación MVC o Razor Pages ya la registra, pero una aplicación minimal-API no lo hace, y sin ella la aplicación se detiene al iniciar con Unable to resolve service for type 'IDistributedCache'. ¿Ya registraste Doconut durante la Instalación? Avanza a la siguiente sección.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // el estado de sesión necesita una caché (MVC/Razor Pages ya añaden una)
builder.Services.AddSession(); // la seguridad de documentos de Doconut depende del estado de sesión de ASP.NET

app.UseSession();          // llame a UseSession() antes de UseDoconut()
app.UseDoconutResources(); // debe registrarse antes de UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Para una estructura de rutas estilo producción, asigna el middleware de documentos a una rama explícita y mantén alineadas las cuatro configuraciones de ruta:

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
    options.MiddlewarePath = "/doconut";
    options.ResourcesPath = "/doconut-res";
    options.UnsafeMode = false;
});
builder.Services.AddDistributedMemoryCache();
builder.Services.AddSession();

app.UseRouting();
app.UseSession();
app.UseDoconutResources();
app.Map("/doconut", branch => branch.UseDoconut());

MiddlewarePath es un valor de coordinación; no asigna una rama de ASP.NET Core por sí mismo. En este ejemplo el host asigna /doconut, por lo que el cliente usa BasePath: 'doconut'. ResourcesPath sirve el paquete incrustado en /doconut-res, y la ruta del recurso de imagen del widget es por tanto ResPath: 'doconut-res/images'. Escríbelas ambas sin una barra inicial: el visor agrega una por sí mismo, así que '/doconut' se convertiría en //doconut/DocImage.axd, que el navegador interpreta como una solicitud a un host llamado doconut, y el visor falla con "The viewer handler could not be reached".

Añadir el visor a una página

El Viewer es el núcleo requerido de la página. Su superficie de renderizado utiliza dos div anidados:

html
<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

Trata la barra de herramientas, los montajes de módulos y la superficie del Viewer como una única composición de página. Búsqueda y Anotación inyectan sus cintas incrustadas en montajes opcionales, pero esos módulos nunca son independientes: siempre se adjuntan al Viewer en la misma página. Usa este orden:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Botones de navegación, zoom, búsqueda y anotación de Viewer -->
</nav>

<div id="searchBarMount"></div>
<div id="annBarMount"></div>

<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

Referenciar los recursos del visor

En una vista Razor, el servicio inyectado Viewer emite las etiquetas <link> y <script> del visor en orden de dependencia — el widget es un plugin de jQuery, por lo que jQuery debe cargarse antes de los scripts del visor:

html
@inject Doconut.Viewer Viewer

@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss = true,
    IncludeViewerCss    = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery        = true,
    IncludeBootstrap     = true,
    IncludeViewerScripts = true
}))

Para el paquete completo del Viewer, solicita los recursos del Viewer y del módulo juntos:

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss  = true,
    IncludeViewerCss     = true,
    IncludeSearchCss     = true,
    IncludeAnnotationCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery             = true,
    IncludeBootstrap         = true,
    IncludeViewerScripts     = true,
    IncludeSearchScripts     = true,
    IncludeSearchBar         = true,
    IncludeAnnotationScripts = true,
    IncludeAnnotationBar     = true
}))

IncludeViewerCss y IncludeViewerScripts son los indicadores centrales obligatorios. Nunca publiques un ejemplo de cinta de Búsqueda o Anotación sin ellos, el montaje del Viewer y una instancia docViewer. ReferenceCss y ReferenceScripts omiten los recursos de un módulo opcional cuando la licencia actual no concede esa capacidad; el Viewer central aún se inicia.

Inicializar el visor

El widget del lado del cliente es un plugin de jQuery. Este es un conjunto mínimo de opciones reales de inicialización (no pseudocódigo):

javascript
let searchBar = null;
let annBar = null;

const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad:   false,
    pageZoom:   100,
    FitType:    'width',
    BasePath:   'doconut',             // sin '/' inicial
    ResPath:    'doconut-res/images',  // sin '/' inicial
    onViewerReady: function () {
        // las páginas están visibles; es seguro ocultar un spinner de carga aquí
    },
    // Reenviar los eventos del ciclo de vida de la anotación al ribbon incrustado cuando esté presente.
    onAnnLoaded:    () => annBar?.handleAnnLoaded(),
    onAnnSaved:     () => annBar?.handleAnnSaved(),
    onAnnSaveError: () => annBar?.handleAnnSaveError(),
    onAnnClosed:    () => annBar?.handleAnnClosed(),
    onError: function (message) {
        console.error('Doconut viewer error:', message);
    }
});

La capitalización de las opciones es realmente mixta — showThumbs, autoLoad y pageZoom están en camelCase, pero FitType, BasePath y ResPath están en PascalCase. No hay una regla consistente; si se usa la capitalización incorrecta la opción se ignora silenciosamente (el widget vuelve a su valor predeterminado en lugar de lanzar un error).

Cuatro detalles más fallan sin un mensaje de error:

  • BasePath no tiene barra inicial. 'doconut' solicita /doconut/DocImage.axd; '/doconut' produce //doconut/DocImage.axd, que el navegador interpreta como una solicitud a otro host.
  • ResPath: 'doconut-res/images' — los íconos están una carpeta debajo de la raíz de recursos. Con 'doconut-res', cada ícono devuelve 404: no hay glifos de barra de herramientas ni indicador de carga, mientras que el documento sigue renderizándose. Una barra inicial lo rompe de la misma manera que BasePath.
  • Los callbacks son opciones. onViewerReady, onError y el resto van en el objeto pasado a docViewer(...). Una función global nombrada como el visor, como ctlDoc_ViewerReady, nunca se llama.
  • Mantén el visor, luego llama a View por separado. docViewer(...) devuelve el objeto con Zoom, Next y FitType; View(...) devuelve otra cosa. var objViewer = $('#div_ctlDoc').docViewer({...}).View(token) renderiza el documento, luego falla con objViewer.Zoom is not a function al hacer clic en la primera barra de herramientas.

Ensamblar el paquete completo del Visor

Una página completa del visor instala las siguientes partes juntas:

Parte del paqueteRequisitoCómo se conecta
Recursos del visor, montaje, y objViewerRequeridoRenderizador central de documentos
Barra de herramientas del visorRequerido para una página completaMarcado del host; los botones llaman al mismo objViewer
Cinta de búsquedaOpcional, módulo licenciadodoconutSearchBar(...).attach(objViewer)
Cinta de anotaciónOpcional, módulo licenciadodoconutAnnotationBar(...).attach(objViewer)

Aunque la barra de herramientas principal del Visor es marcado del host, se instala junto al Visor y nunca debe documentarse como un control aislado. Esto mantiene su diseño, etiquetas, íconos y reglas de autorización bajo el control de tu aplicación mientras cada botón controla la misma instancia del Visor:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <button type="button" onclick="objViewer.GotoPage(1)">First</button>
    <button type="button" onclick="objViewer.Next(false)">Previous</button>
    <button type="button" onclick="objViewer.Next(true)">Next</button>
    <button type="button" onclick="objViewer.GotoPage(objViewer.TotalPages())">Last</button>
    <button type="button" onclick="objViewer.Zoom(false)">Zoom out</button>
    <button type="button" onclick="objViewer.Zoom(true)">Zoom in</button>
    <button type="button" onclick="objViewer.FitType('width')">Fit width</button>
    <button type="button" onclick="objViewer.FitType('height')">Fit height</button>
    <button type="button" id="openSearch">Search</button>
    <button type="button" id="openAnnotations">Annotations</button>
</nav>

Los ayudantes de rotación, miniatura, impresión, pantalla completa, diseño y estado de botones pertenecen a tu propio script de barra de herramientas, que llama al mismo objViewer. Cárgalo después de Viewer.ReferenceScripts(...), y mantenlo junto con su marcado <nav id="toolbar">.

Mantén este orden de inicialización:

  1. Genera CSS para el Visor y los módulos licenciados.
  2. Renderiza la barra de herramientas del Visor, los montajes de Búsqueda/Anotación y el montaje del Visor juntos.
  3. Genera scripts para el Visor y los módulos licenciados.
  4. Carga el script de ayuda de barra de herramientas propio de la aplicación host.
  5. Inicializa docViewer y conserva el objViewer resultante.
  6. Inicializa cada cinta de Búsqueda o Anotación licenciada.
  7. Llama a attach(objViewer) en cada cinta.
  8. Abre el documento y conserva su token para solicitudes del Visor y de los módulos.

En una implementación distribuida, el valor de solicitud adicional access y la configuración de reintentos de renderizado asíncrono pertenecen al transporte; no cambian cómo se ensamblan el Visor, la barra de herramientas o las cintas.

Los guardas del lado del servidor son importantes: cuando una capacidad opcional no está disponible, su script no se genera, por lo que su función de plugin de jQuery no existe.

html
<script>
    let token = '';

    const refitViewer = () =>
        requestAnimationFrame(() => objViewer.Refit());

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    searchBar.attach(objViewer);
        </text>
    }

    @if (Viewer.IsAnnotationEnabled)
    {
        <text>
    annBar = $('#annBarMount').doconutAnnotationBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    annBar.attach(objViewer);
        </text>
    }

    document.getElementById('openSearch').addEventListener('click', () => {
        if (!searchBar) return;
        searchBar.isOpen() ? searchBar.close() : searchBar.open();
    });

    document.getElementById('openAnnotations').addEventListener('click', () => {
        if (!annBar) return;
        annBar.isOpen() ? annBar.close() : annBar.open();
    });
</script>

Ambos componentes incrustados generan su propio DOM de cinta. Búsqueda contiene los grupos Encontrar, Opciones y Resultados. Anotación contiene sus herramientas de autoría, controles de estilo, acciones de guardado y acciones opcionales de exportación/imagen. Las barras exponen open(), close(), reset() y isOpen(); siempre llama a attach(objViewer) una vez después de crearlas.

El ejemplo anterior omite callbacks opcionales del host y los puntos finales de exportación/imagen de Anotación para mantener el inicio al mínimo. Consulta Búsqueda y Anotaciones para la configuración completa específica de la funcionalidad, o Temas personalizados para estilizar o reemplazar la barra de herramientas del Visor propiedad del host.

Abrir un documento

El lado del servidor es un único punto final: el servicio inyectado Viewer abre el documento y devuelve un token de sesión.

csharp
app.MapPost("/api/open", async (Viewer viewer) =>
{
    // El token es opaco — pásalo al widget, nunca lo registres ni lo persistas.
    string token = await viewer.OpenDocumentAsync("wwwroot/files/Sample.pdf");
    return Results.Ok(new { token });
});

El cliente recupera ese token y lo entrega al widget con objViewer.View(token):

javascript
fetch('/api/open', { method: 'POST' })
    .then(resp => resp.json())
    .then(data => {
        token = data.token;
        objViewer.View(token);
    });

Cerrar el documento

Llame a objViewer.Close(true) cuando el usuario abandona el visor o abre un documento de reemplazo: limpia el widget y envía una solicitud de cierre al servidor. objViewer.Close() sin argumento solo limpia el widget. En flujos de trabajo impulsados por el servidor, viewer.CloseDocument(token) elimina inmediatamente la sesión en caché, dispone del motor de renderizado, elimina su marcador de seguridad y revoca el token. La expiración deslizante eventualmente realiza la misma limpieza, pero se recomienda cerrar explícitamente para documentos grandes.

El flujo de solicitud completado es:

text
AddDoconut + middleware
    -> render CSS/scripts and mount div
    -> initialize docViewer
    -> OpenDocumentAsync
    -> return opaque token
    -> objViewer.View(token)
    -> page/search/annotation requests
    -> Close / CloseDocument

Trate el token como una credencial portadora: nunca lo registre, nunca lo persista, entréguelo solo al widget. Identifica una sesión de documento activa en el servidor y deja de funcionar cuando esa sesión expira — vuelva a abrir el documento para obtener uno nuevo.

Ejecutar

Coloque un PDF en wwwroot/files/Sample.pdf, ejecute dotnet run y abra la página que aloja el widget. La primera página se renderiza en el visor, con un panel de miniaturas a la izquierda. Si no lo hace, consulte Solución de problemas.

Lo que obtienes sin una licencia

Una licencia faltante no genera una excepción. El visor se renderiza normalmente, pero cada página lleva una marca de agua de evaluación. Consulte Configuración de licencia para saber cómo Doconut encuentra una licencia y qué cambia una vez que lo hace.

¿Fue útil esta página?