Visare

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

Det tidigare .NET Standard‑biblioteket exponerade en offentlig konstruktor som tog minnescachen, HTTP‑kontext‑åtkomsten och en eller flera licensvägar. Den konstruktorn är borta; service‑grafen tillhandahåller dessa beroenden.

Viewer har ingen per‑förfrågan‑state och implementerar medvetet inte IDisposable: dokumentsessioner lever oberoende i sessionscachen, så att avyttra tjänsten aldrig kan 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. Varje öppning är asynkron — det finns ingen synkron OpenDocument.

// 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 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 ett undantag om token är okänd eller har gått ut.

GetWorksheetNames

IReadOnlyList<string> GetWorksheetNames(string token)

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

Endast renderade blad listas: dolda och tomma blad exkluderas, och när ExcelConfig.SheetNames begränsar rendering visas endast de bladen. Ett blad är inte alltid en sida — ett mycket stort blad renderas över flera sidor. Kastar ett undantag om token är okänd eller har gått ut.

Tillagt i 26.9.0.

Funktionsflaggor

Använd dessa i en Razor‑vy för att rendera ett licensierat Ribbon endast när servern faktiskt kommer att leverera det — se Snabbstart.

Dokumentalternativ

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

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

Anpassad vattenstämpel

DocOptions.Watermark använder sex tilde‑separerade fält. En valfri inledande ^ begär layouten med 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 annoteringsexporter. 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 inläsning och export av annotationer. Den fullständiga genomgången finns i Guider → Annotationer; gränssnittet är:

Var och en av dessa tar sessions‑token. Den föregående bibliotekets sessionsfria GetAnnotationManager(pageWidth, pageHeight)‑form överlever för att bygga annotationer utanför en session, men inläsning av dem kräver fortfarande en token.

DICOM‑metadata

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

Metoden finns för API‑justering, men detta paket kan inte tillhandahålla tekniska DICOM‑taggar: metadata‑läsaren levereras endast med en .NET 8‑byggnad. Den returnerar null för DICOM‑ och icke‑DICOM‑sessioner; i 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ä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, vilket håller klient‑UI‑et konsekvent med serverbeteendet.

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

CssConfig flaggor: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (sökning‑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ökning‑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 }))

Dessa hjälpare är det stödjade sättet att leverera webbläsarresurserna. Applikationer som kopierade docViewer.js, documentLinks.js och docViewer.UI.js till wwwroot bör ta bort dessa kopior när sidan renderas från de genererade taggarna.