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 — skapa den aldrig direkt.

Viewer håller ingen per‑request‑state och implementerar avsiktligt inte IDisposable: dokumentsessioner lever oberoende i sessionscachen, så att avyttra tjänsten skulle aldrig kunna stänga ett öppet dokument (se Core Concepts → How the Viewer Works).

OpenDocumentAsync

Öppnar ett dokument och returnerar sessionstoken som klient‑widgeten använder för alla efterföljande anrop.

// 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 vattenstämpel‑rendering istället för att kasta ett undantag.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — filinnehållet är korrupt eller matchar inte dess filändelse.

CloseDocument

void CloseDocument(string token)

Tar bort sessionen från cachen (avyttrar 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 om token är okänd eller har löpt ut.

DocOptions

Per‑öppning, format‑oberoende alternativ (namespace Doconut):

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

Anpassad vattenstämpel

DocOptions.Watermark använder sex tilde‑separerade fält. Ett valfritt inledande ^ begär layout 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 det 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 export av annotationer. Animerad GIF‑output märks bild för bild. En anpassad vattenstämpel är därför en licensierad applikationsfunktion, inte ett sätt att ersätta eller undertrycka utvärderings‑vattenstämpeln.

Annotations‑API

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

DICOM‑metadata

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

Returnerar DICOM‑tag‑metadata för sessioner öppnade via DICOM‑pluginen; null för icke‑DICOM‑dokument.

Resurs‑hjälpmedel — ReferenceCss / ReferenceScripts

Genererar <link>/<script>‑taggarna för de inbäddade resurserna som levereras av UseDoconutResources(), i korrekt beroendeordning. Paket för licens‑styrda funktioner såsom sökning och annotation genereras endast när licensen möjliggör dem, så att klient‑UI:n förblir i linje med serverbeteendet.

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

CssConfig‑flaggor: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (search‑gated), IncludeAnnotationCss (annotation‑gated).

ScriptConfig‑flaggor: IncludeJQuery (required by all others), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts and IncludeSearchBar (search‑gated), IncludeAnnotationScripts and IncludeAnnotationBar (annotation‑gated).

@inject Doconut.Viewer Viewer

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