Viewer

Viewer (namespace Doconut) es el punto de entrada público para abrir documentos desde páginas Razor, controladores MVC, componentes Blazor o APIs mínimas. Está sellado, registrado como un servicio transitorio por AddDoconut(), y se resuelve mediante inyección de constructor — nunca lo construyas directamente.

Viewer no mantiene estado por solicitud y deliberadamente no implementa IDisposable: las sesiones de documento viven independientemente en la caché de sesión, por lo que disponer del servicio nunca podría cerrar un documento abierto (ver Conceptos básicos → Cómo funciona el Viewer).

OpenDocumentAsync

Abre un documento y devuelve el token de sesión que el widget cliente usa para todas las solicitudes posteriores.

// Apertura simple
string token = await viewer.OpenDocumentAsync(path);

// Con configuración y opciones por formato
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Desde una carga
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Excepciones a manejar:

• LicenseException — una licencia encontrada es rechazada (el mensaje lleva la razón del rechazo), o el formato necesita una capacidad de complemento que ya no está concedida. La expiración del calendario sin mensaje de rechazo degrada a renderizado con marca de agua en lugar de lanzar una excepción.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — el contenido del archivo está corrupto o no coincide con su extensión.

CloseDocument

void CloseDocument(string token)

Elimina la sesión de la caché (disponiendo del motor de documento inmediatamente), borra el marcador de seguridad y revoca la concesión de acceso. Opcional — la expiración deslizante realiza la misma limpieza — pero se recomienda para documentos grandes.

GetPageCount

int GetPageCount(string token)

Número total de páginas de la sesión abierta. Lanza una excepción si el token es desconocido o ha expirado.

DocOptions

Opciones por apertura, independientes del formato (namespace Doconut):

La clase también expone propiedades especializadas que están intencionalmente fuera del flujo de visualización normal de un solo host:

Marca de agua personalizada

DocOptions.Watermark usa seis campos separados por tildes. Un ^ opcional al inicio solicita el diseño de todas las esquinas:

^Text~Color~FontSize~FontName~Opacity~Angle

string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });

El analizador espera exactamente seis campos después del ^ opcional. Una definición no válida se reemplaza por el fallback visible Invalid Watermark del SDK en lugar de desaparecer silenciosamente.

Decisión de licencia

La misma decisión se aplica a las imágenes de página servidas y a las exportaciones de anotaciones. La salida GIF animada se marca fotograma a fotograma. Por lo tanto, una marca de agua personalizada es una característica de aplicación con licencia, no una forma de reemplazar o suprimir la marca de agua de evaluación.

API de anotaciones

Carga y exportación de anotaciones del lado del servidor. El tutorial completo está en Guías → Anotaciones; la superficie es:

Metadatos DICOM

Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)

Devuelve metadatos de etiquetas DICOM para sesiones abiertas a través del plugin DICOM; null para documentos no DICOM.

Ayudantes de recursos — ReferenceCss / ReferenceScripts

Emita las etiquetas <link>/<script> para los recursos incrustados servidos por UseDoconutResources(), en el orden de dependencia correcto. Los paquetes para funciones restringidas por licencia, como búsqueda y anotación, se emiten solo cuando la licencia las habilita, manteniendo la interfaz del cliente coherente con el comportamiento del servidor.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + visor + búsqueda + anotación
string ReferenceScripts(ScriptConfig? config = null)

CssConfig flags: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (restringido por búsqueda), IncludeAnnotationCss (restringido por anotación).

ScriptConfig flags: IncludeJQuery (requerido por todos los demás), IncludeBootstrap, IncludeViewerScripts (núcleo: docViewer.js + divisor + enlaces), IncludeSearchScripts y IncludeSearchBar (restringido por búsqueda), IncludeAnnotationScripts y IncludeAnnotationBar (restringido por anotación).

@inject Doconut.Viewer Viewer

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

GetWorksheetNames

IReadOnlyList<string> GetWorksheetNames(string token)

Devuelve los nombres de las hojas de cálculo de una hoja de cálculo abierta, en el orden del libro, o una lista vacía cuando el documento abierto no es una hoja de cálculo.

Añadido en 26.9.0.