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

Viewer har ingen per‑begäran‑stat och gör inte implementera IDisposable: dokumentsessioner lever oberoende i sessionscachen, så att avyttra tjänsten aldrig kan riva ner 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 begäranden.

// Enkel öppning
string token = await viewer.OpenDocumentAsync(path);

// Med per-format konfiguration och alternativ
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Från en uppladdning
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 beviljas. Kalenderutgång utan avvisningsmeddelande degraderas till vattenmärkt 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 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 medvetet ligger utanför det normala enkla‑värd‑visningsflödet:

Anpassad vattenstämpel

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

Annotations‑API

Server‑sidig 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 som öppnats via DICOM‑pluginet; null för icke‑DICOM‑dokument.

Resurs‑hjälpare — ReferenceCss / ReferenceScripts

Generera <link>/<script>‑taggarna för de inbäddade resurserna som levereras 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, så att klient‑UI:n förblir konsekvent med serverns beteende.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + visare + sökning + annotation
string ReferenceScripts(ScriptConfig? config = null)

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

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

@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)

Returnerar namnen på kalkylbladen i ett öppet kalkylblad, i arbetsbokens ordning, eller en tom lista när det öppna dokumentet inte är ett kalkylblad.

Tillagt i 26.9.0.