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án pomocí injekce konstruktoru — nikdy jej neinstanciujte přímo.

Viewer neobsahuje žádný stav specifický pro 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 Core Concepts → How the Viewer Works).

OpenDocumentAsync

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

// Jednoduché otevření
string token = await viewer.OpenDocumentAsync(path);

// S konfigurací a možnostmi pro každý formát
token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig { AllowSearch = true, AllowCopy = true },
    new DocOptions { TimeOut = 30 });

// Z nahrání
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));

Výjimky, které je třeba ošetřit:

• 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 renderování s vodoznakem 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ění dokumentového enginu), 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, platné při otevření (namespace Doconut):

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

Vlastní vodoznak

DocOptions.Watermark používá šest polí oddělených vlnovkou. Volitelný úvodní ^ 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 záložním řešením SDK Invalid Watermark místo tichého zmizení.

Rozhodnutí o licenci

Stejné rozhodnutí se aplikuje na poskytované obrázky stránek a exporty anotací. Výstup animovaného GIFu je označován snímek po snímku. Vlastní vodoznak je tedy licencovaná funkce aplikace, nikoli způsob, jak nahradit nebo potlačit vodoznak hodnocení.

API anotací

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

Metadata DICOM

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

Metoda je přítomna pro sladění API, ale .NET 6 DICOM prohlížeč nemůže poskytnout technické značky. Vrací null pro DICOM i ne-DICOM relace; v DICOM relaci také zapíše jednorázové varování vysvětlující omezení platformy. Vykreslování stránek, snímků a animací zůstává podporováno.

Pomocníci zdrojů — ReferenceCss / ReferenceScripts

Vypište značky <link>/<script> 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 vypisovány pouze když licence umožní, aby UI klienta zůstalo v souladu s chováním serveru.

string ReferenceCss(CssConfig? config = null)      // null → Bootstrap + prohlížeč + vyhledávání + anotace
string ReferenceScripts(ScriptConfig? config = null)

CssConfig příznaky: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (omezené vyhledáváním), IncludeAnnotationCss (omezené anotací).

ScriptConfig příznaky: IncludeJQuery (vyžadováno všemi ostatními), IncludeBootstrap, IncludeViewerScripts (jádro: docViewer.js + rozdělovač + odkazy), IncludeSearchScripts a IncludeSearchBar (omezené vyhledáváním), IncludeAnnotationScripts a IncludeAnnotationBar (omezené anotací).

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

Vrací názvy listů otevřené tabulky v pořadí sešitu, nebo prázdný seznam, pokud otevřený dokument není tabulkou.

Přidáno ve verzi 26.9.0.