DoconutOptions

Configure os serviços Doconut

DoconutOptions (namespace Doconut) é o único objeto de configuração para todo o SDK. Você o configura uma vez, no callback que você passa para DoconutHost.Initialize em Application_Start.

csharp
Doconut.DoconutHost.Initialize(options =>
{
    options.LicensePath     = HostingEnvironment.MapPath("~/wwwroot/Doconut.Viewer.lic");
    options.UnsafeMode      = false;
    options.ShowDoconutInfo = false;
    options.AddPlugin<Doconut.Plugins.Dicom.DicomPlugin>();
});

Propriedades

TipoPropriedadePadrãoDescrição
boolUnsafeModefalseQuando false, DocImage.axd serve uma página apenas para a sessão ASP.NET que abriu o documento (ou, em um farm, para o navegador com nomes de ticket assinados). Quando true, qualquer requisição que contenha o token é atendida. Deixe false — veja Sessões & Segurança.
boolShowDoconutInfofalseQuando true, uma requisição DocImage.axd sem token responde Doconut <version> is running on <host> ao invés de 404. Útil como verificação rápida; deixe false em produção.
stringResourcesPath"/doconut-res"Prefixo de URL sob o qual o módulo de recursos serve os scripts, estilos e imagens incorporados.
stringLicensePath""Caminho completo para o arquivo de licença. Vazio → a próxima fonte de licença, então descoberta automática; nada encontrado → avaliação com marca d'água sem recursos.
stringLicenseContent""Conteúdo bruto da licença (banco de dados, variável de ambiente, armazenamento secreto). Tem precedência sobre LicensePath.
Stream?LicenseStreamnullLicença como stream, lida uma vez na inicialização. Tem precedência sobre ambas as outras fontes.
stringMiddlewarePath"/doconut"Não usado pelo System.Web. O endpoint da página é sempre o manipulador DocImage.axd declarado em Web.config. O valor ainda é validado na inicialização (veja abaixo).
boolResetLicensefalseNão usado. A licença é lida uma vez, em DoconutHost.Initialize; recicle o pool de aplicação após substituir uma licença.
DoconutPluginRegistryPluginRegistry—Registro somente leitura de contribuições de plugins, preenchido por AddPlugin<T>().

Precedência da licença: LicenseStream → LicenseContent → LicensePath → descoberta automática (veja Configuração de Licença).

Métodos

AddPlugin<TPlugin>()

text
DoconutOptions AddPlugin<TPlugin>() where TPlugin : IDoconutPlugin, new()

Registra um plugin (Converter, DICOM, Signer). Fluent — retorna a instância de opções. Anotação e Busca são recursos licenciados incorporados e não o utilizam.

Se nenhuma licença ativa conceder a capacidade do plugin, DoconutHost.Initialize lança InvalidOperationException de Application_Start, e o site responde a cada requisição com um 500 vazio até que isso seja corrigido; a mensagem está no log de eventos do Windows (veja Sistema de Plugins).

Add…Widget()

text
DoconutOptions AddConverterWidget(Action<ConverterWidgetOptions>? configure = null)
DoconutOptions AddSignerWidget(Action<SignerWidgetOptions>? configure = null)

Os widgets incorporáveis são desativados por padrão. Cada chamada Add…Widget() liga os endpoints desse widget em DocImage.axd, e requer que o plugin correspondente esteja registrado. O módulo de recursos serve o script do widget independentemente de você tê-lo habilitado, portanto um widget que carrega e pinta mas responde 404 na sua primeira ação está sem essa chamada. O widget Converter está documentado em Plugin Conversor; o widget Signer, AddSignerWidget(), em Plugin Signatário.

RegisterViewer(extension, factory, defaultConfig?)

text
DoconutOptions RegisterViewer(
    string extension,                    // ".myext" — ponto inicial opcional
    Func<IFormatViewer> factory,
    Func<BaseConfig>? defaultConfig = null)

Registra um visualizador personalizado para uma extensão de arquivo. Visualizadores personalizados têm precedência sobre visualizadores incorporados e de plugins e não são controlados por licença. Quando defaultConfig é omitido e um documento abre sem uma configuração explícita, um ImageConfig é usado.

Lança ArgumentException (Extension must be a non-empty file extension.) para uma extensão vazia e ArgumentNullException para uma fábrica nula.

Validação de inicialização

DoconutHost.Initialize valida as opções antes de construir qualquer coisa:

text
DoconutOptions.MiddlewarePath must be a non-empty path starting with '/'.
DoconutOptions.ResourcesPath must be a non-empty path starting with '/'.
DoconutOptions.MiddlewarePath and ResourcesPath must be different paths.

MiddlewarePath é verificado mesmo que o System.Web nunca o use, portanto deixe-o no padrão. Como toda exceção lançada de Application_Start, uma falha de validação aparece como um 500 vazio em cada requisição, com a mensagem no log de eventos do Windows.

Configurações comuns

csharp
// Produção: licença explícita, todo o resto no seu padrão seguro.
public static void ProductionLicense() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.LicenseContent = Environment.GetEnvironmentVariable("DOCONUT_LICENSE") ?? "";
    });

// Caminho de recurso personalizado (ex.: para evitar um conflito de rota). Mantenha o ResPath do visualizador e qualquer MVC
// IgnoreRoute em conjunto com ele: "/docs-assets" significa ResPath: 'docs-assets/images'.
public static void CustomResourcePath() =>
    Doconut.DoconutHost.Initialize(options =>
    {
        options.ResourcesPath = "/docs-assets";
    });

Quando você altera ResourcesPath, altere três coisas juntas: a opção, o ResPath do widget ('docs-assets/images' para "/docs-assets"), e, no MVC, o IgnoreRoute para o caminho do recurso (routes.IgnoreRoute("docs-assets/{*pathInfo}")). O endpoint DocImage.axd não se move: seu caminho é definido pelo atributo path do manipulador em Web.config.

Esta página foi útil?