Προβολέας
Η κύρια κλάση προβολής εγγράφων
Viewer (namespace Doconut) είναι το δημόσιο σημείο εισόδου για το άνοιγμα εγγράφων από σελίδες Razor, ελεγκτές MVC, συστατικά Blazor ή ελάχιστα APIs. Είναι sealed, καταχωρημένο ως transient υπηρεσία από AddDoconut(), και επιλύεται μέσω ένεσης κατασκευαστή — ποτέ μην το δημιουργείτε απευθείας.
Viewer δεν διατηρεί κατάσταση ανά αίτημα και σκόπιμα δεν υλοποιεί IDisposable: οι συνεδρίες εγγράφων ζουν ανεξάρτητα στην κρυφή μνήμη της συνεδρίας, έτσι η απελευθέρωση της υπηρεσίας δεν μπορεί ποτέ να τερματίσει ένα ανοικτό έγγραφο (δείτε τις Βασικές Έννοιες → Πώς Λειτουργεί ο Προβολέας).
OpenDocumentAsync (Άνοιγμα Εγγράφου Ασύγχρονα)
Ανοίγει ένα έγγραφο και επιστρέφει το διακριτικό συνεδρίας που χρησιμοποιεί το widget του πελάτη για όλες τις επόμενες αιτήσεις.
| Υπερφόρτωση | Χρήση όταν |
|---|---|
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 });
// Από μια μεταφόρτωση
await using var ms = new MemoryStream();
await file.CopyToAsync(ms);
ms.Position = 0;
token = await viewer.OpenDocumentAsync(ms, new FileInfo(file.FileName));Εξαιρέσεις προς διαχείριση:
LicenseException— μια βρεθείσα άδεια απορρίπτεται (το μήνυμα μεταφέρει τον λόγο απόρριψης), ή η μορφή χρειάζεται δυνατότητα plugin που δεν παρέχεται πλέον. Η λήξη του ημερολογίου χωρίς μήνυμα απόρριψης μετατρέπεται σε απόδοση με υδατογράφημα αντί για εξαίρεση.FormatNotSupportedException—Document format '<extension>' is not supported.InvalidDataException— το περιεχόμενο του αρχείου είναι κατεστραμμένο ή δεν ταιριάζει με την επέκτασή του.
CloseDocument (Κλείσιμο Εγγράφου)
void CloseDocument(string token)Αφαιρεί τη συνεδρία από τη μνήμη cache (απελευθερώνοντας τη μηχανή εγγράφου αμέσως), διαγράφει το δείκτη ασφαλείας και ανακαλεί την άδεια πρόσβασης. Προαιρετικό — η κυλιόμενη λήξη εκτελεί την ίδια εκκαθάριση — αλλά συνιστάται για μεγάλα έγγραφα.
GetPageCount (Αριθμός Σελίδων)
int GetPageCount(string token)Συνολικές σελίδες της ανοικτής συνεδρίας. Εμφανίζει εξαίρεση InvalidOperationException (Document session not found. Please re-open document.) εάν το διακριτικό είναι άγνωστο ή ληγμένο, και ArgumentException για κενό διακριτικό.
GetPageDimensions (Διαστάσεις Σελίδας)
(int Width, int Height) GetPageDimensions(string token, int page = 1)Το προεπιλεγμένο μέγεθος σελίδας του εγγράφου σε απόδοση 100 % ζουμ — ο χώρος συντεταγμένων για τις σημειώσεις που δημιουργούνται με κώδικα. page γίνεται αποδεκτό για συμβατότητα· το αποτέλεσμα είναι το προεπιλεγμένο του εγγράφου. Εμφανίζει εξαίρεση InvalidOperationException (Document session not found. Please re-open document.) εάν το διακριτικό είναι άγνωστο ή ληγμένο, και ArgumentException για κενό διακριτικό.
GetWorksheetNames
IReadOnlyList<string> GetWorksheetNames(string token)Επιστρέφει τα ονόματα των φύλλων εργασίας ενός ανοικτού υπολογιστικού φύλλου, με τη σειρά του βιβλίου εργασίας, ή μια κενή λίστα όταν το ανοικτό έγγραφο δεν είναι υπολογιστικό φύλλο.
Μόνο τα εμφανιζόμενα φύλλα εργασίας καταχωρούνται: τα κρυφά και κενά φύλλα εξαιρούνται, και όταν το ExcelConfig.SheetNames περιορίζει την απόδοση, εμφανίζονται μόνο αυτά τα φύλλα. Ένα φύλλο εργασίας δεν είναι πάντα μία σελίδα — ένα πολύ μεγάλο μπορεί να εμφανιστεί σε πολλές σελίδες. Εμφανίζει εξαίρεση InvalidOperationException (Document session not found. Please re-open document.) εάν το διακριτικό είναι άγνωστο ή ληγμένο, και ArgumentException για κενό διακριτικό.
Προστέθηκε στην έκδοση 26.9.0.
Σημαίες Δυνατοτήτων
| Μέλος | Σημασία |
|---|---|
bool IsSearchEnabled | Η τρέχουσα άδεια παρέχει Search |
bool IsAnnotationEnabled | Η τρέχουσα άδεια παρέχει Annotation |
Χρησιμοποιήστε τα σε μια Razor view για να αποδώσετε ένα αδειοδοτημένο Ribbon μόνο όταν ο διακομιστής θα το εξυπηρετήσει πραγματικά — δείτε Γρήγορη Εκκίνηση.
DocOptions
Επιλογές ανά άνοιγμα, ανεξάρτητες από μορφή (namespace Doconut):
| Τύπος | Ιδιότητα | Προεπιλογή | Περιγραφή |
|---|---|---|---|
string | Password | "" | Κωδικός πρόσβασης για προστατευμένα έγγραφα (αντιγράφεται αυτόματα στη ρύθμιση μορφής). |
int | ImageResolution | 0 | Παρωχημένο. Διατηρείται μόνο για συμβατότητα — ορίστε ImageResolution στη ρύθμιση μορφής αντί αυτού. |
string | Watermark | "" | Προσαρμοσμένο κείμενο υδατογράφησης που σχεδιάζεται στις αποδομένες σελίδες. Συμβολοσειρά μορφής: "^Text~Color~FontSize~FontName~Opacity~Angle", π.χ. "^Sample Copy~Red~24~Verdana~80~-45". |
int | TimeOut | 60 | Συνεχής λήξη συνεδρίας σε λεπτά. |
bool | IsSecured | true | Δεν επιβάλλεται επί του παρόντος — δεσμευμένο. Η σύνδεση διακριτικού ελέγχεται παγκοσμίως από DoconutOptions.UnsafeMode (δείτε τις Βασικές Έννοιες → Συνεδρίες & Ασφάλεια). |
Η κλάση εκθέτει επίσης εξειδικευμένες ιδιότητες που είναι σκόπιμα εκτός της κανονικής ροής προβολής ενός μόνο διακομιστή:
| Τύπος | Ιδιότητα | Προεπιλογή | Περιγραφή |
|---|---|---|---|
bool | IsWebFarm | false | Παρωχημένο — δεν έχει καμία επίδραση. Δημοσιεύστε το έγγραφο με DistributedDocumentPublisher.PublishAsync (ή IDistributedPublishQueue.EnqueueAsync) και ορίστε FileShareConfig.RootPath αντί αυτού. |
string | WebFarmPath | "" | Παρωχημένο — δεν έχει καμία επίδραση. Χρησιμοποιήστε FileShareConfig.RootPath αντί αυτού. |
bool | EditMode | false | Δεσμευμένο για τη ροή εργασίας του ξεχωριστά διανεμημένου Editor· αφήστε το 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
});| Πεδίο | Παράδειγμα | Σημασία |
|---|---|---|
Αρχικό ^ | ^ | Προαιρετική διάταξη σε όλες τις γωνίες. Χωρίς αυτό, χρησιμοποιείται η κανονική τοποθέτηση υδατογραφήματος. |
| Κείμενο | Confidential | Κείμενο που αποδίδεται σε κάθε σελίδα. Δεν πρέπει να είναι κενό. |
| Χρώμα | Red | Ονομαστικό χρώμα που κατανοείται από το επίπεδο σχεδίασης. |
| ΜέγεθοςΓραμματοσειράς | 24 | Μέγεθος γραμματοσειράς· εσφαλμένη αριθμητική είσοδος επανέρχεται στην προεπιλογή του αποδοχέα. |
| ΌνομαΓραμματοσειράς | Verdana | Ζητούμενη οικογένεια γραμματοσειράς. Βεβαιωθείτε ότι είναι εγκατεστημένη στο περιβάλλον ανάπτυξης. |
| Αδιαφάνεια | 80 | Τιμή byte από 0 έως 255. Πρέπει να αναλυθεί επιτυχώς. |
| Γωνία | -45 | Γωνία περιστροφής σε μοίρες· εσφαλμένη αριθμητική είσοδος επανέρχεται στην προεπιλογή. |
Ο αναλυτής αναμένει ακριβώς έξι πεδία μετά το προαιρετικό ^. Μια μη έγκυρη ορισμός αντικαθίσταται από το ορατό fallback του SDK Invalid Watermark αντί να εξαφανιστεί σιωπηρά.
Απόφαση άδειας
| Κατάσταση άδειας | Παρεχόμενη προσαρμοσμένη τιμή | Αποτέλεσμα απόδοσης |
|---|---|---|
| Έγκυρη πληρωμένη άδεια προβολέα | Όχι | Καθαρή σελίδα |
| Έγκυρη πληρωμένη άδεια προβολέα | Ναι | Προσαρμοσμένο υδατογράφημα |
| Ενεργός προσωρινός/δείγματος βασικός προβολέας | Όχι | Καθαρή σελίδα βασικού προβολέα |
| Ενεργός προσωρινός/δείγματος βασικός προβολέας | Ναι | Προσαρμοσμένο υδατογράφημα όταν εφαρμόζεται η διαδρομή καθαρής βασικής προβολής |
| Απουσία, απόρριψη, λήξη, λάθος έκδοση ή άδεια μη έγκυρου domain | Οποιοδήποτε | Υδατογράφημα επιβολής/αξιολόγησης· η προσαρμοσμένη τιμή δεν την αντικαθιστά |
| Απόδοση plugin υπό κανόνες αξιολόγησης | Οποιοδήποτε | Υδατογράφημα αξιολόγησης |
Η ίδια απόφαση εφαρμόζεται στις εικόνες σελίδων που εξυπηρετούνται και στις εξαγωγές σχολίων. Η έξοδος Animated GIF σφραγίζεται καρέ‑καρέ. Έτσι, ένα προσαρμοσμένο υδατογράφημα είναι χαρακτηριστικό αδειοδοτημένης εφαρμογής, όχι τρόπος αντικατάστασης ή καταστολής του υδατογραφήματος αξιολόγησης.
API Σημειώσεων
Φόρτωση και εξαγωγή σημειώσεων στο διακομιστή. Η πλήρης περιήγηση βρίσκεται στα Guides → Annotations· η επιφάνεια είναι:
| Μέλος | Σκοπός |
|---|---|
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) | Φόρτωση σημειώσεων από την κωδικοποιημένη σελίδα/Base64 φάκελο που επιστρέφεται από 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)Η μέθοδος υπάρχει για ευθυγράμμιση του API, αλλά ο προβολέας DICOM .NET 6 δεν μπορεί να παρέχει τεχνικές ετικέτες. Επιστρέφει null για συνεδρίες DICOM και μη‑DICOM· σε συνεδρία DICOM γράφει επίσης μια εφάπαξ προειδοποίηση που εξηγεί τον περιορισμό της πλατφόρμας. Η απόδοση σελίδας, πλαισίου και animation παραμένει υποστηριζόμενη.
Βοηθοί πόρων — ReferenceCss / ReferenceScripts
Εκπέμπετε τις ετικέτες <link>/<script> για τους ενσωματωμένους πόρους που εξυπηρετούνται από UseDoconutResources(), με τη σωστή σειρά εξαρτήσεων. Τα πακέτα για λειτουργίες με περιορισμό άδειας όπως η αναζήτηση και η σημείωση εκδίδονται μόνο όταν η άδεια τις ενεργοποιεί, διατηρώντας το UI του πελάτη συνεπές με τη συμπεριφορά του διακομιστή.
string ReferenceCss(CssConfig? config = null) // null → Bootstrap + viewer + search + annotation
string ReferenceScripts(ScriptConfig? config = null)Σημαίες CssConfig: IncludeBootstrapCss, IncludeViewerCss, IncludeSearchCss (με περιορισμό αναζήτησης), IncludeAnnotationCss (με περιορισμό σημείωσης).
Σημαίες ScriptConfig: IncludeJQuery (απαιτείται από όλα τα άλλα), IncludeBootstrap, IncludeViewerScripts (πυρήνας: docViewer.js + splitter + links), IncludeSearchScripts και IncludeSearchBar (με περιορισμό αναζήτησης), IncludeAnnotationScripts και IncludeAnnotationBar (με περιορισμό σημείωσης), EmitFeatureFlags (προεπιλογή true: επίσης γράφει ένα ενσωματωμένο script window.Doconut.features = { search, annotation, editor }· ορίστε το σε false υπό Content‑Security‑Policy που μπλοκάρει ενσωματωμένα script).
@inject Doconut.Viewer Viewer
@Html.Raw(Viewer.ReferenceCss(new CssConfig { IncludeBootstrapCss = true, IncludeViewerCss = true }))
@Html.Raw(Viewer.ReferenceScripts(new ScriptConfig { IncludeJQuery = true, IncludeViewerScripts = true }))Ήταν αυτή η σελίδα χρήσιμη;