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

Viewer neobsahuje žá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í koncepty → Jak prohlížeč funguje).

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 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 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í dokumentový engine), smaže bezpečnostní značku a odvolá přístupové oprávnění. Volitelné — posuvné vypršení provádí stejný úklid — ale je doporučeno 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 pro každé otevření (namespace Doconut):

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

Vlastní vodoznak

DocOptions.Watermark používá šest polí oddělených vlnovkou. Volitelný úvodní ^ požaduje rozvrž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 servírované 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 licencovanou funkcí aplikace, nikoli způsobem, jak nahradit nebo potlačit evaluační vodoznak.

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)

Vrací metadata DICOM tagů pro relace otevřené přes DICOM plugin; null pro ne-DICOM dokumenty.

Pomocníci zdrojů — ReferenceCss / ReferenceScripts

Vygenerujte značky <link>/<script> pro vložené zdroje poskytované UseDoconutResources() ve správném pořadí závislostí. Balíčky pro funkce řízené licencí, jako je vyhledávání a anotace, jsou generovány pouze když licence umožňuje, aby uživatelské rozhraní 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 (řízené vyhledáváním), IncludeAnnotationCss (řízené anotacemi).

ScriptConfig příznaky: IncludeJQuery (vyžadováno všemi ostatními), IncludeBootstrap, IncludeViewerScripts (jádro: docViewer.js + splitter + links), IncludeSearchScripts a IncludeSearchBar (řízené vyhledáváním), IncludeAnnotationScripts a IncludeAnnotationBar (řízené anotacemi).

@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 v 26.9.0.