Visare

Viewer (namespace Doconut) är den offentliga ingångspunkten för att öppna dokument från Razor‑sidor, MVC‑kontroller, Blazor‑komponenter eller minimala API:er. Den är sealed, registrerad som en transient‑tjänst av AddDoconut(), och löses upp via konstruktor‑injektion — bygg aldrig den direkt.

Viewer har ingen per‑begäran‑status och implementerar medvetet inte IDisposable: dokumentsessioner lever oberoende i sessionscachen, så att avlasta tjänsten skulle aldrig kunna stänga ett öppet dokument (se Kärnkoncept → Hur Visaren Fungerar).

OpenDocumentAsync

Öppnar ett dokument och returnerar sessionstoken som klientwidgeten använder för alla efterföljande förfrågningar.

// 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));

Undantag att hantera:

• LicenseException — en hittad licens avvisas (meddelandet innehåller avvisningsorsaken), eller så kräver formatet en plugin‑funktion som inte längre är beviljad. Kalenderutgång utan avvisningsmeddelande degraderas till vattenmärkt rendering istället för att kasta ett undantag.
• FormatNotSupportedException — Document format '<extension>' is not supported. → Dokumentformatet '<extension>' stöds inte.
• InvalidDataException — filinnehållet är korrupt eller matchar inte dess filändelse.

CloseDocument

void CloseDocument(string token)

Tar bort sessionen från cachen (avslutar dokumentmotorn omedelbart), raderar säkerhetsmarkören och återkallar åtkomstbehörigheten. Valfritt — glidande utgång utför samma städning — men rekommenderas för stora dokument.

GetPageCount

int GetPageCount(string token)

Totalt antal sidor i den öppna sessionen. Kastar ett undantag om token är okänt eller har gått ut.

DocOptions

Per‑öppning, formatoberoende alternativ (namespace Doconut):

Klassen exponerar också specialiserade egenskaper som avsiktligt ligger utanför det normala enkla‑värd‑visningsflödet:

Anpassat vattenmärke

DocOptions.Watermark använder sex tilde‑separerade fält. En valfri inledande ^ begär layout med vattenmärke i alla hörn:

^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
    });

Parsern förväntar sig exakt sex fält efter den valfria ^. En ogiltig definition ersätts av SDK:ns synliga Invalid Watermark‑fallback istället för att tyst försvinna.

Licensbeslut

Samma beslut tillämpas på levererade sidbilder och annoterings‑export. Animerad GIF‑utdata märks bildruta för bildruta. Ett anpassat vattenmärke är därför en licensierad applikationsfunktion, inte ett sätt att ersätta eller undertrycka utvärderings‑vattenmärket.

Annotationer API

Server‑sidans laddning och export av annotationer. Den fullständiga genomgången finns i Guider → Annotationer; gränssnittet är:

DICOM metadata

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

Metoden finns för API‑justering, men .NET 6 DICOM‑visaren kan inte tillhandahålla tekniska taggar. Den returnerar null för DICOM‑ och icke‑DICOM‑sessioner; för en DICOM‑session skriver den också en engångsvarning som förklarar plattformsbegränsningen. Rendering av sidor, ramar och animationer stöds fortfarande.

Resurs‑hjälpmedel — ReferenceCss / ReferenceScripts

Generera <link>/<script>‑taggarna för de inbäddade resurserna som serveras av UseDoconutResources(), i korrekt beroendeordning. Paket för licensstyrda funktioner såsom sökning och annotation genereras endast när licensen möjliggör dem, vilket håller klient‑UI‑et konsistent med serverbeteendet.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)

CssConfig‑flaggor: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (sök‑styrd), IncludeAnnotationCss (annotation‑styrd).

ScriptConfig‑flaggor: IncludeJQuery (krävs av alla andra), IncludeBootstrap, IncludeViewerScripts (kärna: docViewer.js + splitter + länkar), IncludeSearchScripts och IncludeSearchBar (sök‑styrd), IncludeAnnotationScripts och IncludeAnnotationBar (annotation‑styrd).

@inject Doconut.Viewer Viewer

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