.NET 6 以降のセットアップ

Startup.cs ファイル

.NET Core プロジェクトの Startup.cs ファイル内で、これらのコード行は MapWhen メソッドを使用したミドルウェア パイプラインの構成を定義します。 提供された述語は、受信リクエストのパスが DocImage.axd で終わるかどうかをチェックします。このブロック内では、UseDoconut メソッドが DoconutOptions オブジェクトを引数として呼び出されます。

Startup.cs
app.MapWhen(
    context => context.Request.Path.ToString().EndsWith("DocImage.axd"),
    appBranch =>
    {
        appBranch.UseDoconut(new DoconutOptions { UnSafeMode = false, ShowDoconutInfo = false });
    }
);

Doconut 名前空間の追加

プロジェクトに以下の using 文を追加してください：

Usings
using Doconut;
using Doconut.Configs;
using Doconut.Formats;
using Doconut.Clouds;

Viewer オブジェクトのインスタンス化

この行は Viewer クラスの新しいインスタンスを生成し、コード内で viewer オブジェクトを作成できるようにします。

Instantiation
var docViewer = new Viewer(_cache, _accessor, licenseFilePath);

DocOptions オブジェクトの設定

特定の構成を持つ DocOptions オブジェクトの初期化例：

DocOptions
var documentOptions = new DocOptions
{
    Password = "",
    ImageResolution = 200,
    TimeOut = 30
};

config オブジェクトの設定

PDF ドキュメントの処理のための特定の構成で新しい PdfConfig オブジェクトを初期化します：

PdfConfig
var config = new PdfConfig { DefaultRender = true, ExtractHyperlinks = true };

ドキュメントを開く

この行は viewer オブジェクトの OpenDocument メソッドを呼び出し、サーバー上にあるドキュメントファイルのパスと、事前に設定した PdfConfig と DocOptions オブジェクトをパラメータとして渡します。

OpenDocument
var token = docViewer.OpenDocument(pathToFile, config, documentOptions);

HTML に viewer を追加する

HTML
<div id="div_ctlDoc"></div>

CSS と JavaScript ファイルの追加

ページに以下の CSS と JavaScript ファイルを追加してください。これらのスクリプトはコードサンプルが含まれる ZIP ファイルに同梱されています。

HTML Headers
<!-- Main Viewer Related Scripts -->
<script src="scripts/splitter.js"></script>
<script src="scripts/docViewer.js"></script>
<script src="scripts/documentLinks.js"></script>

<!-- Viewer functions -->
<script src="scripts/docViewer.UI.js?v=1"></script>

プロジェクトにライセンスを追加する

自動ライセンス検出

自動ライセンス検出で docViewer を初期化するには、次の行を使用します：

C#
var docViewer = new Viewer(_cache, _accessor);

手動でデフォルト ライセンスを追加

viewer を初期化する際に、単一のデフォルト ライセンス ファイルへのパスを手動で指定できます。

C#
var licenseFilePath = Path.Combine(_hostingEnvironment.WebRootPath, "path/to/your/license");
var docViewer = new Viewer(_cache, _accessor, licenseFilePath);

ストリームでライセンスを追加

このメソッドは Viewer.DoconutLicense(Stream licenseStream) のオーバーロードを使用して、ストリームでライセンスを追加します。

C#
using (var licenseStream = new FileStream("path/to/your/license", FileMode.Open))
{
    Viewer.DoconutLicense(licenseStream);
}

XML ドキュメントでライセンス追加

このメソッドは Viewer.DoconutLicense(XMLDocument licence) のオーバーロードを使用して、XML ドキュメントでライセンスを追加します。

C#
var xmlDoc = new XmlDocument();
xmlDoc.Load("path/to/your/license.xml");
Viewer.DoconutLicense(xmlDoc);

手動で複数プラグイン ライセンスのデフォルト設定

複数のライセンスを指定する必要がある場合は、viewer の初期化時にファイルパスのリストを提供できます。

C#
List<string> licenseFilePaths = new List<string>
{
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.lic"),
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.Annotation.lic"),
    Path.Combine(_hostingEnvironment.WebRootPath, "Doconut.Viewer.Search.lic")
};
var docViewer = new Viewer(_cache, _accessor, licenseFilePaths);

ストリームでプラグイン ライセンス追加

このメソッドは Viewer.SetLicensePlugin(Stream pluginLicence) のオーバーロードを使用して、ストリームでプラグイン ライセンスを追加します。

C#
using (var pluginLicenseStream = new FileStream("path/to/your/plugin-license.lic", FileMode.Open))
{
    Viewer.SetLicensePlugin(pluginLicenseStream);
}

XML ドキュメントでプラグイン ライセンス追加

このメソッドは Viewer.SetLicensePlugin(XMLDocument xmlPluginLicence) のオーバーロードを使用して、XML ドキュメントでプラグイン ライセンスを追加します。

C#
var pluginXmlDoc = new XmlDocument();
pluginXmlDoc.Load("path/to/your/plugin-license.xml");
Viewer.SetLicensePlugin(pluginXmlDoc);

必要な NuGet パッケージ

.NET Core Standard と完全に互換性を持たせるため、以下の NuGet パッケージをアルファベット順で含める必要があります。

  • MessagePack - Version 2.5.140
  • Microsoft.Bcl.AsyncInterfaces - Version 8.0.0
  • Microsoft.Extensions.Caching.Abstractions - Version 8.0.0
  • Microsoft.Extensions.Configuration - Version 8.0.0
  • Microsoft.Extensions.Configuration.Abstractions - Version 8.0.0
  • Microsoft.Extensions.Configuration.FileExtensions - Version 8.0.0
  • Microsoft.Extensions.Configuration.Json - Version 8.0.0
  • Microsoft.Extensions.FileProviders.Abstractions - Version 8.0.0
  • Microsoft.Extensions.FileProviders.Physical - Version 8.0.0
  • Microsoft.Extensions.FileSystemGlobbing - Version 8.0.0
  • Microsoft.Extensions.Primitives - Version 8.0.0
  • System.Buffers - Version 4.5.1
  • System.Formats.Asn1 - Version 8.0.0
  • System.Numerics.Vectors - Version 4.5.0
  • System.Security.Cryptography.Cng - Version 5.0.0
  • System.Security.Cryptography.Pkcs - Version 8.0.0
  • System.Text.Encoding.CodePages - Version 8.0.0
  • System.Text.Encodings.Web - Version 8.0.0
  • System.Text.Json - Version 8.0.3
  • System.Threading.Tasks.Extensions - Version 4.5.4

レンダー構成オプション

以下のオプションを使用してレンダリング動作を構成できます：

  • CadConfig: DWG、DXF、DGN ファイルに使用されます。
  • EmailConfig: EML、EMLX、MSG ファイルに使用されます。
  • EpubConfig: EPUB ファイルに使用されます。
  • ExcelConfig: Excel と CSV ファイルに使用されます。
  • MhtConfig: MHT ファイルに使用されます。
  • PptConfig: PowerPoint ファイルに使用されます。
  • ProjectConfig: MPP ファイルに使用されます。
  • PsdConfig: PSD ファイルに使用されます。
  • TxtConfig: TXT ファイルに使用されます。
  • TiffConfig: TIFF ファイルに使用されます。

レンダーオプションの構成

レンダーオプションは DefaultRender プロパティを使用して構成されます：

  • DefaultRender = true : このオプションは高品質なレンダリングを提供しますが、サーバーメモリと処理時間が増加します。
  • DefaultRender = false : このオプションは、若干品質が低下する代わりに高速なレンダリングを提供します。

画像アノテーションの追加方法

C# の場合

1. ドキュメントを開き、最初のページの寸法を取得します。 2. ページの寸法で AnnotationManager を初期化します。 3. ImageAnnotation を作成し、imgUrl に画像パスを設定し、Rectangle 内で位置とサイズを指定します。 4. アノテーションをマネージャに追加し、ドキュメントビューアでロードして表示します。

C#
var token = docViewer.OpenDocument(pathToFile, config, documentOptions);

var firstPage = docViewer.GetThumbnailDimensions(1, 0, 100, false);
var pageWidth = firstPage.Width;
var pageHeight = firstPage.Height;

using (var annMgr = docViewer.GetAnnotationManager(pageWidth, pageHeight))
{
    string imgUrl = "img/sample.png";
    var imgAnn = new ImageAnnotation(
        1,
        new Rectangle(600, 700, 750, 300),
        imgUrl
    );

    annMgr.Add(imgAnn);
    docViewer.LoadAnnotationXML(annMgr.GetAnnotationXml());
}

JavaScript の場合

1. YourController が利用可能であることを確認します。 2. 新しい ImageAnnotation を作成し、SetNote で画像パスを設定します。 3. アノテーションを追加して描画し、ドキュメント上に表示させます。

JavaScript
function ImageStamp() {
    if (null != objctlDoc.YourController()) {
        var objStampImage = new ImageAnnotation({ left: 200, top: 200, width: 260, height: 55 });
        objctlDoc.YourController().AddAnnotation(null, objStampImage, null);

        objStampImage.SetNote('/images/Approved_Stamp.png');
        objStampImage.Paint();
    }
}

Word ドキュメントでのカスタム フォント

WordConfig クラスの FontFolders プロパティは、アプリケーションがフォントを検索するカスタムディレクトリを指定します。これは、システムのデフォルトフォントディレクトリにインストールされていないフォントに依属する Word ドキュメントを処理する際に特に便利です。

Usage
var config = new WordConfig
{
    FontFolders = new string[] { "C:\\CustomFonts", "D:\\SharedFonts" }
};

Doconut 25.2.0 の重要な更新

すべてのプロジェクトで System.Text.Json パッケージをバージョン 8.0.5 に更新することが重要です。この更新は、最新機能との互換性を確保し、重要なセキュリティ改善に対応するために不可適です。

メール エンコーディング

EmailConfig クラスの EmailEncoding プロパティは、メールの文名と本文の両方に推奨されるエンコーディングを指定します。

Usage
var emailConfig = new EmailConfig {
    EmailEncoding = Encoding.UTF8 // Set preferred email encoding
};

件名と本文のエンコーディング

EmailConfig クラスの SubjectEncoding と BodyEncoding プロパティは、メールの文名と本文にそれぞれ使用されるエンコーディングを定義します。

Usage
var emailConfig = new EmailConfig {
    SubjectEncoding = Encoding.UTF8, // Set encoding for the subject
    BodyEncoding = Encoding.UTF8     // Set encoding for the body
};

Word ビューアーカルチャーサポート

WordConfig クラスの DocumentCulture プロパティを使用すると、DOC および DOCX ファイルのカルチャを明簡的に指定できます。これにより、日付、通貨、数値などのローカライズされた内容が Microsoft Word と同様に正確に表示されます。特に、微分の書式設定必須がある言語に役翔できます。

Usage
var config = new WordConfig { DocumentCulture = "he-IL" }; // Hebrew (Israel)
var config = new WordConfig { DocumentCulture = "ar-SA" }; // Arabic (Saudi Arabia)
var config = new WordConfig { DocumentCulture = "th-TH" }; // Thai (Thailand)
var config = new WordConfig { DocumentCulture = "ja-JP" }; // Japanese (Japan)

必要な CSS と JS ファイルのダウンロード

Doconut が正しく機能するように、プロジェクトに特定の CSS と JS ファイルを含める必要があります。以下のリンクから、必要なすべてのファイルが入った ZIP ファイルがダウンロードできます：

Doconut の JS と CSS ファイルをダウンロード