Rychlý start
Vykreslete svůj první dokument v MVC 5 nebo Web Forms
Tento průvodce vezme aplikaci ASP.NET na .NET Framework 4.7.2 z nainstalovaného balíčku až k dokumentu vykreslenému v prohlížeči: Global.asax, otevřenému koncovému bodu, prostředkům prohlížeče, widgetu a tokenu, který je spojuje. Předpokládá, že registrace Web.config z Installation jsou nastaveny — bez handleru DocImage.axd a modulů zdrojů nemůže nic níže dosáhnout na server.
Sestavte Doconut v Global.asax
Úplný Application_Start pro aplikaci MVC 5:
// Global.asax.cs - vytvořit jednou na pracovní proces, uvolnit při ukončení.
protected void Application_Start()
{
Encoding.RegisterProvider(CodePagesEncodingProvider.Instance);
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.UnsafeMode = false; // stránka je podávána pouze relaci, která otevřela dokument
});
// Pouze MVC: udržet dva Doconut koncové body mimo směrování.
RouteTable.Routes.IgnoreRoute("{resource}.axd/{*pathInfo}");
RouteTable.Routes.IgnoreRoute("doconut-res/{*pathInfo}");
}
protected void Application_End()
{
Doconut.DoconutHost.Shutdown();
}Encoding.RegisterProviderzpřístupňuje procesu starší stránky kódu, které některé formáty dokumentů používají. Zavolejte jej jednou, před otevřením prvního dokumentu.UnsafeMode = falseje výchozí, explicitně nastavený, aby ho nikdo nechtěně nezměnil:DocImage.axdslouží stránku pouze ASP.NET relaci, která dokument otevřela.- Dvě volání
IgnoreRouteudržují MVC routování mimoDocImage.axda/doconut-res/*, které obsluhují handler a modul. Aplikace Web Forms nemá MVC routy a nepotřebuje tento řádek. DoconutHost.Shutdownzastavuje backgroundovou práci Doconut a uvolňuje jeho služby při recyklaci aplikačního poolu. Je bezpečné jej volat i kdyžInitializenikdy neběžel.
Otevřete dokument
Otevření dokumentu vrátí neprůhledný token. Widget tento token posílá s každým požadavkem na stránku.
V MVC 5 akce kontroleru získá službu Viewer z DoconutHost.Services — MVC 5 nemá pro ni konstruktorovou injekci:
// POST /Document/Open
[HttpPost]
public async Task<ActionResult> Open()
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
// Token je neprůhledný - předávejte jej prohlížeči, nikdy jej nezaznamenávejte ani neukládejte.
string token = await viewer.OpenDocumentAsync(Server.MapPath("~/files/Sample.pdf"));
return Json(new { token });
}Dokument musí být otevřen uvnitř požadavku, který má stav relace, protože jeho otevření umožňuje aktuální ASP.NET relaci přístup k jeho stránkám. Kontrolery MVC a stránky Web Forms mají stav relace ve výchozím nastavení. Vlastní IHttpHandler jej nemá, pokud neimplementuje System.Web.SessionState.IRequiresSessionState. Otevřete dokument z handleru bez něj a prohlížeč zobrazí na každé stránce „Nemáte oprávnění zobrazit tuto stránku.“
V Web Forms může samotná stránka otevřít dokument ve svém code-behind. OpenDocument je synchronní forma OpenDocumentAsync, určená pro code-behind, který nepoužívá asynchronní stránky:
// Default.aspx.cs
protected string Token;
protected void Page_Load(object sender, EventArgs e)
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
Token = viewer.OpenDocument(Server.MapPath("~/files/Sample.pdf"));
}Zacházejte s tokenem jako s přístupovým oprávněním: nikdy jej neukládejte ani neprovádějte logování; předávejte jej pouze widgetu. Přestane fungovat, když vyprší relace dokumentu — otevřete dokument znovu a získáte nový.
Odkaz na prostředky prohlížeče
Viewer.ReferenceCss a Viewer.ReferenceScripts emitují značky <link> a <script> pro vložené assety, v pořadí závislostí, odkazující na /doconut-res/. Widget je jQuery plugin, takže jQuery je první.
MVC 5. Pohledy nemají @inject, takže vytvořte značky v kontroleru a předáte je pomocí ViewBag:
public ActionResult Index()
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
ViewBag.ViewerCss = viewer.ReferenceCss(new CssConfig
{
IncludeBootstrapCss = true,
IncludeViewerCss = true
});
ViewBag.ViewerScripts = viewer.ReferenceScripts(new ScriptConfig
{
IncludeJQuery = true,
IncludeBootstrap = true,
IncludeViewerScripts = true
});
return View();
}@Html.Raw(ViewBag.ViewerCss)
...
@Html.Raw(ViewBag.ViewerScripts)Uchovejte tuto práci v kontroleru. MVC 5 kompiluje pohledy při jejich prvním podání, a bez extra balíčku kompilátoru tento kompilátor rozumí jen C# 5 — žádné ?., žádné $"...", žádné nameof. Pohled, který je používá, se v Visual Studio úspěšně zkompiluje a pak v prohlížeči vrátí prázdný 500.
Web Forms. Zveřejněte stejné řetězce z code-behind a zapište je pomocí <%= %>:
<head>
<%= ViewerCss %>
</head>
<body>
...
<%= ViewerScripts %>
</body>IncludeViewerCss a IncludeViewerScripts jsou povinným jádrem. Pro přidání pásků Search a Annotation také nastavte IncludeSearchCss, IncludeAnnotationCss, IncludeSearchScripts, IncludeSearchBar, IncludeAnnotationScripts a IncludeAnnotationBar. Obě metody vynechají soubory pásku, pokud licence tuto funkci nepovoluje; samotný prohlížeč se stále spustí.
Přidání prohlížeče na stránku
Vykreslovací plocha jsou dva vnořené div:
<div id="divDocViewer">
<div id="div_ctlDoc"></div>
</div>Dejte vnějšímu div skutečnou výšku — prohlížeč vyplní svůj kontejner a změří jej při spuštění. Prohlížeč nevykresluje vlastní panel nástrojů: GotoPage, Next, Zoom, FitType a zbytek jsou metody, které vaše stránka připojí k vlastním tlačítkům, umístěným vedle prohlížeče:
<nav id="toolbar" aria-label="Document viewer controls">
<button type="button" onclick="objViewer.GotoPage(1)">First</button>
<button type="button" onclick="objViewer.Next(false)">Previous</button>
<button type="button" onclick="objViewer.Next(true)">Next</button>
<button type="button" onclick="objViewer.Zoom(false)">Zoom out</button>
<button type="button" onclick="objViewer.Zoom(true)">Zoom in</button>
<button type="button" onclick="objViewer.FitType('width')">Fit width</button>
</nav>Inicializace prohlížeče a zobrazení dokumentu
Po skriptech prohlížeče vytvořte widget a pak mu předáte token:
var objViewer = $('#div_ctlDoc').docViewer({
showThumbs: true,
autoLoad: false,
pageZoom: 100,
FitType: 'width',
BasePath: '/', // '/' znamená DocImage.axd v kořenovém adresáři webu
ResPath: 'doconut-res/images', // žádný úvodní '/'
onViewerReady: function () {
// stránky jsou viditelné; zde skryjte indikátor načítání
},
onError: function (message) {
console.error('Doconut viewer error:', message);
}
});
fetch('/Document/Open', { method: 'POST' })
.then(function (resp) { return resp.json(); })
.then(function (data) { objViewer.View(data.token); });Ve Web Forms, kde stránka sama otevřela dokument, poslední tři řádky se stanou objViewer.View('<%= Token %>');.
Čtyři podrobnosti zde selžou bez chybové zprávy:
BasePath: '/'odkazuje naDocImage.axdv kořeni webu. Pro aplikaci ve virtuálním adresáři použijte její název bez lomítek ('myapp'požaduje/myapp/DocImage.axd). Úvodní lomítko ('/myapp') vytváří//myapp/DocImage.axd, který prohlížeč interpretuje jako požadavek na jiný hostitel.ResPath: 'doconut-res/images'— ikony jsou o jednu složku pod kořenem zdrojů. S'doconut-res'každá ikona vrací 404: žádné glyphy panelu nástrojů a žádný načítací spinner, zatímco samotný dokument se stále vykresluje. Úvodní lomítko to rozbije stejným způsobem jakoBasePath.- Callbacks jsou volby.
onViewerReady,onErrora ostatní patří do objektu předaného dodocViewer(...). Globální funkce pojmenovaná po prohlížeči, jako jectlDoc_ViewerReady, se nikdy nevolá. - Uchovejte prohlížeč a poté zavolejte
Viewsamostatně.docViewer(...)vrací objekt sZoom,NextaFitType;View(...)vrací něco jiného.var objViewer = $('#div_ctlDoc').docViewer({...}).View(token)vykreslí dokument, pak selže sobjViewer.Zoom is not a functionpři prvním kliknutí na panel nástrojů.
Názvy možností míchají camelCase (showThumbs, autoLoad, pageZoom) a PascalCase (FitType, BasePath, ResPath). Špatně napsaná možnost je ignorována a widget použije výchozí hodnotu.
Jednořádková alternativa
Pro stránku, která potřebuje pouze zobrazit dokument a nemá vlastní panel nástrojů, Viewer.RenderViewer zapíše celý inicializační skript — docViewer(...) s BasePath: '/' a ResPath: 'doconut-res/images', poté .View(token). Existuje pouze v tomto balíčku:
// Default.aspx.cs
protected string ViewerInit;
protected void Page_Load(object sender, EventArgs e)
{
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();
string token = viewer.OpenDocument(Server.MapPath("~/files/Sample.pdf"));
ViewerInit = viewer.RenderViewer("div_ctlDoc", token);
}<div id="div_ctlDoc" style="height: 100vh"></div>
<%= ViewerScripts %>
<%= ViewerInit %>Předávejte ViewerConfig jako třetí argument pro změnu přiblížení, přizpůsobení nebo panelu miniatur. Protože generovaný skript neuchovává odkaz na prohlížeč, použijte výše ručně napsanou inicializaci, když vaše stránka potřebuje vlastní panel nástrojů.
Zavřít dokument
Zavolejte objViewer.Close(true), když uživatel opustí prohlížeč nebo otevře náhradu: vyčistí widget a odešle požadavek na zavření na DocImage.axd. objViewer.Close() bez argumentu vyčistí pouze widget. Na serveru viewer.CloseDocument(token) okamžitě odstraní relaci dokumentu, uvolní její vykreslovací prostředky a odebere relaci přístup k jejím stránkám. Posuvná expirace nakonec udělá totéž, ale explicitní uzavření velkých dokumentů uvolní paměť dříve.
Spusťte to
Umístěte PDF na ~/files/Sample.pdf, spusťte web v IIS Express (F5 ve Visual Studiu) a otevřete stránku, která hostuje widget. První stránka se vykreslí, s náhledy vlevo. Pokud se tak nestane, podívejte se na Řešení problémů.
Co získáte bez licence
Chybějící licence nevyvolá výjimku. Prohlížeč se vykresluje normálně, ale každá stránka nese vodotisk hodnocení. Viz Nastavení licence pro to, kde Doconut hledá vaši licenci.
Byla tato stránka užitečná?