Avvio Rapido

Visualizza il tuo primo documento in pochi minuti

Questa guida porta un'app ASP.NET Core da un Program.cs vuoto a un documento visualizzato nel browser: registrazione del server, il pacchetto completo Viewer (barra degli strumenti Viewer, montaggio Viewer e nastri opzionali di Ricerca/Annotazione), riferimenti alle risorse, inizializzazione del client, apertura del documento e esecuzione.

Configurazione del server

AddDoconut() registra i servizi; UseDoconutResources() e UseDoconut() collegano il middleware. La chiamata alle risorse deve venire per prima. UseDoconut() risponde a ogni richiesta che lo raggiunge, quindi montalo su un ramo proprio con app.Map. Le chiamate di sessione sono necessarie anche — la sicurezza predefinita dei documenti Doconut convalida ogni richiesta di pagina rispetto allo stato della sessione ASP.NET. Lo stato della sessione richiede una cache: AddDistributedMemoryCache() ne fornisce una. Un'app MVC o Razor Pages la registra già, ma un'app minimal-API no, e senza di essa l'app si arresta all'avvio con Unable to resolve service for type 'IDistributedCache'. Hai già registrato Doconut durante Installazione? Salta alla sezione successiva.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // lo stato della sessione richiede una cache (MVC/Razor Pages ne aggiunge già una)
builder.Services.AddSession(); // La sicurezza dei documenti Doconut si basa sullo stato della sessione ASP.NET

app.UseSession();          // chiama UseSession() prima di UseDoconut()
app.UseDoconutResources(); // deve essere registrato prima di UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Per una struttura dei percorsi in stile produzione, mappa il middleware dei documenti su un ramo esplicito e mantieni allineate le quattro impostazioni di percorso:

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = Path.Combine(AppContext.BaseDirectory, "wwwroot", "Doconut.Viewer.lic");
    options.MiddlewarePath = "/doconut";
    options.ResourcesPath = "/doconut-res";
    options.UnsafeMode = false;
});
builder.Services.AddDistributedMemoryCache();
builder.Services.AddSession();

app.UseRouting();
app.UseSession();
app.UseDoconutResources();
app.Map("/doconut", branch => branch.UseDoconut());

MiddlewarePath è un valore di coordinazione; non mappa un ramo ASP.NET Core da solo. In questo esempio l'host mappa /doconut, quindi il client utilizza BasePath: 'doconut'. ResourcesPath serve il bundle incorporato a /doconut-res, e il percorso della risorsa immagine del widget è quindi ResPath: 'doconut-res/images'. Scrivi entrambi senza una barra iniziale: il visualizzatore ne aggiunge una automaticamente, quindi '/doconut' diventerebbe //doconut/DocImage.axd, che il browser interpreta come una richiesta a un host chiamato doconut, e il visualizzatore fallisce con "Il gestore del visualizzatore non è stato raggiunto".

Aggiungi il visualizzatore a una pagina

Il Viewer è il nucleo richiesto della pagina. La sua superficie di rendering utilizza due div annidati:

html
<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

Tratta la barra degli strumenti, i montaggi dei moduli e la superficie del Viewer come un'unica composizione di pagina. Ricerca e Annotazione iniettano i loro nastri incorporati nei montaggi opzionali, ma quei moduli non sono mai autonomi: si collegano sempre al Viewer nella stessa pagina. Usa questo ordine:

html
<nav id="toolbar" aria-label="Document viewer controls">
    <!-- Pulsanti di navigazione, zoom, ricerca e annotazione del visualizzatore -->
</nav>

<div id="searchBarMount"></div>
<div id="annBarMount"></div>

<div id="divDocViewer">
    <div id="div_ctlDoc"></div>
</div>

Riferisci le risorse del visualizzatore

In una vista Razor, il servizio Viewer iniettato genera i tag <link> e <script> del visualizzatore in ordine di dipendenza — il widget è un plugin jQuery, quindi jQuery deve essere caricato prima degli script del visualizzatore:

html
@inject Doconut.Viewer Viewer

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

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery        = true,
    IncludeBootstrap     = true,
    IncludeViewerScripts = true
}))

Per il pacchetto completo Viewer, richiedi insieme le risorse del Viewer e dei moduli:

html
@Html.Raw(Viewer.ReferenceCss(new CssConfig
{
    IncludeBootstrapCss  = true,
    IncludeViewerCss     = true,
    IncludeSearchCss     = true,
    IncludeAnnotationCss = true
}))

@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig
{
    IncludeJQuery             = true,
    IncludeBootstrap         = true,
    IncludeViewerScripts     = true,
    IncludeSearchScripts     = true,
    IncludeSearchBar         = true,
    IncludeAnnotationScripts = true,
    IncludeAnnotationBar     = true
}))

IncludeViewerCss e IncludeViewerScripts sono le flag core obbligatorie. Non pubblicare mai un esempio di Nastro di Ricerca o Annotazione senza di esse, il montaggio del Viewer e un'istanza docViewer. ReferenceCss e ReferenceScripts omettono le risorse di un modulo opzionale quando la licenza corrente non concede tale capacità; il core Viewer si avvia comunque.

Inizializza il visualizzatore

Il widget lato client è un plugin jQuery. Questo è un set minimo di vere opzioni di inizializzazione (non pseudocodice):

javascript
let searchBar = null;
let annBar = null;

const objViewer = $('#div_ctlDoc').docViewer({
    showThumbs: true,
    autoLoad:   false,
    pageZoom:   100,
    FitType:    'width',
    BasePath:   'doconut',             // nessun '/' iniziale
    ResPath:    'doconut-res/images',  // nessun '/' iniziale
    onViewerReady: function () {
        // le pagine sono visibili; è sicuro nascondere qui un indicatore di caricamento
    },
    // Inoltra gli eventi del ciclo di vita delle annotazioni al ribbon incorporato quando è presente.
    onAnnLoaded:    () => annBar?.handleAnnLoaded(),
    onAnnSaved:     () => annBar?.handleAnnSaved(),
    onAnnSaveError: () => annBar?.handleAnnSaveError(),
    onAnnClosed:    () => annBar?.handleAnnClosed(),
    onError: function (message) {
        console.error('Doconut viewer error:', message);
    }
});

La capitalizzazione delle opzioni è davvero mista — showThumbs, autoLoad e pageZoom sono camelCase, ma FitType, BasePath e ResPath sono PascalCase. Non esiste una regola coerente; se la capitalizzazione è errata l'opzione viene silenziosamente ignorata (il widget torna al valore predefinito invece di generare un errore).

Altri quattro dettagli falliscono senza un messaggio di errore:

  • BasePath non ha lo slash iniziale. 'doconut' richiede /doconut/DocImage.axd; '/doconut' produce //doconut/DocImage.axd, che il browser interpreta come una richiesta a un altro host.
  • ResPath: 'doconut-res/images' — le icone si trovano una cartella sotto la radice delle risorse. Con 'doconut-res', ogni icona restituisce 404: nessuna icona della barra degli strumenti e nessuno spinner di caricamento, mentre il documento stesso viene comunque renderizzato. Uno slash iniziale lo rompe allo stesso modo di BasePath.
  • I richiami sono opzioni. onViewerReady, onError e gli altri vanno nell'oggetto passato a docViewer(...). Una funzione globale chiamata come il visualizzatore, ad esempio ctlDoc_ViewerReady, non viene mai chiamata.
  • Mantieni il visualizzatore, poi chiama View separatamente. docViewer(...) restituisce l'oggetto con Zoom, Next e FitType; View(...) restituisce qualcos'altro. var objViewer = $('#div_ctlDoc').docViewer({...}).View(token) renderizza il documento, poi fallisce con objViewer.Zoom is not a function al primo click sulla barra degli strumenti.

Assembla il pacchetto completo del Viewer

Una pagina completa del visualizzatore installa le seguenti parti insieme:

Parte del pacchettoRequisitoCome è collegata
Risorse del Viewer, mount e objViewerObbligatorioRenderer di documento principale
Barra degli strumenti del ViewerObbligatorio per una pagina completaMarkup host; i pulsanti chiamano lo stesso objViewer
Ribbon di ricercaOpzionale, modulo con licenzadoconutSearchBar(...).attach(objViewer)
Ribbon di annotazioneOpzionale, modulo con licenzadoconutAnnotationBar(...).attach(objViewer)

Sebbene la barra degli strumenti principale del Viewer sia markup host, viene installata accanto al Viewer e non deve mai essere documentata come un controllo isolato. Questo mantiene il suo layout, le etichette, le icone e le regole di autorizzazione sotto il controllo della tua applicazione mentre ogni pulsante utilizza la stessa istanza del Viewer:

html
<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.GotoPage(objViewer.TotalPages())">Last</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>
    <button type="button" onclick="objViewer.FitType('height')">Fit height</button>
    <button type="button" id="openSearch">Search</button>
    <button type="button" id="openAnnotations">Annotations</button>
</nav>

Gli helper per rotazione, miniatura, stampa, schermo intero, layout e stato dei pulsanti appartengono al tuo script della barra degli strumenti, che chiama lo stesso objViewer. Caricalo dopo Viewer.ReferenceScripts(...), e mantienilo insieme al suo markup <nav id="toolbar">.

Mantieni questo ordine di inizializzazione:

  1. Emetti CSS per il Viewer e i moduli con licenza.
  2. Renderizza la barra degli strumenti del Viewer, i mount di Search/Annotation e il mount del Viewer insieme.
  3. Emetti script per il Viewer e i moduli con licenza.
  4. Carica lo script helper della barra degli strumenti dell'applicazione host.
  5. Inizializza docViewer e conserva il risultato objViewer.
  6. Inizializza ogni Ribbon di Search o Annotation con licenza.
  7. Chiama attach(objViewer) su ogni Ribbon.
  8. Apri il documento e conserva il suo token per le richieste del Viewer e dei moduli.

In una distribuzione distribuita, il valore di richiesta aggiuntivo access e le impostazioni di retry del rendering asincrono appartengono al trasporto; non modificano il modo in cui il Viewer, la barra degli strumenti o i Ribbon vengono assemblati.

Le protezioni lato server sono importanti: quando una funzionalità opzionale non è disponibile, il suo script non viene emesso, quindi la sua funzione plug-in jQuery non esiste.

html
<script>
    let token = '';

    const refitViewer = () =>
        requestAnimationFrame(() => objViewer.Refit());

    @if (Viewer.IsSearchEnabled)
    {
        <text>
    searchBar = $('#searchBarMount').doconutSearchBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    searchBar.attach(objViewer);
        </text>
    }

    @if (Viewer.IsAnnotationEnabled)
    {
        <text>
    annBar = $('#annBarMount').doconutAnnotationBar({
        docId: 'ctlDoc',
        getRequestParams: () => ({ token }),
        onLayout: refitViewer
    });
    annBar.attach(objViewer);
        </text>
    }

    document.getElementById('openSearch').addEventListener('click', () => {
        if (!searchBar) return;
        searchBar.isOpen() ? searchBar.close() : searchBar.open();
    });

    document.getElementById('openAnnotations').addEventListener('click', () => {
        if (!annBar) return;
        annBar.isOpen() ? annBar.close() : annBar.open();
    });
</script>

Entrambi i componenti incorporati generano il proprio DOM del Ribbon. Search contiene i gruppi Trova, Opzioni e Risultati. Annotation contiene i suoi strumenti di creazione, controlli di stile, azioni di salvataggio e azioni opzionali di esportazione/immagine. Le barre espongono open(), close(), reset() e isOpen(); chiama sempre attach(objViewer) una volta dopo averle create.

L'esempio sopra omette i richiami opzionali dell'host e gli endpoint di esportazione/immagine di Annotation per mantenere l'avvio minimale. Vedi Search e Annotations per la configurazione completa specifica delle funzionalità, oppure Custom Themes per stilizzare o sostituire la barra degli strumenti del Viewer di proprietà dell'host.

Apri un documento

Il lato server è un unico endpoint: il servizio iniettato Viewer apre il documento e restituisce un token di sessione.

csharp
app.MapPost("/api/open", async (Viewer viewer) =>
{
    // Il token è opaco — passalo al widget, non registrarlo né conservarlo.
    string token = await viewer.OpenDocumentAsync("wwwroot/files/Sample.pdf");
    return Results.Ok(new { token });
});

Il client recupera quel token e lo passa al widget con objViewer.View(token):

javascript
fetch('/api/open', { method: 'POST' })
    .then(resp => resp.json())
    .then(data => {
        token = data.token;
        objViewer.View(token);
    });

Chiudi il documento

Chiama objViewer.Close(true) quando l'utente esce dal visualizzatore o apre un documento di sostituzione: pulisce il widget e invia una richiesta di chiusura al server. objViewer.Close() senza argomento pulisce solo il widget. Nei flussi di lavoro guidati dal server, viewer.CloseDocument(token) rimuove immediatamente la sessione nella cache, elimina il motore di rendering, cancella il suo marcatore di sicurezza e revoca il token. L'espirazione scorrevole alla fine esegue la stessa pulizia, ma è consigliata una chiusura esplicita per documenti di grandi dimensioni.

Il flusso di richiesta completato è:

text
AddDoconut + middleware
    -> render CSS/scripts and mount div
    -> initialize docViewer
    -> OpenDocumentAsync
    -> return opaque token
    -> objViewer.View(token)
    -> page/search/annotation requests
    -> Close / CloseDocument

Tratta il token come una credenziale di tipo bearer: non registrarlo mai, non conservarlo mai, consegnalo solo al widget. Identifica una sessione di documento attiva sul server e smette di funzionare quando quella sessione scade — riapri il documento per ottenerne uno nuovo.

Esegui

Posiziona un PDF in wwwroot/files/Sample.pdf, esegui dotnet run e apri la pagina che ospita il widget. La prima pagina viene renderizzata nel visualizzatore, con un pannello di miniature a sinistra. Se non accade, consulta Risoluzione dei problemi.

Cosa ottieni senza licenza

Una licenza mancante non genera errori. Il visualizzatore renderizza normalmente, ma ogni pagina porta una filigrana di valutazione. Vedi Configurazione della licenza per capire come Doconut trova una licenza e cosa cambia una volta trovata.

Questa pagina è stata utile?