Prohlížeč

Viewer (namespace Doconut) je veřejný vstupní bod pro otevírání dokumentů z Razor stránek, MVC kontrolerů, Blazor komponent nebo minimálních API. Je sealed, registrován jako transient služba pomocí AddDoconut(), a získává se pomocí injekce do konstruktoru — nikdy jej neinstanciujte přímo.

Viewer neuchovává žádný stav na požadavek a úmyslně neimplementuje IDisposable: relace dokumentů žijí nezávisle v cache relací, takže uvolnění služby by nikdy nemohlo ukončit otevřený dokument (viz Základní pojmy → Jak funguje prohlížeč).

OpenDocumentAsync

Otevře dokument a vrátí token relace, který klientský widget používá pro všechny následné požadavky.

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

Výjimky k ošetření:

• LicenseException — nalezená licence je odmítnuta (zpráva nese důvod odmítnutí) nebo formát vyžaduje plugin, který již není povolen. Vypršení kalendáře bez zprávy o odmítnutí vede k vodotiskovému vykreslení místo vyhození výjimky.
• FormatNotSupportedException — Document format '<extension>' is not supported.
• InvalidDataException — obsah souboru je poškozený nebo neodpovídá jeho příponě.

CloseDocument

void CloseDocument(string token)

Odstraní relaci z cache (okamžitě uvolní dokumentový engine), smaže bezpečnostní značku a odvolá přístupové oprávnění. Volitelné — posuvná expirace provádí stejný úklid — ale je doporučena pro velké dokumenty.

GetPageCount

int GetPageCount(string token)

Celkový počet stránek otevřené relace. Vyhodí výjimku, pokud je token neznámý nebo vypršel.

DocOptions

Možnosti nezávislé na formátu při otevření (namespace Doconut):

Třída také vystavuje specializované vlastnosti, které jsou úmyslně mimo běžný jednojádrový tok prohlížení:

Custom watermark

DocOptions.Watermark používá šest polí oddělených vlnkou. Volitelný úvodní znak ^ požaduje rozložení po všech rozích:

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

Parser očekává přesně šest polí po volitelném ^. Neplatná definice je nahrazena viditelným Invalid Watermark fallbackem SDK místo tichého zmizení.

Rozhodnutí o licenci

Stejné rozhodnutí se aplikuje na servírované obrázky stránek a exporty anotací. Výstup animovaného GIFu je razítkován snímek po snímku. Vlastní vodotisk je tedy licencovanou funkcí aplikace, nikoli způsobem, jak nahradit nebo potlačit evaluační vodotisk.

Annotations API

Načítání a export anotací na straně serveru. Kompletní průvodce je v Průvodci → Anotace; rozhraní je následující:

DICOM metadata

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

Metoda existuje pro sladění API, ale .NET 6 DICOM prohlížeč nemůže poskytnout technické značky. Vrací null pro DICOM i ne‑DICOM relace; u DICOM relace také zapisuje jednorázové varování vysvětlující omezení platformy. Rendering stránek, snímků a animací zůstává podporován.

Resource helpers — ReferenceCss / ReferenceScripts

Vygeneruje <link>/<script> značky pro vložené zdroje poskytované UseDoconutResources(), ve správném pořadí závislostí. Balíčky pro funkce pod licencí, jako je vyhledávání a anotace, jsou emitovány pouze když licence umožňuje, čímž se UI klienta shoduje s chováním serveru.

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

Příznaky CssConfig: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (vyhledávání pod licencí), IncludeAnnotationCss (anotace pod licencí).

Příznaky ScriptConfig: IncludeJQuery (vyžadováno všemi ostatními), IncludeBootstrap, IncludeViewerScripts (core: docViewer.js + splitter + links), IncludeSearchScripts a IncludeSearchBar (vyhledávání pod licencí), IncludeAnnotationScripts a IncludeAnnotationBar (anotace pod licencí).

@inject Doconut.Viewer Viewer

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