フォーマット設定

フォーマットごとの完全なレンダリングオプション

すべてのドキュメントは BaseConfig 実装で開始します。OpenDocumentAsync に渡すか、フォーマットカタログにデフォルトを作成させてください。以下のすべてのクラスは Doconut 名前空間に存在します。

その単一の名前空間は新しいものです。以前の .NET Standard ライブラリではこれらの型が Doconut.Configs、Doconut.Configs.View、Doconut.Models に分散していました。型名は変更されませんでした — ほとんどのファイルでは、編集内容は using 行を2行削除するだけです。マイグレーションガイドをご覧ください。

csharp
var token = await viewer.OpenDocumentAsync(path, new PdfConfig
{
    AllowSearch = true,
    AllowCopy   = true,
    ImageResolution = 150
});

継承とネストされた PDF 設定

すべてのフォーマットは 5 つの BaseConfig プロパティを継承します。PDF 経由でリダイレクトできるフォーマットはネストされた PdfConfig を公開します。WordConfig、ExcelConfig、PptConfig では、AllowSearch と AllowCopy が便利なプロパティとして、ネストされた PdfConfig の読み書きを行います。

DefaultRender = true はネイティブフォーマットレンダラーを選択します。PDF リダイレクトを持つフォーマットでは、false が最初にインメモリ PDF に変換し、その後 PDF ビューアを使用します。このパスはテキスト座標検索に便利ですが、余分な変換コストがかかります。

特に記載がない限り、表はコンストラクタ/プロパティのデフォルトを示しています。自動フォーマットカタログは意図的にそのうちの 2 つを上書きします:ExcelConfig を SplitWorksheets = true で作成し、MhtConfig を DefaultRender = false で作成します。

BaseConfig 設定

型プロパティデフォルト動作
intImageResolution00 はフォーマットのデフォルトを使用します。有効な明示的範囲は 25〜300 DPI です。無効な割り当ては無視されます。
stringDocumentCulture""日付と数値のロケールです。空でない値はトリムされ、空白の割り当ては無視されます。
stringPassword""保護されたドキュメントのパスワードです。DocOptions.Password は自動的にここにコピーされます。
boolShowUItrue互換性プロパティです;現在のレンダラーはブラウザツールバーの制御に使用しません。
boolCachePagestrueドキュメントセッションのためにレンダリングされたページ画像をキャッシュします。

PdfConfig 設定

フォーマット: PDF。デフォルト DPI: 200。

型プロパティデフォルト動作
boolDefaultRendertrue互換性スイッチです。現在のファクトリはネイティブ PDF ビューアを使用します。
boolAllowSearchfalsePDF テキスト検索インデックスを構築/使用します。リクエストには Search ライセンス機能が必要です。
boolAllowCopyfalseテキスト選択/コピー操作を許可します。
boolExtractHyperlinksfalseクライアントオーバーレイ用にリンク矩形を抽出します。
intHyperlinksPageCount0リンクをスキャンする最大ページ数です;0 はすべてのページを意味します。
boolCompressImagesfalseレンダリング前に埋め込み画像を圧縮します。
intCompressQuality100圧縮が有効な場合に使用される JPEG 品質です。
boolResizeImagesfalseレンダリング前に埋め込み画像のサイズを変更します。
intResizeResolution300サイズ変更された画像の目標 DPI です。
boolCompressFastfalseより高速で低品質な圧縮パスを優先します。
boolFixInvalidImagesfalse無効な埋め込み画像の修復を試みます。
boolSplitSegmentsfalse検索/コピーを改善するために、行セグメントをまたいで分割された単語を再結合します。

showHyperlinks は ViewerConfig でクライアントオーバーレイを制御し、ExtractHyperlinks はサーバ抽出を制御します。両方を有効にしてください。

WordConfig 設定

フォーマット: DOC、DOCX、DOCM、DOT、DOTX、DOTM、RTF、ODT、OTT、XML。デフォルト DPI: 200。

型プロパティデフォルト動作
boolDefaultRendertrueネイティブ Word レンダリングです;false は PDF リダイレクトを使用します。
PdfConfigPdfConfig新しいインスタンスPDF/検索パスで使用される設定です。
DocPaperSizePaperSizeA4出力用紙サイズです。幅/高さとともに Custom を使用してください。
intPaperWidth595ポイント単位のカスタム幅です。
intPaperHeight841ポイント単位のカスタム高さです。
boolRemovePaperMarginfalseドキュメントページの余白を削除します。
boolRenderPageColortrueWord の設定されたページカラーを保持します;false は白いページをレンダリングします。
boolExportPdfAfalsePDF パスでアーカイブ用 PDF/A を使用します。
Encoding?FileEncodingnullソースエンコーディングを上書きします。
stringFontInfo""フォント置換情報です。
string[]?FontFoldersnull追加のフォントディレクトリ — ドキュメントが使用するフォントがサーバにない場合に便利です。
boolAllowSearchfalsePdfConfig.AllowSearch に委譲します。
boolAllowCopyfalsePdfConfig.AllowCopy に委譲します。
TableAutoFitBehaviorAutoFitAllTablesNoneNone、AutoFitToContents、または AutoFitToWindow です。

Excel設定

形式: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. デフォルト DPI: 200.

型プロパティデフォルト動作
boolDefaultRendertrueネイティブシートレンダリング; false は PDF リダイレクトを使用します。
PdfConfigPdfConfig新しいインスタンスPDF/検索パスの設定。
ExcelPaperSizePaperSizePaperA4出力用紙サイズ。
doublePaperMargins0.25ページ余白(インチ単位)。
boolPaperLandscapetrue横向きシートのレンダリング。
boolAutoFitContentsfalse行の高さと列の幅を自動調整。
boolRemoveEmptyContenttrue空のコンテンツを除外して出力を圧縮。
boolCalculateFormulatrueレンダリング前に数式を再計算。
boolShowRowColumnHeaderstrueスプレッドシートのヘッダーを含める。
boolExportPdfAfalsePDF パスで PDF/A を使用。
boolSplitWorksheetsfalseワークシートを別々のページグループとして保持。
boolShowEmptyWorkSheetsfalse空のワークシートを含める。
boolExportLandscapefalse横向きエクスポートを強制。
boolExportOnePagePerSheetfalse各ワークシートを1ページに収める。
boolMemoryOptimizationPreferencetrueピークメモリを削減し、速度が若干低下する可能性があります。
boolAutoTrimWorksheetRenderRangetrue明示的な印刷領域がない場合、表示されている使用範囲のみをレンダリング。
boolAutoTrimPreserveExistingPrintAreatrue自動トリム時にブックで定義された印刷領域を保持。
string?PrintAreanull例えば "A1:Z100" のような明示的な範囲。
boolPrintGridlinesfalseワークシートのグリッドラインを印刷。
boolPrintHeadingsfalse行/列の見出しを印刷。
List<string>SheetNames空名前付きワークシートにレンダリングを制限。
CustomStyleCell?CustomStylesnullオプションの日時/小数/整数書式の上書き。
boolAllowSearchfalsePdfConfig.AllowSearch に委譲。
boolAllowCopyfalsePdfConfig.AllowCopy に委譲。

CustomStyleCell は CustomStyleDateTime、CustomStyleNumberDecimal、および CustomStyleNumberInteger を公開し、すべて nullable 文字列です。

new ExcelConfig() は SplitWorksheets を false に設定します。明示的な構成なしで Excel ファイルを開くと、フォーマットカタログが使用され、true に設定されます。

Ppt設定

形式: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. デフォルト DPI: 200.

型プロパティデフォルト動作
boolDefaultRendertrueネイティブスライドレンダリング; false は PDF リダイレクトを使用します。
boolFastLoadfalse開く際に最初のスライドのレンダリングを回避し、メタデータを使用してオンデマンドでレンダリング。
PdfConfigPdfConfig新しいインスタンスPDF/検索動作の設定。
stringFontInfo""フォント置換情報。
string[]?FontFoldersnull追加のフォントディレクトリ。
boolAllowSearchfalsePdfConfig.AllowSearch に委譲。
boolAllowCopyfalsePdfConfig.AllowCopy に委譲。

プレゼンテーションで使用されるフォントをサーバーにインストールするか、FontFolders をそれらが格納されたフォルダーに指すようにしてください。欠落したフォントはエラーなく置換されます。

Cad設定

形式: DWG, DXF, DGN. デフォルト DPI: 200.

型プロパティデフォルト動作
boolDefaultRendertrueネイティブ CAD レンダリング; false は PDF リダイレクトを使用します。
PdfConfigPdfConfig新しいインスタンスPDF パス設定。
boolExportPdfAfalseアーカイブ用 PDF/A 出力。
boolShowColortrueモノクロではなくカラー。
boolWhiteBackgroundtrue黒背景ではなく白背景。
shortLineWidth25CAD のストローク幅。
boolShowLayoutsfalseレイアウトタブをレンダリング。
boolShowModeltrueモデル空間をレンダリング。
boolCheck3DSolidtrue3D ソリッドを処理。
boolExportAllLayoutsfalseすべてのレイアウトをエクスポートし、モデル/レイアウト選択を上書き。
boolLimitMinimumSizefalseMinimumSize を適用。
intMinimumSize700最小出力サイズ(ピクセル)。
boolLimitMaximumSizefalseMaximumSize を適用。
intMaximumSize700最大出力サイズ(ピクセル)。
boolShowAllLayoutsDgnfalseすべての DGN レイアウトを含める。
boolAutomaticLayoutScalingtrueレイアウトを自動的にスケール。
floatPdfMargins0.5PDF の余白(インチ)。
RenderQualityQualityImageLowラスター品質: Low、Medium、または High。
RenderQualityQualityTextMediumテキスト品質: Low、Medium、または High。

EmailConfig

形式: EML、EMLX、MSG。デフォルト DPI: 200。

タイププロパティデフォルト動作
boolDefaultRendertrueネイティブメールレンダリング; false は PDF リダイレクトを使用します。
PdfConfigPdfConfig新しいインスタンスPDF パス設定。
Encoding?EmailEncodingnullメッセージエンコーディングを上書きします。
Encoding?SubjectEncodingnull件名エンコーディングを上書きします。
Encoding?BodyEncodingnull本文エンコーディングを上書きします。
boolSkipExternalImagesfalseリモート参照画像をロードしません。信頼できないメールに推奨されます。
boolRemoveLastWhitePagefalse末尾の空白ページを削除します。
boolUseAntiAliasingfalseアンチエイリアスを有効にします。
boolUseHighQualityRenderingfalseよりクリーンで遅いレンダリングを優先します。
TimeSpan?TimeZoneOffsetnull日付に使用されるタイムゾーンを上書きします。
boolForcePageSizefalse固定ページサイズを強制します。

ImageConfig, TiffConfig, and PsdConfig

ImageConfig は JPG、JPEG、JPE、PNG、BMP、GIF、ICO、EPS、TGA、WEBP、CDR、CMX、DNG、EMF、WMF、AVIF、SVG をサポートします。そのデフォルト DPI は 100 です。

設定プロパティデフォルト動作
ImageConfigMaxImagePixelSize3000最大幅/高さ。0 は無制限を意味します。0 以外の 50 未満の値は無視されます。
ImageConfigTransparentPngtruePNG の透過性を保持します。false は白い背景を使用します。
TiffConfig追加プロパティなしDPI 200BaseConfig のみを使用します。マルチページ TIFF をサポートします。
PsdConfigMaxImagePixelSize3000ImageConfig と同様の 0/最小 50 の検証です。デフォルト DPI は 100 です。

DicomConfig

形式: DCM、IMA。デフォルト有効 DPI: 100。DICOM プラグインが必要です。このパッケージでは DICOM ファイルは完全にレンダリングされますが、技術メタデータは利用できません — DICOM プラグイン を参照してください。

タイププロパティデフォルト動作
intHorizontalResolution100 effective明示的な水平 DPI。指定がない場合は ImageResolution、その後 100。
intVerticalResolution100 effective明示的な垂直 DPI。指定がない場合は ImageResolution、その後 100。
intAnimationFrameDelayMs100マルチフレームアニメーション遅延。GIF のタイミングは 10 ms 単位です。
ushortLoopCount00 は無限にループします。正の値はその回数で停止します。
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly、FramesOnly、または概要と静止フレームの組み合わせ。

TxtConfig

形式: TXT。デフォルト DPI: 200。

タイププロパティデフォルト動作
DocPaperSizePaperSizeA4出力用紙サイズ。
Encoding?FileEncodingnullnull は UTF-8 を使用します。
stringFontInformation""テキストレンダリング用のフォント情報。

プレーンテキストでリッチなページレイアウト動作が必要な場合は WordConfig を使用してください。

ProjectConfig

形式: MPP、MPPX、MPX。デフォルト DPI: 200。

タイププロパティデフォルト動作
boolDefaultRendertrueネイティブ Gantt 画像。false はテキストベースの PDF パスを使用します。
PdfConfigPdfConfig新しいインスタンスPDF パス設定。
boolExportPdfAtrueアーカイブ用 PDF/A 出力。
MppPaperSizePaperSizeLedgerプロジェクト出力用紙サイズ。
MppTimeScaleTimeScaleMonthsDays または Months。
MppFormatPresentationFormatGanttChartGanttChart、TaskUsage、ResourceUsage、ResourceSheet、または TaskSheet。

正確なテキスト座標検索には DefaultRender = false を使用してください。

VisioConfig

形式: VSD、VSDX、VSS、VSSX、VST、VSTX、VDX、VSX、VSDM。デフォルト DPI: 200。

タイププロパティデフォルト動作
boolDefaultRendertrueネイティブ図表レンダリング。false は PDF リダイレクトを使用します。
PdfConfigPdfConfig新しいインスタンスPDF パス設定。
boolExportPdfAtrueアーカイブ用 PDF/A 出力。

HtmlConfig, EpubConfig, MhtConfig, and XpsConfig

4 つすべてはデフォルトで 200 DPI で、ネストされた PdfConfig を公開します。

設定形式DefaultRender追加プロパティ/動作
HtmlConfigHTML, HTMtrueネイティブレンダリング。テキストベースの PDF 検索パスには false を使用してください。
EpubConfigEPUBtrueネイティブレンダリング。false は PDF を使用します。
MhtConfigMHT, MHTMLtrue はクラス上で、false は自動カタログで通常の設定なしで開く場合は検索可能な PDF リダイレクトを使用します。明示的に構築されたデフォルトインスタンスはネイティブにレンダリングします。
XpsConfigXPSfalseデフォルトで PDF パスを使用します。ネイティブ画像レンダリングには true を設定してください。

ファミリー別の設定例

csharp
BaseConfig[] configs =
{
    new PdfConfig
    {
        AllowSearch = true,
        ExtractHyperlinks = true,
        HyperlinksPageCount = 0
    },
    new WordConfig
    {
        PaperSize = DocPaperSize.A4,
        RemovePaperMargin = false,
        FontFolders = new[] { Path.Combine(AppContext.BaseDirectory, "Fonts") },
        AllowSearch = true
    },
    new ExcelConfig
    {
        PaperLandscape = true,
        AutoFitContents = true,
        CalculateFormula = true,
        SplitWorksheets = false,
        PrintGridlines = false
    },
    new PptConfig
    {
        FastLoad = true,
        FontFolders = new[] { Path.Combine(AppContext.BaseDirectory, "Fonts") },
        AllowSearch = true
    },
    new CadConfig
    {
        ShowColor = true,
        WhiteBackground = true,
        ShowModel = true,
        ShowLayouts = false,
        QualityText = CadConfig.RenderQuality.High
    },
    new EmailConfig
    {
        SkipExternalImages = true,
        RemoveLastWhitePage = true,
        TimeZoneOffset = TimeSpan.Zero
    },
    new ImageConfig
    {
        MaxImagePixelSize = 3000,
        TransparentPng = true
    },
    new DicomConfig
    {
        DisplayMode = DicomDisplayMode.AnimationAndFrames,
        AnimationFrameDelayMs = 100,
        LoopCount = 0
    }
};

拡張子別の選択

csharp
static BaseConfig? ConfigForExtension(string extUpper) => extUpper switch
{
    ".DOC" or ".DOCX" or ".DOT" or ".DOTX" or ".ODT" => new WordConfig
    {
        AutoFitAllTables = WordConfig.TableAutoFitBehavior.AutoFitToWindow,
        PaperSize = DocPaperSize.Tabloid,
        PdfConfig = new PdfConfig { ExtractHyperlinks = true, HyperlinksPageCount = 5, AllowCopy = true }
    },
    ".PDF" => new PdfConfig { AllowSearch = true, AllowCopy = true },
    ".XLS" or ".XLSX" or ".ODS" or ".CSV" => new ExcelConfig { AllowSearch = true, AllowCopy = true },
    ".DCM" or ".IMA" => new DicomConfig { DisplayMode = DicomDisplayMode.AnimationAndFrames },
    // DefaultRender = false → PDF リダイレクト → ピクセル単位で正確なネイティブテキスト検索
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // フォーマットのデフォルト設定にフォールバック
};

このページは役に立ちましたか?