Visor
La clase principal del visor de documentos
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 mediante AddDoconut(), y resuelto 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 sesiones, 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.
| Sobrecarga | Uso cuando |
|---|---|
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default) | Abrir desde disco con detección automática de formato y la configuración predeterminada del formato |
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default) | Necesitas opciones de renderizado por formato (PdfConfig, WordConfig, …) |
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default) | El documento no es un archivo en disco (carga, base de datos, blob). fileInfo debe contener la extensión correcta — ésta dirige la detección de formato |
// Simple open
string token = await viewer.OpenDocumentAsync(path);
// With per-format config and options
token = await viewer.OpenDocumentAsync(
path,
new PdfConfig { AllowSearch = true, AllowCopy = true },
new DocOptions { TimeOut = 30 });
// From an upload
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—El formato de documento '<extension>' no está soportado.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é (descargando el 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)Páginas totales 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):
| Tipo | Propiedad | Predeterminado | Descripción |
|---|---|---|---|
string | Password | "" | Contraseña para documentos protegidos (copiada automáticamente en la configuración del formato). |
int | ImageResolution | 0 | Obsoleto. Conservado solo por compatibilidad — establezca ImageResolution en la configuración del formato en su lugar. |
string | Watermark | "" | Texto de marca de agua personalizada dibujado en las páginas renderizadas. Cadena de formato: "^Text~Color~FontSize~FontName~Opacity~Angle", p. ej. "^Sample Copy~Red~24~Verdana~80~-45". |
int | TimeOut | 60 | Expiración deslizante de la sesión en minutos. |
bool | IsSecured | true | No se aplica actualmente — reservado. La vinculación de token se controla globalmente mediante DoconutOptions.UnsafeMode (ver Conceptos básicos → Sesiones y Seguridad). |
La clase también expone propiedades especializadas que están intencionalmente fuera del flujo normal de visualización de host único:
| Tipo | Propiedad | Predeterminado | Descripción |
|---|---|---|---|
bool | IsWebFarm | false | Marca la operación de apertura como un escenario de granja web. Úsese solo con la arquitectura correspondiente de almacenamiento/ sesión compartida. |
string | WebFarmPath | "" | Ruta compartida utilizada por el flujo de trabajo especializado de granja web. Vacía en el visor de host único normal. |
bool | EditMode | false | Reservado para el flujo de trabajo del Editor distribuido por separado; deje false para el visor estándar. |
Marca de agua personalizada
DocOptions.Watermark utiliza seis campos separados por tilde. Un ^ opcional al inicio solicita el diseño en todas las esquinas:
^Text~Color~FontSize~FontName~Opacity~Anglestring token = await viewer.OpenDocumentAsync(
path,
new PdfConfig(),
new DocOptions
{
Watermark = "^Confidential~Red~24~Verdana~80~-45",
TimeOut = 30
});| Campo | Ejemplo | Significado |
|---|---|---|
^ inicial | ^ | Opcional diseño en todas las esquinas. Sin él, se usa la colocación normal de la marca de agua. |
| Texto | Confidential | Texto renderizado en cada página. No debe estar vacío. |
| Color | Red | Color nombrado entendido por la capa de dibujo. |
| FontSize | 24 | Tamaño de fuente; una entrada numérica inválida recurre al valor predeterminado del renderizador. |
| FontName | Verdana | Familia de fuente solicitada. Asegúrese de que esté instalada en el entorno de despliegue. |
| Opacity | 80 | Valor de byte de 0 a 255. Debe analizarse correctamente. |
| Angle | -45 | Ángulo de rotación en grados; una entrada numérica inválida recurre al valor predeterminado. |
El analizador espera exactamente seis campos después del ^ opcional. Una definición inválida se reemplaza por el fallback visible Invalid Watermark del SDK en lugar de desaparecer silenciosamente.
Decisión de licencia
| Estado de licencia | Valor personalizado suministrado | Resultado renderizado |
|---|---|---|
| Licencia de visor paga válida | No | Página limpia |
| Licencia de visor paga válida | Sí | Marca de agua personalizada |
| Visor base Temporal/Demo activo | No | Página del visor base limpia |
| Visor base Temporal/Demo activo | Sí | Marca de agua personalizada cuando se aplica la ruta del visor base limpio |
| Licencia faltante, rechazada, expirada, de versión incorrecta o de dominio inválido | Cualquiera | Marca de agua de aplicación/evaluación; el valor personalizado no la sobrescribe |
| Renderizado de complemento bajo reglas de evaluación | Cualquiera | Marca de agua de evaluación |
La misma decisión se aplica a las imágenes de página servidas y a las exportaciones de anotaciones. La salida GIF animado se marca cuadro por cuadro. Por lo tanto, una marca de agua personalizada es una característica de aplicación licenciada, 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:
| Miembro | Propósito |
|---|---|
AnnotationManager GetAnnotationManager(string token) | Administrador vinculado a las dimensiones de página de la sesión abierta |
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight) | Administrador con dimensiones de página explícitas |
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight) | Administrador independiente de sesión |
void LoadAnnotationData(string token, AnnotationManager manager) | Carga anotaciones construidas en C# en la sesión |
void LoadAnnotationData(string token, string annotationData) | Carga anotaciones desde el sobre codificado página/Base64 devuelto por AnnotationManager.GetAnnotationData() |
void LoadAnnotationXML(string token, XmlDocument annotationXml) | Carga anotaciones desde XML |
XmlDocument GetAnnotationXML(string token) | Exporta las anotaciones de la sesión como XML |
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default) | PDF con anotaciones incrustadas |
Task<int> ExportAnnotationsToPngAsync(…) | Archivos PNG con anotaciones incrustadas |
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default) | ZIP de PNG por página con anotaciones incrustadas |
Metadatos DICOM
Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)El método está presente para alineación de API, pero el visor DICOM .NET 6 no puede suministrar etiquetas técnicas. Devuelve null para sesiones DICOM y no-DICOM; en una sesión DICOM también escribe una advertencia única explicando la limitación de la plataforma. El renderizado de página, fotograma y animación sigue siendo compatible.
Ayudantes de recursos — ReferenceCss / ReferenceScripts
Emite las etiquetas <link>/<script> para los recursos incrustados servidos por UseDoconutResources(), en el orden correcto de dependencias. Los paquetes para funciones bajo licencia como búsqueda y anotación se emiten solo cuando la licencia las habilita, manteniendo la UI del cliente consistente con el comportamiento del servidor.
string ReferenceCss(CssConfig? config = null) // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)Banderas de CssConfig: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (búsqueda bajo licencia), IncludeAnnotationCss (anotación bajo licencia).
Banderas de ScriptConfig: IncludeJQuery (requerido por todos los demás), IncludeBootstrap, IncludeViewerScripts (núcleo: docViewer.js + splitter + links), IncludeSearchScripts y IncludeSearchBar (búsqueda bajo licencia), IncludeAnnotationScripts y IncludeAnnotationBar (anotación bajo licencia).
@inject Doconut.Viewer Viewer
@Html.Raw(Viewer.ReferenceCss(new CssConfig { IncludeBootstrapCss = true, IncludeViewerCss = true }))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig { IncludeJQuery = true, IncludeViewerScripts = true }))¿Fue útil esta página?