תוסף ממיר
המרת מסמכים ל-45 פורמטים
תוסף הממיר הופך את Doconut לשירות המרת מסמכים. הוא תורם את המנוע מאחורי הממשק הציבורי DocumentConverter, ו‑— במצב opt-in — וידג'ט נשלף עם חוזה HTTP משלו, כך שאתה יכול להמיר מסמכים מ‑C#, מהוידג'ט, או מממשק קדמי שאתה כותב בעצמך.
| ממשק | מתי להשתמש |
|---|---|
DocumentConverter (C#) | אתה ממיר בשרת, ללא דפדפן |
Drop-in widget (doconutConverter.js) | אתה רוצה מסך העלאה, המרה והורדה מוכן מראש בדף שלך |
HTTP endpoints (?convert=open|run|download) | אתה בונה ממשק המרה משלך נגד חוזה שרת מתועד |
התקנת החבילה
התקן את תוסף הממיר היציב האחרון:
dotnet add package Doconut.NET6.Converterכדי לקבע את התוסף לגרסה שהמסמך מתאר, העבר את הגרסה בנפרד:
dotnet add package Doconut.NET6.Converter --version 26.10.0שמור על חבילת הממיר באותה גרסה כמו Doconut.NET6. מזהה החבילה הוא
Doconut.NET6.Converter; .<version> מופיע רק בשם הקובץ שהורד .nupkg.
קובץ הרישיון של התוסף, Doconut.Viewer.Converter.lic, נמצא באותו תיקייה כמו Doconut.Viewer.lic; הוא נקרא יחד עם רישיון הצופה.
פלטפורמות. התוסף פועל בכל מקום שבו Doconut.NET6 פועל: Windows, ולינוקס מבוסס glibc על x64 (לא Alpine או הפצות אחרות מבוססות musl). בלינוקס, התקן את ספריית תצורת הגופנים לפני שהמסמך הראשון נפתח:
apt-get update && apt-get install -y libfontconfig1ב‑RHEL, Fedora והפצות דומות החבילה היא fontconfig. ללא זאת, פתיחת מסמך נכשלת עם The system library libfontconfig1 is missing. Install it (Debian/Ubuntu: apt-get install -y libfontconfig1) and see the Linux section of the Doconut documentation.
רישום התוסף
אין שיטה AddConverter() — מודל הפלאגינים של Doconut הוא אחיד. כל פלאגין, כולל הממיר, נרשם באותו אופן: קרא AddPlugin<TPlugin>() בתוך AddDoconut(). ConverterPlugin מגיע בחבילה משלו של NuGet, Doconut.NET6.Converter, מותקן לצד חבילת הצופה הבסיסית.
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
});זה כל מה שהממשק C# צריך. הווידג'ט והקצוות HTTP שלו הם opt‑in נפרד, AddConverterWidget() (ראה וידג'ט נשלף).
התוסף צריך רישיון שמעניק את היכולת Converter. ללא רישיון, AddDoconut() זורק InvalidOperationException בעת ההפעלה, לפני שהאפליקציה מגישה בקשה:
The Converter plugin is registered via AddPlugin but no active license grants Converter. Remove the AddPlugin<...>() call or install a license (or trial/demo) that includes Converter.זה נזרק כאשר אין רישיון, קובץ TRIAL ישן, רישיון ללא Converter, ורישיון בתשלום שמופעל מחוץ לחלון הגרסה שלו. רישיונות Demo/NFR זמניים מתקבלים. אין רמת חינם שקטה. ראה הגדרת רישיון כדי להבין איך רישיונות נטענים.
רישוי & סימן מים
| מצב רישיון | הפעלה | תוצר המרה |
|---|---|---|
רישיון צופה בתשלום המעניק Converter, בתוך חלון הגרסה שלו | מתחיל | נקי — watermarked: false |
| רישיון זמני פעיל (Demo/NFR) | מתחיל | ממיר, עם סימן המים של ההערכה — watermarked: true |
| רישיון זמני פג תוקף (Demo/NFR) | מתחיל | ממיר, עם סימן המים של ההערכה — watermarked: true |
אין רישיון, קובץ TRIAL ישן, רישיון ללא Converter, או רישיון בתשלום מחוץ לחלון הגרסה שלו | AddDoconut() זורק | — |
שתי דרכי הקריאה מחשבות את הדגל מאותו כלל: הממשק C# של DocumentConverter מפיק אותו פנימית ממצב IsViewerLicensed ו‑IsTemporary של הרישיון, והמתמודד ?convert=run של הווידג'ט מבצע את הבדיקה המקבילה (IsViewerLicensed && !IsTrial && !IsTemporary) כדי למלא את השדה watermarked שהוא מחזיר. ניתן לבנות ולבדוק אינטגרציה מקצה לקצה ברישיון הערכה לפני רכישה — רק בתים הפלט משתנים.
מקור DICOM (.dcm, .ima) גם הוא זקוק ליכולת Dicom. ללא זאת, ConvertAsync זורק LicenseException (Converting '.dcm' requires the Dicom capability license.) והווידג'ט open משיב 403.
שימוש ב‑C#
כל המרה מחזירה MemoryStream ניתנת לחיפוש ממוקמת ב‑0, מוכנה לקריאה או העתקה מיידית. יש לפתור את DocumentConverter מה‑DI בכל מקום שבו אתה צריך אותו — הוא חסר מצב בתכנון, ולכן ניתן להשתמש במופע יחיד בבטחה בין בקשות.
// הזרק DocumentConverter; הבנאי שלו פנימי, ולכן לעולם אל תשתמש ב-`new`.
Stream pdf = await converter.ConvertAsync("contract.docx", ConversionTarget.Pdf, ct: ct);// sourceExtension כולל את הנקודה המקדימה. password הוא null אלא אם המסמך מוגן.
Stream png = await converter.ConvertAsync(stream, ".xlsx", ConversionTarget.Png, password: null, ct: ct);Stream html = await converter.WordToHtmlAsync("report.docx", ct);// html: Stream שמחזיק את ה-HTML כדי להפוך בחזרה למסמך Word, כגון התוצאה של WordToHtmlAsync.
Stream docx = await converter.HtmlToWordAsync(html, ConversionTarget.Docx, ct);שתי פרטים שקל לטעות בהם: sourceExtension ב‑overload של ה‑stream חייב לכלול את הנקודה המקדימה (".xlsx", ולא "xlsx") — הממיר משווה זאת מול קטלוג הפורמטים והרחבה ללא נקודה לא תיפתר. ולמרות שמו, WordToHtmlAsync מחזיר Task<Stream>, ולא Task<string> — אתה מקבל את מסמך ה‑HTML (תמונות משובצות כ‑Base64) כ‑stream, בדיוק כמו כל תוצאה אחרת של המרה.
הקורא הוא הבעלים של ה‑stream שהוחזר ויש לפנות אותו לאחר ההעתקה או החזרת התוכן שלו. השירות DocumentConverter עצמו נפתר מה‑dependency injection; אל תיצור או תפרק אותו ידנית.
פורמטים יעד
ConversionTarget (מרחב שמות Doconut.Configs.Conversion) מכיל 45 חברים:
Pdf, Docx, Doc, Html, Xlsx, Pptx, Png, Jpeg, Csv, Tiff, Bmp, Gif, Svg, Xml,
Txt, Xls, Jp2, Rtf, Odt, Ods, Odp, Epub, Xps, Webp, Msg, Eml, Emlx, Mhtml,
Xlsm, Xlsb, Ppt, Docm, Dot, Dotx, Dotm, Vsdx, Vssx, Vstx, Vsdm, Vssm, Vstm,
Vdx, Vsx, Vtx, Icoלא כל מקור מתורגם לכל יעד — התוסף ממפה כל משפחת פורמט של מקור (Word, Excel, PowerPoint, PDF, CAD, Image, Email, Diagram, Project/Task, PSD, מסמך אינטרנט, DICOM) למערך הקבוע של יעדים מותרים. המרת מקור DICOM (.dcm, .ima) דורשת גם רישיון שמעניק את היכולת Dicom; היעדים שלו הם Pdf, Png, Jpeg, Bmp, Tiff ו‑Gif. אל תקודד קבוע את המונה הזה כרשימת היעדים של הממשק שלך: ?convert=open מחזיר את ה‑allowedTargets האמיתי עבור כל קובץ שהועלה זה עתה, וזה מה שצריך להניע את הבחירה.
וידג'ט מוטמע
הפעלת נקודות הקצה
נקודות הקצה ?convert=open|run|download של הוידג'ט הן אופציונליות ומושבתות כברירת מחדל — מאובטחות כברירת מחדל. הפעל אותן בצד השרת, יחד עם רישום התוסף:
builder.Services.AddDoconut(options =>
{
options.LicensePath = "Doconut.Viewer.lic";
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddConverterWidget(widget =>
{
widget.MaxUploadMb = 25;
});
});AddConverterWidget() ללא ארגומנט מפעיל את הוידג'ט עם ברירות המחדל (MaxUploadMb = 25). הוא אינו מעניק זכויות המרה בעצמו: הוא זקוק ל‑AddPlugin<ConverterPlugin>(), או ש‑AddDoconut() זורק:
AddConverterWidget() was called but the Converter plugin is not registered. Add options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>() (the widget needs it), or remove the AddConverterWidget() call.בלי AddConverterWidget(), שלוש נקודות הקצה ?convert= משיבות 404 — אך קובץ ה‑JS עצמו עדיין מוגש בכל מקרה (זהו משאב סטטי משובץ פשוט; רק נקודות הקצה אליהן הוא מתקשר מגודרות).
הטמעה
<div id="doconut-convert"></div>
<script src="/doconut-res/js/doconutConverter.js"></script>
<script>
Doconut.convert('#doconut-convert', { basePath: '/doconut', resPath: '/doconut-res', maxUploadMb: 25 });
</script>Doconut.convert(selectorOrElement, options) מקבל בחירת CSS או אלמנט, זורק שגיאה אם המיקום לא נמצא, ומחזיר מצביע. הוידג'ט מעלה קובץ, מציג תצוגה מקדימה של דף 1, מאפשר למשתמש לבחור אחד מה‑allowedTargets, ממיר, מציג תצוגה מקדימה של התוצאה כשזה אפשרי, ומציע את ההורדה.
אפשרויות
| אפשרות | סוג | ברירת מחדל | הערות |
|---|---|---|---|
basePath | string | /doconut | נתיב הבסיס עבור נקודות הקצה של ?convert=; הוא חייב להתאים לענף ASP.NET שבו UseDoconut() מותקן בפועל (בדרך כלל מתואם דרך MiddlewarePath) |
resPath | string | /doconut-res | מתקבל לצורך עקביות תצורה עם וידג'טים אחרים של Doconut; וידג'ט הממיר כרגע אינו בונה שום URL ממנו |
maxUploadMb | number | 25 | בדיקה מוקדמת בצד הלקוח בלבד — דוחה קובץ גדול מדי לפני ההעלאה. השרת אוכף את המגבלה שלו באופן עצמאי ומשיב 413 אם היא חורגת |
licenseUrl | string | null | null | כאשר מוגדר, הופך את הודעת סימן המים על מסך התוצאה לקישור ל‑URL זה |
labels | object | {} | עוקף כל תת‑קבוצה של המחרוזות באנגלית המוגדרות כברירת מחדל של הווידג'ט (טקסט גרירה, כפתורים, הודעות aria‑live, הודעות שגיאה) |
קריאות חזרה
| קריאה חזרה | מתרחשת כאשר | נתונים |
|---|---|---|
onReady() | הווידג'ט ריצף את מסך ההמתנה/גרירה שלו | — |
onSourceLoaded({ token, pages, sourceExt, allowedTargets }) | הצלחת ?convert=open | אסימון סשן מקור, מספר עמודים, סיומת מקור (בלי נקודה מקדימה), רשימת יעדים מותרים |
onConverted({ downloadToken, resultToken, resultPages, downloadName, watermarked, target }) | הצלחת ?convert=run | אותם השדות כמו בתשובת הריצה, בנוסף לtarget שנדרש |
onDownload({ downloadName, downloadToken }) | המשתמש לוחץ על קישור ההורדה | מתרחש יחד עם ההורדה הטבעית של הדפדפן — הוא אינו תופס או מחליף אותה |
onError({ phase, message }) | בקשת פתיחה או ריצה נכשלת | phase הוא 'open' או 'run'; message הוא השגיאה המנוקה מהשרת (או הודעת צד‑לקוח לבדיקת גודל העלאה) |
קריאת חזרה שמקפיצה נלכדת ונרשמת ביומן; היא לעולם אינה משבשת את זרימת הווידג'ט.
מזהה פקודתי
Doconut.convert() מחזיר את מופע הווידג'ט עצמו — החזיקו בו כדי לשלוט בווidget באופן תכנותי:
const conv = Doconut.convert('#doconut-convert', { basePath: '/doconut' });
const file = document.querySelector('#picker').files[0]; // קובץ מהקלט שלך <input type="file" id="picker">
conv.reset(); // חזרה למסך הממתין/השלכה; לא מפעיל מחדש onReady
conv.loadFile(file); // מתחיל את הזרימה עם אובייקט File; no-op אלא אם הוא במצב ממתין
conv.destroy(); // מסיר מאזינים, מרוקן את ה-mount; המופע אינו ניתן לשימוש לאחר זאתתוויות
לכל מחרוזת יש ברירת מחדל באנגלית; labels עוקף כל תת‑קבוצה והיתר נשארים באנגלית. קטעים שמשתנים בזמן ריצה משתמשים ב{placeholders}, כגון uploading: 'Uploading {name}…' ו‑pages: '{n} pages'.
| מפתח | ברירת מחדל באנגלית |
|---|---|
dropPrompt | Drag & drop a document here |
dropHint | PDF, Word, Excel, PowerPoint, images and more |
chooseFile | Choose file |
uploading | Uploading {name}… |
page / pages | 1 page / {n} pages |
noTargets | No conversion targets are available for this file. |
convertTo / convert | Convert to / Convert |
converting | Converting to {target}… |
readyToDownload | Ready to download |
download / convertAnother | Download / Convert another |
watermarkNotice | Output is watermarked — get a license to remove it. |
retry | Retry |
genericError | Something went wrong. Please try again. |
sizeLimit | That file is larger than the {mb} MB upload limit. Please choose a smaller file. |
serverError | The server could not process this request. Please try again. |
networkError | Could not reach the server. Please check your connection and try again. |
מפתחות נוספים מכסים את aria-label של אזור הגרירה (dropAriaLabel), את טקסטי alt של התצוגה המקדימה (previewAlt, resultAlt), את הצורה המקושרת של הודעת סימן המים המשמשת עם licenseUrl (watermarkNoticePrefix, watermarkNoticeLink, watermarkNoticeSuffix), תגובה בלתי קריאה (badResponse) ואת ההודעות של aria-live (annReady, annUploading, annLoaded, annLoadedNoTargets, annConverting, annDone, annError).
שגיאת JSON מהשרת מוצגת כפי שהשרת כתב אותה; serverError משמשת רק כאשר תגובה נכשלת אינה נושאת שגיאת JSON, כגון 404 של וידג'ט מושבת.
התאמת נושא
הווידג'ט מוסיף את המחלקה dcw לאלמנט ההרכבה שלו וקורא את הצבעים, הרדיוס והגופן שלו ממאפייני CSS מותאמים, כך שניתן להתאים אותו ללא שינוי פנימי:
#doconut-convert.dcw {
--dcw-accent: #6b46c1;
--dcw-radius: 12px;
--dcw-font: "Inter", system-ui, sans-serif;
}ברירות מחדל: --dcw-accent: #2b6cb0, --dcw-bg: #ffffff, --dcw-fg: #1a202c, --dcw-muted: #718096, --dcw-border: #cbd5e0, --dcw-radius: 8px, וגופן מערכת UI עבור --dcw-font.
בנה ממשק משתמש משלך
הווידג'ט הוא רק לקוח של חוזה HTTP זה — ניתן לבנות ממשק משתמש משלך שמתחבר אליו ישירות לחוויית משתמש שונה. שלושת הנתיבים יושבים תחת ענף ASP.NET שבו UseDoconut() מותקן (בדרך כלל /doconut), והם משיבים 404 עד שAddConverterWidget() נקרא. שגיאות נושאות גוף JSON, { "error": "..." }, למעט כאשר הטבלה מציינת "רק סטטוס". ערך ?convert= לא ידוע משיב 400.
| נתיב | מטרה | תגובה מוצלחת |
|---|---|---|
POST ?convert=open (רב-חלקי, קובץ אחד) | העלאה ופתיחה של מסמך מקור לתצוגה מקדימה | 200 — { token, pages, sourceExt, allowedTargets } |
POST ?token=<token>&convert=run&target=<ext> | המרת המקור השמור לtarget | 200 — { downloadToken, resultToken, resultPages, downloadName, watermarked } |
GET ?convert=download&token=<downloadToken> | הזרמת הקובץ המומר | 200 — בייטי קובץ, Content-Disposition: attachment, Cache-Control: no-store |
sourceExt בתגובה של open אין נקודה מובילה (לדוגמה "docx") — ההפך מהקונבנציה של הפרמטר sourceExtension בDocumentConverter.ConvertAsync, שדורש אחת. allowedTargets מציג שמות יעד באותיות קטנות ("pdf", "html", …); העבירו אחד מהם כtarget, שמתאים ללא רגישות לאותיות. open משתמש בקובץ הראשון בגוף הרב-חלקי.
resultToken הוא null, וresultPages הוא 0, כאשר לא ניתן להציג את התוצאה. downloadName הוא שם קובץ המקור עם סיומת היעד.
תמונות התצוגה המקדימה משתמשות בנתיב תמונת הצופה הסטנדרטי, {basePath}?token={token}&page=1&thumb=1&width={px}, עם token מopen או resultToken מrun. הווידג'ט מבקש את width=240.
בייטי המקור שהועלו נשמרים בצד השרת ונשמרים למשך 30 דקות לאחר הקריאה האחרונה; כאשר חלון זמן זה פג, run משיב 404 ויש לפתוח את הקובץ מחדש. התוצאה המומרת חיה באותו מאגר — downloadToken מקבל חלון זמן חדש של 30 דקות כאשר ההמרה מסתיימת — בעוד resultToken הוא אסימון סשן צופה רגיל לתצוגת התוצאה. כאשר ניתן להציג את התוצאה, downloadToken ו‑resultToken הם אותו ערך. סגירת תוצאת הצופה אינה מוחקת את המאגר ההורדה שעדיין בתוקף, והפעלת הווידג'ט מחדש בדפדפן אינה מאריכה אף אחד מהחלונות.
מצבי כשל, מקובצים לפי נתיב:
| נתיב | סטטוס | מתי | גוף |
|---|---|---|---|
| כל | 404 | הווידג'ט אינו מופעל (AddConverterWidget() לא נקרא מעולם) — נבדק לפני שכל אחד משלושת הנתיבים נשלח | רק סטטוס |
| כל | 405 | מתודה HTTP שגויה (open/run דורשים POST; download דורש GET) | רק סטטוס |
open | 400 | העלאה אינה רב-חלקית | Expected a multipart file upload. |
open | 400 | אין קובץ, או קובץ ריק | No file uploaded. |
open | 400 | סיומת מקור שלא ניתנת להמרה | This file type cannot be converted. |
open | 403 | סוג הקובץ דורש יכולת שהרישיון אינו מעניק (קובץ DICOM ללא Dicom) | Converting this file type requires the Dicom capability license. |
open | 413 | קובץ שהועלה חורג מMaxUploadMb, נבדק מול Content-Length ובזמן קריאת ההעלאה | File is too large. |
run | 400 | אסימון פגום (אינו GUID) | Invalid token. |
run | 400 | target שלא ניתן לפרש לConversionTarget | Unknown target format. |
run | 400 | target אינו בallowedTargets של המקור | That target format is not available for this file. |
run | 404 | ההעלאה השמורה פגה תוקף או שהאסימון מעולם לא נפתח | Upload expired — please re-open the file. |
open, run | 500 | העיבוד נכשל פנימית | הודעה מסוננת — מסוננת באותו אופן כמו כל נתיב שגיאה של Doconut; לעולם לא חושפת פרטים פנימיים |
download | 400 | אסימון פגום (אינו GUID) | רק סטטוס |
download | 404 | אסימון הורדה לא ידוע או פג תוקף | רק סטטוס |
סיבוב מלא עם fetch:
// file: הקובץ להמרה, לדוגמה מ-<input type="file">.
async function convertFile(file) {
const base = '/doconut';
// 1. open: העלה את הקובץ
const form = new FormData();
form.append('file', file, file.name);
const openResp = await fetch(base + '?convert=open', { method: 'POST', body: form });
if (!openResp.ok) throw new Error((await openResp.json()).error);
const opened = await openResp.json();
// 2. run: להמיר ל-PDF כאשר זה מותר, אחרת ליעד המותר הראשון
const target = opened.allowedTargets.includes('pdf') ? 'pdf' : opened.allowedTargets[0];
const runResp = await fetch(base + '?token=' + encodeURIComponent(opened.token) +
'&convert=run&target=' + target, { method: 'POST' });
if (!runResp.ok) throw new Error((await runResp.json()).error);
const converted = await runResp.json();
// 3. download: GET פשוט שהדפדפן יכול לבצע
window.location.href = base + '?convert=download&token=' + encodeURIComponent(converted.downloadToken);
}הקצות הן אותו מקור: לגרסה זו אין תמיכה ב‑CORS. הגישו את הממשק שלכם ואת סקריפט הווידג'ט מאותו מקור של Doconut, או הפכו ל‑reverse‑proxy את שני הנתיבים /doconut (נתיב המידלוור ונתיב המשאבים) תחת מקור הממשק שלכם.
בייצור
- התקן את התוסף לצד חבילת הליבה, באותה גרסה:
dotnet add package Doconut.NET6.Converter. - הוסף את קובץ הרישיון. שים
Doconut.Viewer.Converter.licבאותו תיקייה כמוDoconut.Viewer.lic. - הגדר את המגבלה של השרת.
MaxUploadMbבAddConverterWidgetהוא המגבלה שהשרת אוכף;maxUploadMbשל הווידג'ט הוא רק בדיקה בצד הלקוח. שמור שהשניים יהיו שווים. - הגש את ממשק המשתמש מאותו מקור כמו נקודות הקצה של Doconut, או הפוך פרוקסי אותם (ראה בנה את הממשק שלך).
- השלך תוצאות המרה. הזרם
ConvertAsyncמחזיר הוא משותף; השמדתו מחזירה את המאגרים שלו לבריכה.
חוות רשת
הווידג'ט שומר כל העלאה והתוצאה שלה בזיכרון על הצומת ששירתה את open. מאחורי מאזן עומס ללא מושב דביק, בקשה מאוחרת של run, download או תצוגה מקדימה יכולה להגיע לצומת אחר ולא למצוא את ההעלאה. רשום את מאגר הווידג'ט המשותף והמוצפן פעם אחת, אחרי AddDoconut():
byte[] farmKey = Convert.FromBase64String(builder.Configuration["Doconut:FarmKey"]);
builder.Services.AddDoconutDistributedWidgets(store =>
{
store.RootPath = @"\\fileshare\doconut"; // תיקייה שכל צומת יכול לקרוא ולכתוב
store.FarmKey = farmKey; // לפחות 32 בתים, זהה בכל צומת
// store.Ttl = TimeSpan.FromMinutes(30); // כמה זמן העלאה נשמרת (ברירת המחדל)
});- שרת יחיד אינו צריך דבר: ללא קריאה זו משתמשים במאגר בזיכרון.
- העלאות ותוצאות מוצפנות במנוחה על השיתוף (AES-256, הצפנה-לאחר-MAC), וכל קובץ קשור לטוקן שלו, כך שטוקן אחד לעולם לא יכול לקרוא קובץ של אחר.
- על השיתוף, העלאה או תוצאה נשמרים למשך
Ttlלאחר שנכתבו; קריאה אינה מאריכה את החלון הזה. FarmKeyחייב להיות לפחות 32 בתים והזהה בכל צומת. טען אותו ממאגר סודי; אל תכתוב אותו בקוד קבוע. רישום זורקArgumentExceptionכאשרRootPathחסר או כאשרFarmKeyקצר מ‑32 בתים.- הפנה את
RootPathלאותו מיקום משותף שבו משתמש הצופה המבוזר.
ההתייחסות ל‑API
המחזית ואפשרויות הווידג'ט נמצאות במרחב השמות Doconut; ConversionTarget נמצא בDoconut.Configs.Conversion. ConverterPlugin נמצא בDoconut.Plugins.Converter.
DocumentConverter
public sealed class DocumentConverter
{
public Task<Stream> ConvertAsync(
string filePath, ConversionTarget target,
string? password = null, CancellationToken ct = default);
public Task<Stream> ConvertAsync(
Stream source, string sourceExtension, ConversionTarget target,
string? password = null, CancellationToken ct = default);
public Task<Stream> WordToHtmlAsync(string filePath, CancellationToken ct = default);
public Task<Stream> HtmlToWordAsync(
Stream htmlSource, ConversionTarget outputFormat = ConversionTarget.Docx,
CancellationToken ct = default);
}מתקבל מהזרקת תלות; הבנאי פנימי. sourceExtension כולל את הנקודה המקדימה. HtmlToWordAsync כותב קובץ .doc כאשר outputFormat הוא ConversionTarget.Doc, וקובץ .docx לכל ערך אחר.
ConversionTarget
ה-45 פורמטים של פלט המופיעים ב-פורמטים יעד.
ConverterWidgetOptions
public sealed class ConverterWidgetOptions
{
public int MaxUploadMb { get; set; } = 25;
}הגדר דרך DoconutOptions.AddConverterWidget(Action<ConverterWidgetOptions>? configure = null), שמחזיר את DoconutOptions כך שניתן לשרשר קריאות.
פתרון בעיות
| סימפטום | סיבה | תיקון |
|---|---|---|
AddDoconut() זורק The Converter plugin is registered via AddPlugin but no active license grants Converter. | אין רישיון, קובץ TRIAL, רישיון ללא Converter, או רישיון בתשלום מחוץ לחלון הגרסה שלו | התקן רישיון שמעניק Converter, או הסר AddPlugin<ConverterPlugin>() |
AddDoconut() זורק AddConverterWidget() was called but the Converter plugin is not registered. | הווידג'ט מופעל ללא התוסף שלו | הוסף options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>() |
פתרון של DocumentConverter זורק No IDocumentConverter is registered. Add the converter plugin: options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>(). | ConverterPlugin אינו רשום | הוסף AddPlugin<ConverterPlugin>() בתוך AddDoconut() |
| המרת הזרם אומרת שהפורמט אינו נתמך | sourceExtension אין נקודה מקדימה | העבר ".xlsx", לא "xlsx" |
ConvertAsync זורק Converting '.dcm' requires the Dicom capability license. | מקור DICOM, והרישיון אינו מעניק Dicom | השתמש ברישיון שמעניק Dicom |
| הפלט מסומן במים | הרישיון זמני (Demo/NFR) | השתמש ברישיון בתשלום שמעניק Converter |
הווידג'ט נטען אך הבקשות שלו מחזירות 404 | AddConverterWidget() לא נקרא, או basePath אינו תואם לסניף שבו UseDoconut() מותקן | קרא AddConverterWidget(); תקן basePath |
open משיב 403 Converting this file type requires the Dicom capability license. | העלאת DICOM, והרישיון אינו מעניק Dicom | השתמש ברישיון שמעניק Dicom |
open משיב 413 File is too large. | ההעלאה חורגת מMaxUploadMb | העלה MaxUploadMb בAddConverterWidget; maxUploadMb של הווידג'ט הוא רק בדיקה בצד הלקוח |
run משיב 400 That target format is not available for this file. | היעד אינו אחד מallowedTargets של המקור | הצע רק את allowedTargets מopen |
run או download משיב 404 (Upload expired — please re-open the file. מrun) | חלון של 30 דקות עבר, או שמצומת בחוות הרשת אינו מחזיק את ההעלאה | פתח את הקובץ שוב; בחווה, רשום AddDoconutDistributedWidgets |
| הווידג'ט נכשל כאשר הממשק נמצא במקור אחר | לנקודות הקצה אין תמיכה ב‑CORS | הגש את הממשק מאותו מקור, או הפוך פרוקסי לנתיבי Doconut |
| הנושא אינו מתיישם | המשתנים מוגדרים על קודמת או על אלמנט בתוך ההרכבה; כלל .dcw של הווידג'ט מגדיר אותם על ההרכבה | הפנה ישירות להרכבה עצמה: #doconut-convert.dcw או #doconut-convert |
האם דף זה היה מועיל?