Prohlížeč

Hlavní třída pro prohlížení dokumentů

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 funguje prohlížeč).

OpenDocumentAsync

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

PřetíženíPoužijte, když
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default)Otevírání z disku s automatickou detekcí formátu a výchozím nastavením formátu
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default)Potřebujete renderovací možnosti pro každý formát (PdfConfig, WordConfig, …)
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default)Dokument není soubor na disku (nahrání, databáze, blob). fileInfo musí nést správnou příponu — řídí detekci formátu
csharp
// 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í udělen. 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

text
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é — klouzavé vypršení provádí stejný úklid — ale je doporučeno pro velké dokumenty.

GetPageCount

text
int GetPageCount(string token)

Celkový počet stránek otevřené relace. Vyhodí InvalidOperationException (Document session not found. Please re-open document.), pokud je token neznámý nebo vypršel, a ArgumentException pro prázdný token.

GetPageDimensions

text
(int Width, int Height) GetPageDimensions(string token, int page = 1)

Výchozí velikost vykreslené stránky dokumentu při 100 % přiblížení — souřadnicový prostor pro anotace vytvořené v kódu. page je akceptováno pro kompatibilitu; výsledek je výchozí nastavení dokumentu. Vyhodí InvalidOperationException (Document session not found. Please re-open document.), pokud je token neznámý nebo vypršel, a ArgumentException pro prázdný token.

GetWorksheetNames

text
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í tabulka.

Jsou uvedeny pouze vykreslené listy: skryté a prázdné listy jsou vyloučeny, a když ExcelConfig.SheetNames omezuje vykreslování, zobrazí se jen tyto listy. List není vždy jedna stránka — velmi velký list je vykreslen přes několik stránek. Vyhodí InvalidOperationException (Document session not found. Please re-open document.), pokud je token neznámý nebo vypršel, a ArgumentException pro prázdný token.

Přidáno ve verzi 26.9.0.

Příznaky schopností

ČlenVýznam
bool IsSearchEnabledAktuální licence poskytuje Search
bool IsAnnotationEnabledAktuální licence poskytuje Annotation

Použijte je v Razor view k vykreslení licencovaného Ribbonu pouze tehdy, když server jej skutečně poskytne — viz Rychlý start.

DocOptions

Možnosti nezávislé na formátu, platné pro každé otevření (namespace Doconut):

TypVlastnostVýchozíPopis
stringPassword""Heslo pro chráněné dokumenty (automaticky zkopírováno do konfigurace formátu).
intImageResolution0Zastaralé. Uchováváno pouze pro kompatibilitu — místo toho nastavte ImageResolution v konfiguraci formátu.
stringWatermark""Vlastní text vodoznaku vykreslený na stránkách. Formátovací řetězec: "^Text~Color~FontSize~FontName~Opacity~Angle", např. "^Sample Copy~Red~24~Verdana~80~-45".
intTimeOut60Posuvná expirace relace v minutách.
boolIsSecuredtrueMomentálně nevyžadováno — rezervováno. Vazba tokenu je řízena globálně pomocí DoconutOptions.UnsafeMode (viz Základní koncepty → Relace a zabezpečení).

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

TypVlastnostVýchozíPopis
boolIsWebFarmfalseZastaralé — nemá žádný efekt. Publikujte dokument s DistributedDocumentPublisher.PublishAsync (nebo IDistributedPublishQueue.EnqueueAsync) a místo toho nastavte FileShareConfig.RootPath.
stringWebFarmPath""Zastaralé — nemá žádný efekt. Použijte místo toho FileShareConfig.RootPath.
boolEditModefalseRezervováno pro samostatně distribuovaný pracovní postup Editoru; ponechte false pro standardní prohlížeč.

Vlastní vodoznak

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

text
^Text~Color~FontSize~FontName~Opacity~Angle
csharp
string token = await viewer.OpenDocumentAsync(
    path,
    new PdfConfig(),
    new DocOptions
    {
        Watermark = "^Confidential~Red~24~Verdana~80~-45",
        TimeOut = 30
    });
PolePříkladVýznam
Úvodní ^^Volitelné rozložení po všech rozích. Bez něj se používá běžné umístění vodoznaku.
TextConfidentialText vykreslený na každé stránce. Nesmí být prázdný.
BarvaRedPojmenovaná barva rozpoznávaná kreslicí vrstvou.
Velikost písma24Velikost písma; neplatný číselný vstup se vrátí k výchozímu nastavení renderu.
Název písmaVerdanaPožadovaná rodina písma. Ujistěte se, že je nainstalována v prostředí nasazení.
Průhlednost80Hodnota bajtu od 0 do 255. Musí být úspěšně parsována.
Úhel-45Úhel otočení ve stupních; neplatný číselný vstup se vrátí k výchozímu nastavení.

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

Rozhodnutí o licenci

Stav licencePoskytnutá vlastní hodnotaVykreslený výsledek
Platná placená licence pro prohlížečNeČistá stránka
Platná placená licence pro prohlížečAnoVlastní vodoznak
Aktivní dočasná/demo základní verze prohlížečeNeČistá stránka základního prohlížeče
Aktivní dočasná/demo základní verze prohlížečeAnoVlastní vodoznak, když se použije čistá cesta základního prohlížeče
Chybějící, odmítnutá, prošlá, nesprávná verze nebo licence s neplatnou doménouLibovolnáVodoznak vynucení/ohodnocení; vlastní hodnota jej nepřepíše
Renderování pluginu podle evaluačních pravidelLibovolnáEvaluační vodoznak

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 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 → Anotacích; rozhraní je:

ČlenÚčel
AnnotationManager GetAnnotationManager(string token)Správce vázaný na rozměry stránky otevřené relace
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight)Správce s explicitními rozměry stránky
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight)Správce nezávislý na relaci
void LoadAnnotationData(string token, AnnotationManager manager)Načíst anotace vytvořené v C# do relace
void LoadAnnotationData(string token, string annotationData)Načíst anotace z kódovaného page/Base64 obálky vrácené pomocí AnnotationManager.GetAnnotationData()
void LoadAnnotationXML(string token, XmlDocument annotationXml)Načíst anotace z XML
XmlDocument GetAnnotationXML(string token)Exportovat anotace relace jako XML
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default)PDF s vloženými anotacemi
Task<int> ExportAnnotationsToPngAsync(string token, string directoryPath, int zoom = 100, CancellationToken ct = default)Jeden PNG na stránku, anotace vložené, zapsané do directoryPath (vytvořeno, pokud chybí); vrací počet zapsaných obrázků
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default)ZIP s PNG soubory po stránkách s vloženými anotacemi

Metadata DICOM

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

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

Pomocníci zdrojů — ReferenceCss / ReferenceScripts

Vypíše značky <link>/<script> pro vložené zdroje poskytované UseDoconutResources(), ve správném pořadí závislostí. Balíčky pro funkce omezené licencí, jako je vyhledávání a anotace, jsou vypisovány pouze když licence umožňuje jejich použití, aby uživatelské rozhraní klienta zůstalo v souladu s chováním serveru.

text
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 + splitter + odkazy), IncludeSearchScripts a IncludeSearchBar (omezené vyhledáváním), IncludeAnnotationScripts a IncludeAnnotationBar (omezené anotací), EmitFeatureFlags (výchozí true: také zapisuje inline skript window.Doconut.features = { search, annotation, editor }; nastavte na false pod Content-Security-Policy, která blokuje inline skripty).

html
@inject Doconut.Viewer Viewer

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

Byla tato stránka užitečná?