Installation

Lägg till Doconut i ditt .NET Standard 2.1-projekt

Den grundläggande Doconut-visaren för .NET Standard levereras som ett NuGet-paket som kan anslutas till vilken ASP.NET Core-applikation som helst. Valfria plugins använder separata paket. Denna sida installerar grundpaketet, bekräftar att din värd kan konsumera det, och registrerar middleware — det minsta som behövs innan din första rendering.

Kontrollera värdramverket först

Biblioteket riktar sig mot netstandard2.1. Det är ett snävare kontrakt än den tidigare netstandard2.0-byggnaden, och det är det första som ska verifieras:

VärdStöds
.NET Core 3.0 eller senare, inklusive .NET 5/6/7/8Ja
.NET Framework (valfri version)Nej — netstandard2.1 kan inte konsumeras av .NET Framework

Paketet körs endast på Windows. För en Linux-värd, använd Doconut.NET8 eller Doconut.NET6.

Om applikationen körs på .NET Framework är detta inte rätt paket. Använd Doconut.NETFramework istället; från version 26.9.0 kräver det .NET Framework 4.7.2.

Installera paketet

bash
dotnet add package Doconut.NETStandard

Det oversionsspecifika kommandot installerar den senaste stabila versionen. För att låsa den version som denna dokumentation beskriver, ange versionen som ett separat alternativ:

bash
dotnet add package Doconut.NETStandard --version 26.10.0

Doconut.NETStandard är paket-ID:t. Versionssuffixet tillhör den nedladdade Doconut.NETStandard.<version>.nupkg filnamnet och är inte en del av ID:t.

Versionsnumret är generationen

Detta är viktigare här än paketnamnet. Båda generationerna av .NET Standard-biblioteket publiceras under samma paket-ID, och endast versionen skiljer dem åt:

VersionMålAPI
26.7.0 och lägrenetstandard2.0den tidigare integrationen
26.8.0 och högrenetstandard2.1integrationen som dokumenteras här

Det finns ingen kompatibilitetsshim och inget sid‑by‑sid paket. Att höja versionen är uppgraderingen, och kompilatorn kommer omedelbart att rapportera API‑skillnaderna.

Välj inte dokumentation enbart baserat på paketnamnet:

  • new Viewer(_cache, _accessor, …), UnSafeMode, synkron OpenDocument(...), viewer.InitCache(), UseDoconutWebFarm, och manuellt kopierade visarskript identifierar den tidigare integrationen;
  • AddDoconut(), UseDoconutResources(), en injicerad Viewer, och OpenDocumentAsync(...) identifierar den nuvarande integrationen som dokumenteras här.

Den översatta tidigare installationsmanualen finns fortfarande tillgänglig. Använd migrationsguiden för att byta generation; en paketuppdatering konverterar inte start, visarlivstid eller webbläsarresurser automatiskt.

Registrera Doconut

AddDoconut() är den enda registreringsingångspunkten — det finns en enda överlagring, och den kopplar Viewer-tjänsten, licenstjänsten och renderingsinfrastrukturen till DI-behållaren.

Två middleware-anrop slutför konfigurationen, och deras ordning är viktig: UseDoconutResources() måste köras före UseDoconut(). UseDoconut() är terminal middleware, så att anropa den först innebär att varje begäran till en /doconut-res-resurs aldrig når resurshanteraren och ger 404. UseDoconut() svarar på varje begäran som når den, så montera den på sin egen gren med app.Map. Sessionskopplingen krävs också — Doconuts standarddokumentsäkerhet validerar varje sidbegäran mot ASP.NET:s sessionsstate.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath = "Doconut.Viewer.lic";
});
builder.Services.AddDistributedMemoryCache(); // session state behöver en cache (MVC/Razor Pages lägger redan till en)
builder.Services.AddSession(); // Doconut-dokumentsäkerhet bygger på ASP.NET session state

app.UseSession();          // anropa UseSession() innan UseDoconut()
app.UseDoconutResources(); // måste registreras innan UseDoconut()
app.Map("/doconut", branch => branch.UseDoconut());

Namnrymder

Konfigurationstyperna är inte längre spridda över fyra namnrymder. I denna release lever nästan allt i rotDoconut-namnrymden:

csharp
using Doconut;                       // Viewer, DoconutOptions, DocOptions, alla formatkonfigurationer
using Doconut.Middleware;            // AddDoconut, UseDoconut, UseDoconutResources
using Doconut.Clouds;                // moln- och fildelningskonfigurationer
using Doconut.Configs.Conversion;    // ConversionTarget

Typnamnen i sig har inte förändrats — PdfConfig, WordConfig, ExcelConfig, CssConfig, ScriptConfig och resten finns fortfarande. Om du flyttar en existerande applikation, behöver de flesta filer bara två borttagna using-rader; se migrationsguiden.

Alla alternativ

DoconutOptions accepterar följande inställbara egenskaper. Alla är valfria — standardvärdena nedan gäller när en egenskap lämnas odefinierad.

EgenskapStandardBeskrivning
ShowDoconutInfofalseNär true, returnerar en begäran utan token en versionsbanner istället för en 404. Användbart som en snabbkontroll; utelämna i produktion.
UnsafeModefalseNär true, hoppar över ASP.NET‑sessionsäkerhetskontrollen på sidbegäranden. Utelämna i produktion. Notera stavningen — det tidigare biblioteket kallade detta UnSafeMode.
MiddlewarePath"/doconut"Koordinationsvärde för slutpunkten page-image. Det valideras, men det skapar inte en gren i sig; håll det i linje med den faktiska UseDoconut()-mappningen och klienten BasePath.
ResourcesPath"/doconut-res"Var de inbäddade JS/CSS/bildresurserna serveras från.
LicensePath"" (tom sträng)Sökväg till licensfilen. Tom betyder att man faller igenom till nästa källa, sedan autosökning.
LicenseContent"" (tom sträng)Rå licensinnehåll — från en miljövariabel, en hemlighets‑hanterare eller en databas.
LicenseStreamnullLicens som en ström, läses en gång vid start.
ResetLicensefalseReserverad kompatibilitetsflagga. Licensen läses under AddDoconut(); starta om appen efter att ha ersatt en licens.
MaxConcurrentEditorSessions200Maximalt antal aktiva redigeringssessioner (dokument öppnade med DocOptions.EditMode). Överst stängs den minst nyligen använda inaktiva redigeringssessionen. Normala visarsessioner räknas aldrig. 0 eller ett negativt värde betyder ingen gräns.
EditorSnapshotEveryOps50Med redigerarpersistens aktiverad (AddDoconutEditorPersistence), ta en ögonblicksbild av det levande dokumentet var N:te registrerade förändring. 0 eller ett negativt värde tar aldrig ögonblicksbilder mitt i en session. Ingen effekt när persistens är inaktiverad.

Licensprioritet när mer än en källa är angiven: LicenseStream har företräde framför LicenseContent, som har företräde framför LicensePath, som har företräde framför autosökning — se Licensinställning.

csharp
builder.Services.AddDoconut(options =>
{
    options.LicensePath     = "Doconut.Viewer.lic";
    options.MiddlewarePath  = "/doconut";     // koordinera med app-mappning och klientens BasePath
    options.ResourcesPath   = "/doconut-res"; // var viewerns JS/CSS/bilder serveras från
    options.UnsafeMode      = false;          // behåll sessionssäkerhet på
    options.ShowDoconutInfo = false;
});

Nästa steg

  • Snabbstart — öppna ditt första dokument och rendera det i webbläsaren.
  • Licensinställning — där Doconut letar efter din licensfil.

Var den här sidan hjälpsam?