Плагин Конвертера
Конвертировать документы в 45 целевых форматов
Плагин Converter превращает Doconut в сервис конвертации документов. Он предоставляет движок, стоящий за публичным фасадом DocumentConverter и — при включении — встроенным виджетом, обслуживаемым DocImage.axd, так что вы можете конвертировать документы из C#, из виджета или из собственного фронтенда.
| Компонент | Когда использовать |
|---|---|
DocumentConverter (C#) | Вы конвертируете на сервере, без участия браузера |
Встроенный виджет (doconutConverter.js) | Вы хотите готовый экран загрузки, конвертации и скачивания на своей странице |
HTTP‑конечные точки на DocImage.axd (?convert=open|run|download) | Вы создаёте собственный UI конвертации, используя документированный серверный контракт |
Установить пакет
Install-Package Doconut.NETFramework.ConverterЧтобы зафиксировать плагин на версии, описанной в этой документации:
Install-Package Doconut.NETFramework.Converter -Version 26.10.0Держите пакет Converter той же версии, что и Doconut.NETFramework.
Файл лицензии плагина, Doconut.Viewer.Converter.lic, помещается в ту же папку, что и Doconut.Viewer.lic; он читается вместе с лицензией просмотрщика.
Зарегистрировать плагин
Каждый плагин регистрируется одинаково: AddPlugin<TPlugin>() в DoconutHost.Initialize, вызываемый из Application_Start.
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
});Это всё, что требуется фасаду C#. Виджет и его HTTP‑конечные точки — отдельная опция, AddConverterWidget() (см. Встроенный виджет).
Плагину нужна лицензия, предоставляющая возможность Converter. Без неё DoconutHost.Initialize бросает исключение из Application_Start:
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.В System.Web это означает, что каждый запрос отвечает пустым 500, а причина записана только в журнале событий Windows (источник ASP.NET). Исключение бросается при отсутствии лицензии, устаревшем файле TRIAL, лицензии без Converter и платной лицензии, использующейся вне её версии. Принимаются временные лицензии Demo/NFR. См. Настройка лицензии.
Лицензирование и водяной знак
| Состояние лицензии | Запуск | Результат конвертации |
|---|---|---|
Платная лицензия просмотрщика, предоставляющая Converter, в пределах её версии | Запускается | Чистый — watermarked: false |
| Активная временная (Demo/NFR) лицензия | Запускается | Конвертирует, с водяным знаком оценки — watermarked: true |
| Истёкшая временная (Demo/NFR) лицензия | Запускается | Конвертирует, с водяным знаком оценки — watermarked: true |
Отсутствие лицензии, устаревший файл TRIAL, лицензия без Converter, или платная лицензия вне её версии | Application_Start бросает; каждый запрос отвечает пустым 500 | — |
Фасад DocumentConverter и обработчик ?convert=run виджета применяют то же правило. Интеграцию можно построить и протестировать от начала до конца на оценочной лицензии перед покупкой — меняются только байты вывода.
Источник DICOM (.dcm, .ima) также требует возможности Dicom. Без неё ConvertAsync бросает LicenseException (Converting '.dcm' requires the Dicom capability license.), а обработчик виджета open отвечает 403.
Использование из C#
Каждая конверсия возвращает позиционированный в 0 перемещаемый MemoryStream. DocumentConverter без состояния: получайте его из DoconutHost.Services где угодно и свободно переиспользуйте.
// Разрешить DocumentConverter из DoconutHost.Services; его конструктор internal, поэтому никогда не `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 в перегрузке потока должен включать начальную точку (".xlsx", а не "xlsx"), иначе он не будет найден. И несмотря на название, WordToHtmlAsync возвращает Task<Stream>, а не Task<string> — HTML‑документ (изображения встроены в Base64) приходит как поток, как и любой другой результат.
Вызывающая сторона владеет MemoryStream, который возвращает конверсия, и должна освободить его после копирования или возврата (MVC‑овский File(stream, …) освобождает его за вас). Не создавайте и не освобождайте DocumentConverter самостоятельно — его конструктор внутренний.
В контроллере MVC 5
Сделайте действие асинхронным и await конверсию:
[HttpPost]
public async Task<ActionResult> ToPdf(HttpPostedFileBase file)
{
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();
Stream pdf = await converter.ConvertAsync(
file.InputStream, Path.GetExtension(file.FileName), ConversionTarget.Pdf,
password: null, ct: Response.ClientDisconnectedToken);
return File(pdf, "application/pdf", Path.GetFileNameWithoutExtension(file.FileName) + ".pdf");
}В Web Forms: никогда не блокировать конверсию
Страница Web Forms работает в однопоточном контексте запроса. ConvertAsync возобновляется в этом контексте после завершения, поэтому страница, ожидающая её синхронно — .Result, .Wait(), .GetAwaiter().GetResult() — удерживает тот самый поток, необходимый для завершения конверсии. Запрос никогда не возвращается. Браузер продолжает крутиться, IIS ничего не записывает, а остальная часть сайта продолжает работать, поэтому выглядит как медленная конверсия, а не как взаимная блокировка.
Отметьте страницу Async="true" и запустите конверсию как асинхронную задачу страницы:
<%@ Page Language="C#" Async="true" CodeBehind="Convert.aspx.cs" Inherits="MyApp.Convert" %>// Web Forms: директива @Page требует Async="true", и преобразование выполняется как асинхронная задача страницы.
// Блокировка вместо этого (.Result, .Wait(), .GetAwaiter().GetResult()) приводит к взаимной блокировке запроса:
// он никогда не возвращается, и ничего не логируется.
protected void Page_Load(object sender, EventArgs e)
{
if (!IsPostBack) return;
RegisterAsyncTask(new PageAsyncTask(async ct =>
{
var converter = Doconut.DoconutHost.Services.GetRequiredService<DocumentConverter>();
using (var pdf = await converter.ConvertAsync(
Server.MapPath("~/App_Data/contract.docx"), ConversionTarget.Pdf, ct: ct))
using (var ms = new MemoryStream())
{
if (pdf.CanSeek) pdf.Position = 0;
await pdf.CopyToAsync(ms);
Response.ContentType = "application/pdf";
Response.AddHeader("Content-Disposition", "attachment; filename=contract.pdf");
Response.BinaryWrite(ms.ToArray());
// Context, а не HttpContext.Current: после await последнее может быть null.
Context.ApplicationInstance.CompleteRequest();
}
}));
}Без Async="true" в директиве @Page, RegisterAsyncTask будет тихо игнорироваться. После await используйте Context страницы; HttpContext.Current может быть null там.
Форматы назначения
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, PSD, веб‑документ, DICOM) есть собственный набор разрешённых целей. Конверсия DICOM‑источника (.dcm, .ima) также требует лицензии, предоставляющей возможность Dicom; её цели — Pdf, Png, Jpeg, Bmp, Tiff и Gif. Не захардкожьте этот enum в список целей вашего UI: ?convert=open возвращает allowedTargets загруженного файла, и именно это должно определять выбор.
Встраиваемый виджет
Включить конечные точки
Конечные точки ?convert=open|run|download виджета обслуживаются DocImage.axd и по умолчанию отключены. Включите их рядом с регистрацией плагина:
Doconut.DoconutHost.Initialize(options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddConverterWidget(widget =>
{
widget.MaxUploadMb = 25;
});
});
// System.Web читает всю загрузку до того, как Doconut её увидит: сохраняйте maxRequestLength (KB) и
// maxAllowedContentLength (bytes) в Web.config выше MaxUploadMb виджета.AddConverterWidget() без аргументов включает виджет с настройками по умолчанию (MaxUploadMb = 25). Он сам по себе не предоставляет прав на конверсию: требуется AddPlugin<ConverterPlugin>(), иначе DoconutHost.Initialize бросает исключение:
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.Две вещи, которые следует проверить, когда виджет ведёт себя некорректно:
basePath: '/DocImage.axd'. По умолчанию виджет использует/doconut, который является конечной точкой ASP.NET Core. В этом пакете конечные точки — обработчикDocImage.axdизWeb.config.- Скрипт и конечные точки независимы. Модуль ресурсов обслуживает
doconutConverter.jsнезависимо от того, включён ли виджет. БезAddConverterWidget()виджет загружается, рисует свою зону перетаскивания и выглядит полностью корректно — и его первое действие отвечает404.
Ограничения загрузки
ASP.NET читает всё тело запроса перед тем, как запустится DocImage.axd. Загрузка, превышающая MaxUploadMb, но ниже ограничений хоста, получает собственный JSON 413 виджета (File is too large.). Загрузка, превышающая ограничения хоста, сначала отклоняется IIS, с ошибочной страницой, которую виджет не может прочитать. Сохраните оба ограничения хоста в Web.config выше лимита виджета:
<system.web>
<httpRuntime maxRequestLength="30720" /> <!-- КИЛОБАЙТЫ: 30 MB -->
</system.web>
<system.webServer>
<security>
<requestFiltering>
<requestLimits maxAllowedContentLength="31457280" /> <!-- БАЙТЫ: 30 MB -->
</requestFiltering>
</security>
</system.webServer>Встроить его
<div id="doconut-convert"></div>
<script src="/doconut-res/js/doconutConverter.js"></script>
<script>
Doconut.convert('#doconut-convert', { basePath: '/DocImage.axd', maxUploadMb: 25 });
</script>Doconut.convert(selectorOrElement, options) принимает CSS‑селектор или элемент, бросает ошибку, если место монтирования не найдено, и возвращает дескриптор. Виджет загружает файл, показывает предварительный просмотр первой страницы, позволяет пользователю выбрать один из allowedTargets, конвертирует, предварительно показывает результат, когда это возможно, и предлагает загрузку.
Параметры
| Параметр | Тип | По умолчанию | Примечания |
|---|---|---|---|
basePath | string | /doconut | URL конечной точки. Установите '/DocImage.axd' в этом пакете |
resPath | string | /doconut-res | Принято для согласованности с другими виджетами Doconut; виджет‑конвертер не формирует из него URL |
maxUploadMb | number | 25 | Только предварительная проверка на клиенте; сервер применяет собственный лимит |
licenseUrl | string | null | null | Превращает уведомление о водяном знаке на экране результата в ссылку |
labels | object | {} | Переопределяет любую часть английских строк виджета |
Обратные вызовы
| Обратный вызов | Срабатывает когда | Данные |
|---|---|---|
onReady() | Виджет отобразил экран броска | — |
onSourceLoaded({ token, pages, sourceExt, allowedTargets }) | ?convert=open успешно завершён | Токен источника, количество страниц, расширение источника (без точки), разрешённые цели |
onConverted({ downloadToken, resultToken, resultPages, downloadName, watermarked, target }) | ?convert=run успешно завершён | Ответ выполнения плюс запрошенный target |
onDownload({ downloadName, downloadToken }) | Пользователь нажимает «Download» | Срабатывает одновременно со скачиванием браузера |
onError({ phase, message }) | Запрос open или run завершился ошибкой | phase равно 'open' или 'run'; message — это очищенная ошибка сервера |
Обратный вызов, который бросает исключение, перехватывается и записывается в журнал; он никогда не нарушает работу виджета.
Императивный дескриптор
Doconut.convert() возвращает экземпляр виджета:
const conv = Doconut.convert('#doconut-convert', { basePath: '/DocImage.axd' });
const file = document.querySelector('#picker').files[0]; // Файл из вашего собственного <input type="file" id="picker">
conv.reset(); // назад к экрану перетаскивания; не вызывает onReady повторно
conv.loadFile(file); // запускает поток с File; ничего не делает, если виджет не находится на экране перетаскивания
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‑контракта на DocImage.axd. Маршруты отвечают 404 до тех пор, пока не будет вызвано AddConverterWidget(). Ошибки содержат тело JSON, { "error": "..." }, за исключением случаев, когда в таблице указано «только статус». Неизвестное значение ?convert= отвечает 400.
| Маршрут | Назначение | Ответ при успехе |
|---|---|---|
POST /DocImage.axd?convert=open (multipart, one file) | Загрузить и открыть исходный документ | 200 — { token, pages, sourceExt, allowedTargets } |
POST /DocImage.axd?token=<token>&convert=run&target=<ext> | Преобразовать загруженный источник в target | 200 — { downloadToken, resultToken, resultPages, downloadName, watermarked } |
GET /DocImage.axd?convert=download&token=<downloadToken> | Транслировать преобразованный файл | 200 — файл, Content-Disposition: attachment, Cache-Control: no-store |
В ответе open sourceExt не имеет ведущей точки ("docx") — противоположно параметру sourceExtension функции ConvertAsync. allowedTargets перечисляет имена целей в нижнем регистре ("pdf", "html", …); передайте одно из них как target, сравнение производится без учёта регистра. open использует первый файл в multipart‑теле.
resultToken равно null, а resultPages равно 0, когда результат нельзя предварительно просмотреть. downloadName — это имя исходного файла с расширением цели.
Изображения предварительного просмотра используют стандартный маршрут изображения просмотрщика, /DocImage.axd?token={token}&page=1&thumb=1&width={px}, с token из open или resultToken из run. Виджет запрашивает width=240.
Загруженные источники хранятся в течение 30 минут после последнего чтения; после этого run отвечает 404 и файл необходимо открыть заново. downloadToken получает собственный 30‑минутный интервал после завершения конвертации. resultToken — обычный токен просмотрщика для предварительного просмотра результата; когда результат можно просмотреть, он имеет то же значение, что и downloadToken.
| Маршрут | Статус | Когда | Тело |
|---|---|---|---|
| любой | 404 | Виджет не включён (AddConverterWidget() никогда не вызывался) | только статус |
| любой | 405 | Неправильный глагол (open/run требуют POST, download требует GET) | только статус |
open | 400 | Не multipart‑загрузка | 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 (но не пределы IIS) | File is too large. |
run | 400 | Некорректный токен (не GUID) | Invalid token. |
run | 400 | target, который не преобразуется в ConversionTarget | Unknown target format. |
run | 400 | Цель, отсутствующая в allowedTargets | That target format is not available for this file. |
run | 404 | Срок загрузки истёк или она никогда не открывалась | Upload expired — please re-open the file. |
open, run | 500 | Обработка не удалась | Очищенное сообщение |
download | 400 / 404 | Некорректный, неизвестный или просроченный токен загрузки | только статус |
Полный цикл с fetch:
// file: the File для конвертации, например из <input type="file">.
async function convertFile(file) {
const base = '/DocImage.axd';
// 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);
}Конечные точки имеют same-origin: эта версия не поддерживает CORS. Размещайте ваш UI и скрипт виджета из того же источника, что и Doconut, либо используйте обратный прокси для обработчика и путей ресурсов под вашим UI‑источником.
В продакшене
- Установите плагин рядом с основным пакетом, той же версии:
Install-Package Doconut.NETFramework.Converter. - Добавьте файл лицензии. Поместите
Doconut.Viewer.Converter.licв ту же папку, что иDoconut.Viewer.lic. - Установите ограничения загрузки.
MaxUploadMbвAddConverterWidget— это лимит, который накладывает Doconut; держитеmaxRequestLengthиmaxAllowedContentLengthвWeb.configвыше него (см. Ограничения загрузки), а параметрmaxUploadMbвиджета сделайте равным ему. - Никогда не блокируйте конверсию в Web Forms (см. В Web Forms).
- Освобождайте результаты конверсии. Поток, возвращаемый
ConvertAsync, берётся из пула; его освобождение возвращает буферы в пул.
Веб-фермы
Виджет хранит каждую загрузку и её результат в памяти на сервере, который обслуживал open. За балансировщиком нагрузки без «липких» сессий последующий запрос run, download или запрос предварительного просмотра может попасть на другой сервер и не найти загрузку. Зарегистрируйте совместно используемое зашифрованное хранилище виджета через второй аргумент DoconutHost.Initialize:
byte[] farmKey = Convert.FromBase64String(System.Configuration.ConfigurationManager.AppSettings["Doconut:FarmKey"]);
Doconut.DoconutHost.Initialize(
options =>
{
options.LicensePath = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
options.AddPlugin<Doconut.Plugins.Converter.ConverterPlugin>();
options.AddConverterWidget();
},
services => services.AddDoconutDistributedWidgets(store =>
{
store.RootPath = @"\\fileshare\doconut"; // папка, которую каждый сервер может читать и записывать
store.FarmKey = farmKey; // не менее 32 bytes, одинаково на каждом сервере
// store.Ttl = TimeSpan.FromMinutes(30); // как долго хранится загрузка (по умолчанию)
}));- Один сервер ничего не требует: без этого вызова используется хранилище в памяти.
- Загрузки и результаты шифруются в состоянии покоя на общем ресурсе (AES-256, encrypt-then-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);
}Разрешается из DoconutHost.Services; конструктор внутренний. 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, позволяя цепочкой вызывать методы.
Устранение неполадок
| Симптом | Причина | Решение |
|---|---|---|
Каждый запрос возвращает пустой 500 после добавления плагина; журнал событий Windows (источник ASP.NET) показывает The Converter plugin is registered via AddPlugin but no active license grants Converter. | Отсутствует лицензия, файл TRIAL, лицензия без Converter, или платная лицензия вне её версии | Установите лицензию, предоставляющую Converter, или удалите AddPlugin<ConverterPlugin>() |
Каждый запрос возвращает пустой 500; журнал событий показывает 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>() в DoconutHost.Initialize |
| Конверсия Web Forms никогда не возвращает результат | Страница блокируется на ConvertAsync | Используйте Async="true" и RegisterAsyncTask |
| Конверсия потока сообщает, что формат не поддерживается | sourceExtension не имеет ведущей точки | Передайте ".xlsx", а не "xlsx" |
ConvertAsync вызывает Converting '.dcm' requires the Dicom capability license. | Источник DICOM, и лицензия не предоставляет Dicom | Используйте лицензию, предоставляющую Dicom |
| Вывод имеет водяной знак | Лицензия временная (Demo/NFR) | Используйте платную лицензию, предоставляющую Converter |
Виджет загружается, но его запросы возвращают 404 | AddConverterWidget() не был вызван, или basePath не является '/DocImage.axd' | Вызовите AddConverterWidget(); установите basePath: '/DocImage.axd' |
| Большая загрузка показывает страницу ошибки IIS вместо сообщения виджета | maxRequestLength / maxAllowedContentLength ниже MaxUploadMb | Повышайте лимиты Web.config выше MaxUploadMb |
open отвечает 403 Converting this file type requires the Dicom capability license. | Загрузка DICOM, и лицензия не предоставляет Dicom | Используйте лицензию, предоставляющую Dicom |
run отвечает 400 That target format is not available for this file. | Цель не является одним из allowedTargets источника | Предлагайте только allowedTargets из convert=open |
run или download отвечает 404 (Upload expired — please re-open the file. из run) | 30-минутное окно истекло, или другой сервер в ферме не имеет загрузки | Откройте файл снова; в ферме зарегистрируйте AddDoconutDistributedWidgets |
| Виджет не работает, когда UI находится на другом источнике | Конечные точки не поддерживают CORS | Обслуживайте UI с того же источника, либо используйте обратный прокси для путей Doconut |
| Тема не применяется | Переменные заданы у предка или у элемента внутри монтирования; собственное правило .dcw виджета задаёт их на монтировании | Обращайтесь к самому монтированию: #doconut-convert.dcw или #doconut-convert |
Примечания к фреймворку
По сравнению с пакетами ASP.NET Core, этот пакет отличается только способом хостинга; API, контракт конечных точек, скрипт виджета и правила лицензирования остаются теми же.
- Регистрация происходит в
Application_Start, черезDoconutHost.Initialize, вместоbuilder.Services.AddDoconut. Сервисы, такие какAddDoconutDistributedWidgets, передаются во второй аргумент. - Конечные точки обслуживаются
DocImage.axd, а скрипт —DoconutResourceModule, оба зарегистрированы вWeb.config, вместоUseDoconut()иUseDoconutResources(). Виджету требуетсяbasePath: '/DocImage.axd'. - Сбои при запуске проявляются как пустой
500на каждом запросе, с причиной в журнале событий Windows. - Загрузки полностью читаются ASP.NET до того, как их видит Doconut, поэтому лимиты IIS должны быть выше
MaxUploadMb. - Web Forms страницы не должны блокировать конверсию; см. В Web Forms.
- Только Windows, как и остальные пакеты .NET Framework.
Была ли эта страница полезной?