Visare
Den huvudsakliga dokumentvisarklassen
Viewer (namespace Doconut) är den offentliga ingångspunkten för att öppna dokument från MVC‑kontroller, Web Forms‑sidor och handlare. Det är en transient tjänst sammansatt av DoconutHost.Initialize; lös upp den där du använder den:
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();new Viewer() fungerar också när DoconutHost.Initialize har körts — den löser samma tjänster — vilket gör att kod som migrerats från det klassiska paketet kan kompileras. Före Initialize kastar den InvalidOperationException.
Viewer har ingen per‑förfrågan dokumenttillstånd och avsiktligt inte implementerar IDisposable: dokumentsessioner lever oberoende av den, så att avyttra en Viewer aldrig kan stänga ett öppet dokument (se Hur visaren fungerar).
OpenDocumentAsync
Öppnar ett dokument och returnerar sessionstoken som widgeten använder för varje senare begäran. När UnsafeMode är false (standard) beviljas token till ASP.NET‑sessionen för den aktuella begäran — anropa den från en begäran som har sessionsstatus (se Sessioner & Säkerhet).
| Överlagring | Använd när |
|---|---|
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default) | Öppning från disk med automatisk formatdetektering och formatets standardkonfiguration |
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default) | Du behöver per‑format renderingsalternativ (PdfConfig, WordConfig, …) |
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default) | Dokumentet är inte en fil på disk (en uppladdning, en databas, en blob). fileInfo måste ha rätt filändelse — den väljer formatet |
// Enkel öppning
string token = await viewer.OpenDocumentAsync(path);
// Med per-format konfiguration och alternativ
token = await viewer.OpenDocumentAsync(
path,
new PdfConfig { AllowSearch = true, AllowCopy = true },
new DocOptions { TimeOut = 30 });
// Från en uppladdning (HttpPostedFileBase i MVC; HttpPostedFile i Web Forms)
using (var ms = new MemoryStream())
{
await file.InputStream.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(Path.GetFileName(file.FileName)));
}Undantag att hantera:
LicenseException— en licens hittades men avslogs (meddelandet innehåller anledningen), eller så kräver formatet en plugin‑funktion som licensen inte beviljar.FormatNotSupportedException— ingen visare hanterar filens filändelse.InvalidDataException— innehållet är korrupt eller matchar inte dess filändelse.
OpenDocument (synkron)
För Web Forms‑kod bakom och annan kod som inte använder asynkrona sidor:
string OpenDocument(string filePath, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(Stream stream, string fileName, BaseConfig? config = null, DocOptions? options = null)
string OpenDocument(byte[] bytes, string fileName, BaseConfig? config = null, DocOptions? options = null)Var och en returnerar token och lagrar den också i viewer.Token. fileName måste ha rätt filändelse. Dessa omslag är säkra att anropa från en Web Forms‑sida: öppningsvägen återupptas aldrig på ASP.NET‑begärans kontext, så att vänta på den kan inte leda till deadlock. Det samma gäller inte för varje asynkron Doconut‑API — se Web Forms‑avsnittet i Konverterings‑plugin.
Stäng dokument
void CloseDocument(string token)Tar bort sessionen (frigör dokumentmotorn omedelbart), tar bort tokenens beviljning från den aktuella begärans ASP.NET‑session och återkallar tokenen. Valfritt — glidande utgång utför samma städning — men rekommenderas för stora dokument.
Sessionförfrågningar
| Medlem | Returnerar |
|---|---|
int GetPageCount(string token) | Totalt antal sidor i det öppna dokumentet |
(int Width, int Height) GetPageDimensions(string token, int page = 1) | Standard renderad sidstorlek vid 100 % zoom — koordinatrymden för annotationer som byggs i kod |
IReadOnlyList<string> GetWorksheetNames(string token) | Renderade kalkylblad i ett kalkylblad, i arbetsbokens ordning; tomt för andra dokument |
Varje kastar InvalidOperationException (Document session not found. Please re-open document.) om tokenen är okänd eller har gått ut, och ArgumentException för en tom token.
DocAlternativ
Per öppning, formatoberoende alternativ (namnutrymme Doconut):
| Typ | Egenskap | Standard | Beskrivning |
|---|---|---|---|
string | Password | "" | Lösenord för skyddade dokument (kopieras automatiskt till formatkonfigurationen). |
string | Watermark | "" | Anpassad vattenstämpeltext som ritas på renderade sidor — se nedan. |
int | TimeOut | 60 | Glidande sessionsexpiration, i minuter. |
string | BrowserId | "" | Webbfarmar: webbläsaren som en signerad biljett är bunden till. Ställ in den med DoconutFarmBinding.EnsureBrowserId (se Sessioner och säkerhet). |
string | UserId | "" | Webbfarmar: den inloggade användaren som en biljett är bunden till, från DoconutFarmBinding.ResolveUserId. |
int | ImageResolution | 0 | Föråldrad. Ställ in ImageResolution i formatkonfigurationen istället. |
bool | IsSecured | true | Reserverad; inte verkställd. Åtkomstkontrollen är DoconutOptions.UnsafeMode. |
bool | IsWebFarm / string WebFarmPath | false / "" | Behålls för kod som migrerats från det klassiska paketet. De slår inte på farm‑läget — AddDoconutDistributed gör det. |
bool | EditMode | false | Reserverad för den separat distribuerade editorn; lämna false. |
Anpassad vattenstämpel
DocOptions.Watermark tar emot sex tilde‑separerade fält. En valfri inledande ^ begär layout med alla hörn:
^Text~Color~FontSize~FontName~Opacity~Anglestring token = await viewer.OpenDocumentAsync(
path,
new PdfConfig(),
new DocOptions
{
Watermark = "^Confidential~Red~24~Verdana~80~-45",
TimeOut = 30
});| Fält | Exempel | Betydelse |
|---|---|---|
Inledande ^ | ^ | Valfri layout med alla hörn. Utan den används den normala placeringen. |
| Text | Confidential | Text som ritas på varje sida. Den får inte vara tom. |
| Färg | Red | En namngiven färg. |
| FontSize | 24 | Teckenstorlek; ogiltig numerisk inmatning faller tillbaka på standardvärdet. |
| FontName | Verdana | Teckensnittsfamilj. Den måste vara installerad på servern — Windows Server har färre teckensnitt än en skrivbordsmiljö. |
| Opacitet | 80 | 0 till 255. Den måste kunna parsas. |
| Vinkel | -45 | Rotation i grader; ogiltig numerisk inmatning faller tillbaka på standardvärdet. |
Parsern förväntar sig exakt sex fält efter den valfria ^. En ogiltig definition ersätts av en synlig Invalid Watermark‑text istället för att tyst försvinna.
Licensbeslut
| Licensstatus | Anpassat värde angivet | Renderat resultat |
|---|---|---|
| Giltig betald visningslicens | Nej | Ren sida |
| Giltig betald visningslicens | Ja | Anpassad vattenstämpel |
| Aktiv tillfällig/demo-licens | Nej | Ren sida |
| Aktiv tillfällig/demo-licens | Ja | Anpassad vattenstämpel |
| Saknad, avvisad, utgången, fel version eller ogiltig domänlicens | Ja/Nej | Utvärderingsvattenstämpel; det anpassade värdet ersätter den inte |
Samma beslut gäller för levererade sidor och för export av annotationer. En anpassad vattenstämpel är en funktion i en licensierad applikation, inte ett sätt att ersätta utvärderingsvattenstämpeln.
Annotations-API
Serverbaserad inläsning och export av annotationer. Genomgången finns i Annotationer.
| Medlem | Syfte |
|---|---|
AnnotationManager GetAnnotationManager(string token) | Manager som är bunden till den öppna sessionens sidimensioner |
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight) | Manager med explicit siddimension |
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight) | Sessionsoberoende manager |
void LoadAnnotationData(string token, AnnotationManager manager) | Läs in annotationer byggda i C# i sessionen |
void LoadAnnotationData(string token, string annotationData) | Läs in det kodade kuvertet som returneras av AnnotationManager.GetAnnotationData() |
void LoadAnnotationXML(string token, XmlDocument annotationXml) | Läs in annotationer från XML |
XmlDocument GetAnnotationXML(string token) | Exportera sessionens annotationer som XML |
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default) | PDF med inbrända annotationer |
Task<int> ExportAnnotationsToPngAsync(string token, string directoryPath, int zoom = 100, CancellationToken ct = default) | En PNG per sida, annotationer inbrända, skrivna till directoryPath (skapas om den saknas); returnerar antalet skrivna bilder |
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default) | ZIP med PNG-filer per sida med inbrända annotationer |
DICOM-metadata
Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)I det här paketet returneras alltid null, och widgetens metadataförfrågan svarar med 501 Not Implemented: att läsa DICOM-taggar är inte tillgängligt på .NET Framework. DICOM rendering — sidor, ramar och animation — fungerar. Se DICOM‑plugin.
Resurs‑hjälpare — ReferenceCss / ReferenceScripts
Generera <link>- och <script>-taggarna för resurserna som resursmodulen tillhandahåller under DoconutOptions.ResourcesPath, i beroendeordning. Filerna för licensstyrda funktioner (Search, Annotation) genereras endast när licensen beviljar dem.
string ReferenceCss(CssConfig? config = null) // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)
bool IsSearchEnabled { get; } // licensstatus, för att skydda ribbon init code
bool IsAnnotationEnabled { get; }CssConfig flaggor: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (sök‑styrda), IncludeAnnotationCss (annotation‑styrda).
ScriptConfig flaggor: IncludeJQuery (krävs av alla andra), IncludeBootstrap, IncludeViewerScripts (kärn‑visningsskripten), IncludeSearchScripts och IncludeSearchBar (sök‑styrda), IncludeAnnotationScripts och IncludeAnnotationBar (annotation‑styrda), EmitFeatureFlags (standard true: skriver också ett inline window.Doconut.features = { search, annotation, editor }‑script; sätt den till false under en Content‑Security‑Policy som blockerar inline‑script).
Båda returnerar HTML: skriv dem med @Html.Raw(...) i MVC 5 (generera dem i kontrollern — vyer har ingen @inject) eller <%= %> i Web Forms. Snabbstart visar båda.
RenderViewer
string RenderViewer(string elementId, string token, ViewerConfig? config = null)Returnerar ett <script>‑block som initierar widgeten på elementet med id elementId och visar dokumentet: docViewer({...}) byggt från ViewerConfig (standard: BasePath: '/', ResPath: 'doconut-res/images'), sedan .View(token). Skriv det efter visningsskripten. Det genererade skriptet behåller ingen referens till visningsobjektet, så en sida med egen verktygsrad bör initiera widgeten manuellt istället. Se ViewerConfig.
Webbfarm
string? AccessToken innehåller den signerade biljetten som utfärdats av den senast öppnade när distribuerat läge är aktivt och UnsafeMode är false; den är null på en enskild server. Skicka den till widgeten med token: objViewer.View(token, accessToken).
Var den här sidan hjälpsam?