Προβολέας
Η κύρια κλάση προβολής εγγράφων
Viewer (namespace Doconut) είναι το δημόσιο σημείο εισόδου για το άνοιγμα εγγράφων από ελεγκτές MVC, σελίδες Web Forms και χειριστές. Είναι μια transient υπηρεσία που συντίθεται από DoconutHost.Initialize· επιλύστε την όπου τη χρησιμοποιείτε:
var viewer = Doconut.DoconutHost.Services.GetRequiredService<Viewer>();new Viewer() λειτουργεί επίσης μόλις εκτελεστεί DoconutHost.Initialize — επιλύει τις ίδιες υπηρεσίες — κάτι που διατηρεί τον κώδικα που έχει μεταφερθεί από το κλασικό πακέτο σε λειτουργία. Πριν από Initialize, πετάει InvalidOperationException.
Viewer δεν διατηρεί κατάσταση εγγράφου ανά αίτηση και σκόπιμα δεν υλοποιεί IDisposable: οι συνεδρίες εγγράφων ζουν ανεξάρτητα από αυτήν, έτσι η απελευθέρωση ενός Viewer δεν μπορεί ποτέ να κλείσει ένα ανοιχτό έγγραφο (δείτε Πώς λειτουργεί ο Viewer).
OpenDocumentAsync
Ανοίγει ένα έγγραφο και επιστρέφει το διακριτικό συνεδρίας που χρησιμοποιεί το widget για κάθε επόμενη αίτηση. Όταν UnsafeMode είναι false (η προεπιλογή), το διακριτικό χορηγείται στη συνεδρία ASP.NET της τρέχουσας αίτησης — καλέστε το από μια αίτηση που έχει κατάσταση συνεδρίας (δείτε Συνεδρίες & Ασφάλεια).
| Υπερφόρτωση | Χρήση όταν |
|---|---|
Task<string> OpenDocumentAsync(string filePath, DocOptions? options = null, CancellationToken ct = default) | Άνοιγμα από δίσκο με αυτόματη ανίχνευση μορφής και την προεπιλεγμένη διαμόρφωση της μορφής |
Task<string> OpenDocumentAsync(string filePath, BaseConfig? config, DocOptions? options = null, CancellationToken ct = default) | Χρειάζεστε επιλογές απόδοσης ανά μορφή (PdfConfig, WordConfig, …) |
Task<string> OpenDocumentAsync(Stream stream, FileInfo fileInfo, BaseConfig? config = null, DocOptions? options = null, CancellationToken ct = default) | Το έγγραφο δεν είναι αρχείο στο δίσκο (μεταφόρτωση, βάση δεδομένων, blob). fileInfo πρέπει να περιέχει τη σωστή επέκταση — επιλέγει τη μορφή |
// Απλό άνοιγμα
string token = await viewer.OpenDocumentAsync(path);
// Με διαμόρφωση και επιλογές ανά μορφή
token = await viewer.OpenDocumentAsync(
path,
new PdfConfig { AllowSearch = true, AllowCopy = true },
new DocOptions { TimeOut = 30 });
// Από μεταφόρτωση (HttpPostedFileBase in MVC; HttpPostedFile in 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)));
}Εξαιρέσεις προς διαχείριση:
LicenseException— βρέθηκε άδεια αλλά απορρίφθηκε (το μήνυμα περιέχει τον λόγο), ή η μορφή χρειάζεται δυνατότητα plugin που η άδεια δεν παρέχει.FormatNotSupportedException— κανένας viewer δεν διαχειρίζεται την επέκταση του αρχείου.InvalidDataException— το περιεχόμενο είναι κατεστραμμένο ή δεν ταιριάζει με την επέκταση του.
OpenDocument (συγχρονικό)
Για κώδικα πίσω από Web Forms και άλλον κώδικα που δεν χρησιμοποιεί ασύγχρονες σελίδες:
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)Κάθε μία επιστρέφει το διακριτικό και επίσης το αποθηκεύει στο viewer.Token. fileName πρέπει να περιέχει τη σωστή επέκταση. Αυτά τα wrappers είναι ασφαλή για κλήση από μια σελίδα Web Forms: η διαδρομή ανοίγματος δεν επανεκκινείται ποτέ στο πλαίσιο αίτησης ASP.NET, έτσι η αναμονή δεν μπορεί να προκαλέσει deadlock. Το ίδιο δεν ισχύει για κάθε ασύγχρονο Doconut API — δείτε το τμήμα Web Forms του Πρόσθετο Μετατροπέα.
Κλείσιμο εγγράφου
void CloseDocument(string token)Αφαιρεί τη συνεδρία (απελευθερώνοντας αμέσως τη μηχανή εγγράφου), αφαιρεί την άδεια του διακριτικού από τη συνεδρία ASP.NET του τρέχοντος αιτήματος και ανακαλεί το διακριτικό. Προαιρετικό — η κυλιόμενη λήξη εκτελεί τον ίδιο καθαρισμό — αλλά συνιστάται για μεγάλα έγγραφα.
Ερωτήματα συνεδρίας
| Μέλος | Επιστρέφει |
|---|---|
int GetPageCount(string token) | Συνολικές σελίδες του ανοιχτού εγγράφου |
(int Width, int Height) GetPageDimensions(string token, int page = 1) | Προεπιλεγμένο μέγεθος σελίδας που αποδίδεται στο 100% ζουμ — ο χώρος συντεταγμένων για σημειώσεις ενσωματωμένες στον κώδικα |
IReadOnlyList<string> GetWorksheetNames(string token) | Οι αποδιδόμενες φύλλα εργασίας ενός λογιστικού φύλλου, με σειρά βιβλίου εργασίας· κενό για άλλα έγγραφα |
Κάθε μία ρίχνει InvalidOperationException (Document session not found. Please re-open document.) εάν το διακριτικό είναι άγνωστο ή έχει λήξει, και ArgumentException για κενό διακριτικό.
Επιλογές εγγράφου
Επιλογές ανά άνοιγμα, ανεξάρτητες από μορφή (namespace Doconut):
| Τύπος | Ιδιότητα | Προεπιλογή | Περιγραφή |
|---|---|---|---|
string | Password | "" | Κωδικός πρόσβασης για προστατευμένα έγγραφα (αντιγράφεται αυτόματα στη διαμόρφωση μορφής). |
string | Watermark | "" | Προσαρμοσμένο κείμενο υδατογραφήματος που σχεδιάζεται στις αποδιδόμενες σελίδες — δείτε παρακάτω. |
int | TimeOut | 60 | Κυλιόμενη λήξη συνεδρίας, σε λεπτά. |
string | BrowserId | "" | Web farms: το πρόγραμμα περιήγησης στο οποίο δεσμεύεται ένα υπογεγραμμένο εισιτήριο. Ορίστε το με DoconutFarmBinding.EnsureBrowserId (δείτε Συνεδρίες & Ασφάλεια). |
string | UserId | "" | Web farms: ο συνδεδεμένος χρήστης στον οποίο δεσμεύεται ένα εισιτήριο, από DoconutFarmBinding.ResolveUserId. |
int | ImageResolution | 0 | Παρωχημένο. Ορίστε ImageResolution στη διαμόρφωση μορφής αντί αυτού. |
bool | IsSecured | true | Καθορισμένο; δεν επιβάλλεται. Ο έλεγχος πρόσβασης είναι DoconutOptions.UnsafeMode. |
bool | IsWebFarm / string WebFarmPath | false / "" | Κρατείται για κώδικα που μετοχίστηκε από το κλασικό πακέτο. Δεν ενεργοποιούν τη λειτουργία farm — AddDoconutDistributed το κάνει. |
bool | EditMode | false | Καθορισμένο για τον ξεχωριστά διανεμημένο επεξεργαστή· αφήστε false. |
Προσαρμοσμένο υδατογράφημα
DocOptions.Watermark λαμβάνει έξι πεδία χωρισμένα με tilde. Ένα προαιρετικό αρχικό ^ ζητά τη διάταξη σε όλες τις γωνίες:
^Text~Color~FontSize~FontName~Opacity~Anglestring token = await viewer.OpenDocumentAsync(
path,
new PdfConfig(),
new DocOptions
{
Watermark = "^Confidential~Red~24~Verdana~80~-45",
TimeOut = 30
});| Πεδίο | Παράδειγμα | Νόημα |
|---|---|---|
Αρχικό ^ | ^ | Προαιρετική διάταξη σε όλες τις γωνίες. Χωρίς αυτήν, χρησιμοποιείται η κανονική τοποθέτηση. |
| Text | Confidential | Κείμενο που σχεδιάζεται σε κάθε σελίδα. Δεν πρέπει να είναι κενό. |
| Color | Red | Ένα ονομαστικό χρώμα. |
| FontSize | 24 | Μέγεθος γραμματοσειράς· εσφαλμένη αριθμητική είσοδος επιστρέφει στην προεπιλογή. |
| FontName | Verdana | Οικογένεια γραμματοσειράς. Πρέπει να είναι εγκατεστημένη στον διακομιστή — το Windows Server έχει λιγότερες γραμματοσειρές από έναν υπολογιστή. |
| Opacity | 80 | 0 έως 255. Πρέπει να αναλυθεί. |
| Angle | -45 | Περιστροφή σε μοίρες· εσφαλμένη αριθμητική είσοδος επιστρέφει στην προεπιλογή. |
Ο αναλυτής αναμένει ακριβώς έξι πεδία μετά το προαιρετικό ^. Μια μη έγκυρη ορισμός αντικαθίσταται από ορατό κείμενο Invalid Watermark αντί να εξαφανίζεται σιωπηλά.
Απόφαση άδειας
| Κατάσταση άδειας | Προσαρμοσμένη τιμή παρεχόμενη | Αποτέλεσμα απόδοσης |
|---|---|---|
| Έγκυρη πληρωμένη άδεια προβολέα | Όχι | Καθαρή σελίδα |
| Έγκυρη πληρωμένη άδεια προβολέα | Ναι | Προσαρμοσμένο υδατογράφημα |
| Ενεργή προσωρινή/δοκιμαστική άδεια | Όχι | Καθαρή σελίδα |
| Ενεργή προσωρινή/δοκιμαστική άδεια | Ναι | Προσαρμοσμένο υδατογράφημα |
| Άδεια που λείπει, απορρίπτεται, έχει λήξει, λάθος έκδοση ή μη έγκυρο domain | Οποιαδήποτε | Υδατογράφημα αξιολόγησης· η προσαρμοσμένη τιμή δεν την αντικαθιστά |
Η ίδια απόφαση ισχύει για τις σελίδες που σερβίρονται και για τις εξαγωγές σημειώσεων. Ένα προσαρμοσμένο υδατογράφημα είναι λειτουργία μιας αδειοδοτημένης εφαρμογής, όχι τρόπος αντικατάστασης του υδατογραφήματος αξιολόγησης.
API Σχολίων
Φόρτωση και εξαγωγή σχολίων στην πλευρά του διακομιστή. Η περιήγηση βρίσκεται στο Σχόλια.
| Μέλος | Σκοπός |
|---|---|
AnnotationManager GetAnnotationManager(string token) | Διαχειριστής δεσμευμένος στις διαστάσεις σελίδας της ανοιχτής συνεδρίας |
AnnotationManager GetAnnotationManager(string token, int pageWidth, int pageHeight) | Διαχειριστής με ρητές διαστάσεις σελίδας |
AnnotationManager GetAnnotationManager(int pageWidth, int pageHeight) | Διαχειριστής ανεξάρτητος από τη συνεδρία |
void LoadAnnotationData(string token, AnnotationManager manager) | Φόρτωση σχολίων που δημιουργήθηκαν σε C# στη συνεδρία |
void LoadAnnotationData(string token, string annotationData) | Φόρτωση του κωδικοποιημένου φακέλου που επέστρεψε το AnnotationManager.GetAnnotationData() |
void LoadAnnotationXML(string token, XmlDocument annotationXml) | Φόρτωση σχολίων από XML |
XmlDocument GetAnnotationXML(string token) | Εξαγωγή των σχολίων της συνεδρίας ως XML |
Task<byte[]> ExportAnnotationsToPdfAsync(string token, int zoom = 100, CancellationToken ct = default) | PDF με ενσωματωμένα σχόλια |
Task<int> ExportAnnotationsToPngAsync(string token, string directoryPath, int zoom = 100, CancellationToken ct = default) | Ένα PNG ανά σελίδα, σχόλια ενσωματωμένα, γράφεται στο directoryPath (δημιουργείται αν λείπει); επιστρέφει τον αριθμό των εικόνων που γράφτηκαν |
Task<byte[]> ExportAnnotationsToPngZipAsync(string token, int zoom = 100, CancellationToken ct = default) | ZIP με PNG ανά σελίδα με ενσωματωμένα σχόλια |
Μεταδεδομένα DICOM
Task<DicomMetadata?> GetDicomMetadataAsync(string token, CancellationToken ct = default)Σε αυτό το πακέτο επιστρέφει πάντα null, και η αίτηση μεταδεδομένων του widget απαντά με 501 Not Implemented: η ανάγνωση ετικετών DICOM δεν είναι διαθέσιμη στο .NET Framework. Η απόδοση DICOM — σελίδες, καρέ και animation — λειτουργεί. Δείτε το Πρόσθετο DICOM.
Βοηθοί πόρων — ReferenceCss / ReferenceScripts
Εκπέμπει τις ετικέτες <link> και <script> για τους πόρους που εξυπηρετεί η μονάδα πόρων κάτω από το DoconutOptions.ResourcesPath, με τη σωστή σειρά εξαρτήσεων. Τα αρχεία για λειτουργίες που περιορίζονται από άδεια (Search, Annotation) εκδίδονται μόνο όταν η άδεια τα παρέχει.
string ReferenceCss(CssConfig? config = null) // null → Bootstrap + προβολέας + αναζήτηση + σχόλιο
string ReferenceScripts(ScriptConfig? config = null)
bool IsSearchEnabled { get; } // κατάσταση άδειας, για την προστασία του κώδικα init ribbon
bool IsAnnotationEnabled { get; }Σημαίες CssConfig: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (με περιορισμό αναζήτησης), IncludeAnnotationCss (με περιορισμό σχολίων).
Σημαίες ScriptConfig: IncludeJQuery (απαιτείται από όλα τα άλλα), IncludeBootstrap, IncludeViewerScripts (τα βασικά σενάρια του προβολέα), IncludeSearchScripts και IncludeSearchBar (με περιορισμό αναζήτησης), IncludeAnnotationScripts και IncludeAnnotationBar (με περιορισμό σχολίων), EmitFeatureFlags (προεπιλογή true: επίσης γράφει ένα ενσωματωμένο σενάριο window.Doconut.features = { search, annotation, editor }· ορίστε το σε false υπό μια Πολιτική Ασφάλειας Περιεχομένου που μπλοκάρει ενσωματωμένα σενάρια).
Και οι δύο επιστρέφουν HTML: γράψτε τα με @Html.Raw(...) στο MVC 5 (δημιουργήστε τα στον ελεγκτή — οι προβολές δεν έχουν @inject) ή με <%= %> σε Web Forms. Η Γρήγορη Εκκίνηση δείχνει και τις δύο προσεγγίσεις.
RenderViewer
string RenderViewer(string elementId, string token, ViewerConfig? config = null)Επιστρέφει ένα μπλοκ <script> που αρχικοποιεί το widget στο στοιχείο με id elementId και εμφανίζει το έγγραφο: docViewer({...}) που δημιουργείται από το ViewerConfig (προεπιλογή: BasePath: '/', ResPath: 'doconut-res/images'), έπειτα .View(token). Τοποθετήστε το μετά τα σενάρια του προβολέα. Το παραγόμενο σενάριο δεν διατηρεί αναφορά στο αντικείμενο του προβολέα, οπότε μια σελίδα με δικό της toolbar πρέπει να αρχικοποιήσει το widget χειροκίνητα. Δείτε τη Διαμόρφωση Προβολέα.
Δίκτυο διακομιστών
Το string? AccessToken περιέχει το υπογεγραμμένο εισιτήριο που εκδόθηκε από το πιο πρόσφατο άνοιγμα όταν η κατανεμημένη λειτουργία είναι ενεργή και το UnsafeMode είναι false· είναι null σε έναν μοναδικό διακομιστή. Στείλτε το στο widget με το διακριτικό: objViewer.View(token, accessToken).
Ήταν αυτή η σελίδα χρήσιμη;