Konfigurasi Format

Opsi rendering lengkap per-format

Setiap dokumen dibuka dengan implementasi BaseConfig. Berikan satu ke OpenDocumentAsync atau biarkan katalog format membuat defaultnya. Semua kelas di bawah ini berada dalam namespace Doconut.

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

Pewarisan dan pengaturan PDF bersarang

Setiap format mewarisi lima properti BaseConfig. Format yang dapat mengalihkan melalui PDF mengekspos PdfConfig bersarang. Pada WordConfig, ExcelConfig, dan PptConfig, AllowSearch dan AllowCopy adalah properti kemudahan yang membaca dan menulis PdfConfig bersarang.

DefaultRender = true memilih renderer format asli. Pada format dengan pengalihan PDF, false mengonversi terlebih dahulu ke PDF dalam memori dan kemudian menggunakan penampil PDF. Jalur itu sering berguna untuk pencarian koordinat teks, tetapi memerlukan konversi tambahan.

Kecuali dinyatakan lain, tabel menampilkan nilai default konstruktor/properti. Katalog format otomatis secara sengaja menimpa dua di antaranya: ia membuat ExcelConfig dengan SplitWorksheets = true, dan MhtConfig dengan DefaultRender = false.

BaseConfig

TipePropertiBawaanPerilaku
intImageResolution00 menggunakan default format. Rentang eksplisit yang valid adalah 25-300 DPI; penetapan yang tidak valid diabaikan.
stringDocumentCulture""Lokal untuk tanggal dan angka. Nilai yang tidak kosong dipangkas; penetapan kosong diabaikan.
stringPassword""Kata sandi dokumen yang dilindungi. DocOptions.Password disalin ke sini secara otomatis.
boolShowUItrueProperti kompatibilitas; renderer saat ini tidak menggunakannya untuk mengontrol bilah alat browser.
boolCachePagestrueMenyimpan cache gambar halaman yang dirender untuk sesi dokumen.

PdfConfig

Format: PDF. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueSaklar kompatibilitas. Pabrik saat ini menggunakan penampil PDF asli.
boolAllowSearchfalseMembuat/menggunakan indeks pencarian teks PDF. Membutuhkan kemampuan lisensi Search untuk permintaan.
boolAllowCopyfalseMengizinkan operasi pemilihan/penyalinan teks.
boolExtractHyperlinksfalseMengekstrak persegi panjang tautan untuk overlay klien.
intHyperlinksPageCount0Jumlah maksimum halaman yang dipindai untuk tautan; 0 berarti semua halaman.
boolCompressImagesfalseMengompres gambar tersemat sebelum rendering.
intCompressQuality100Kualitas JPEG yang digunakan saat kompresi diaktifkan.
boolResizeImagesfalseMengubah ukuran gambar tersemat sebelum rendering.
intResizeResolution300DPI target untuk gambar yang diubah ukurannya.
boolCompressFastfalseMemilih jalur kompresi yang lebih cepat namun kualitas lebih rendah.
boolFixInvalidImagesfalseMencoba memperbaiki gambar tersemat yang tidak valid.
boolSplitSegmentsfalseMenggabungkan kembali kata yang terpisah di segmen baris untuk meningkatkan pencarian/penyalinan.

showHyperlinks di ViewerConfig mengontrol overlay klien, sementara ExtractHyperlinks mengontrol ekstraksi server. Aktifkan keduanya.

WordConfig

Format: DOC, DOCX, DOCM, DOT, DOTX, DOTM, RTF, ODT, OTT, XML. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRendering Word asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstance baruPengaturan yang digunakan oleh jalur PDF/pencarian.
DocPaperSizePaperSizeA4Ukuran kertas output. Gunakan Custom dengan lebar/tinggi.
intPaperWidth595Lebar khusus dalam poin.
intPaperHeight841Tinggi khusus dalam poin.
boolRemovePaperMarginfalseMenghapus margin halaman dokumen.
boolRenderPageColortrueMempertahankan warna halaman yang dikonfigurasi di Word; false merender halaman putih.
boolExportPdfAfalseMenggunakan PDF/A arsip pada jalur PDF.
Encoding?FileEncodingnullMenimpa enkoding sumber.
stringFontInfo""Informasi substitusi font.
string[]?FontFoldersnullDirektori font tambahan, terutama berguna di Linux/kontainer.
boolAllowSearchfalseMendelegasikan ke PdfConfig.AllowSearch.
boolAllowCopyfalseMendelegasikan ke PdfConfig.AllowCopy.
TableAutoFitBehaviorAutoFitAllTablesNoneNone, AutoFitToContents, atau AutoFitToWindow.

ExcelConfig

Format: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRendering lembar asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstance baruPengaturan untuk jalur PDF/pencarian.
ExcelPaperSizePaperSizePaperA4Ukuran kertas output.
doublePaperMargins0.25Margin halaman dalam inci.
boolPaperLandscapetrueRendering lembar lanskap.
boolAutoFitContentsfalseMenyesuaikan otomatis tinggi baris dan lebar kolom.
boolRemoveEmptyContenttrueMemperketat output dengan mengecualikan konten kosong.
boolCalculateFormulatrueMenghitung ulang rumus sebelum rendering.
boolShowRowColumnHeaderstrueMenyertakan header spreadsheet.
boolExportPdfAfalseMenggunakan PDF/A pada jalur PDF.
boolSplitWorksheetsfalseMenjaga lembar kerja sebagai grup halaman terpisah.
boolShowEmptyWorkSheetsfalseMenyertakan lembar kerja kosong.
boolExportLandscapefalseMemaksa ekspor lanskap.
boolExportOnePagePerSheetfalseMenyesuaikan setiap lembar kerja ke satu halaman output.
boolMemoryOptimizationPreferencetrueMengurangi memori puncak, mungkin mengorbankan sedikit kecepatan.
boolAutoTrimWorksheetRenderRangetrueMerender hanya rentang yang terlihat digunakan ketika tidak ada area cetak eksplisit.
boolAutoTrimPreserveExistingPrintAreatrueMempertahankan area cetak yang didefinisikan workbook selama auto-trim.
string?PrintAreanullRentang eksplisit seperti "A1:Z100".
boolPrintGridlinesfalseMencetak garis kisi lembar kerja.
boolPrintHeadingsfalseMencetak heading baris/kolom.
List<string>SheetNameskosongMembatasi rendering ke lembar kerja yang bernama.
CustomStyleCell?CustomStylesnullPenimpaan format tanggal/desimal/integer opsional.
boolAllowSearchfalseMendelegasikan ke PdfConfig.AllowSearch.
boolAllowCopyfalseMendelegasikan ke PdfConfig.AllowCopy.

CustomStyleCell mengekspos CustomStyleDateTime, CustomStyleNumberDecimal, dan CustomStyleNumberInteger, semuanya string yang dapat bernilai null.

new ExcelConfig() mengatur SplitWorksheets menjadi false; membuka file Excel tanpa konfigurasi eksplisit menggunakan katalog format, yang mengaturnya menjadi true.

PptConfig

Format: PPT, PPTX, PPTM, PPSX, PPSM, POT, POTX, POTM, ODP. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRendering slide asli; false menggunakan pengalihan PDF.
boolFastLoadfalseMenghindari rendering slide pertama saat membuka; gunakan metadata dan render sesuai permintaan.
PdfConfigPdfConfiginstance baruPengaturan untuk perilaku PDF/pencarian.
stringFontInfo""Informasi substitusi font.
string[]?FontFoldersnullDirektori font tambahan.
boolAllowSearchfalseMendelegasikan ke PdfConfig.AllowSearch.
boolAllowCopyfalseMendelegasikan ke PdfConfig.AllowCopy.

Di Linux dan macOS, rendering presentasi dengan mesin saat ini memerlukan libgdiplus dan System.Drawing.EnableUnixSupport=true. Instal font yang digunakan oleh presentasi atau sediakan FontFolders.

CadConfig

Format: DWG, DXF, DGN. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRendering CAD asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstance baruPengaturan jalur PDF.
boolExportPdfAfalseOutput PDF/A arsip.
boolShowColortrueWarna bukan monokrom.
boolWhiteBackgroundtrueLatar putih bukan hitam.
shortLineWidth25Lebar goresan CAD.
boolShowLayoutsfalseMerender tab tata letak.
boolShowModeltrueMerender ruang model.
boolCheck3DSolidtrueMemproses solid 3D.
boolExportAllLayoutsfalseMengekspor semua tata letak, menimpa pemilihan model/tata letak.
boolLimitMinimumSizefalseMenerapkan MinimumSize.
intMinimumSize700Ukuran output minimum dalam piksel.
boolLimitMaximumSizefalseMenerapkan MaximumSize.
intMaximumSize700Ukuran output maksimum dalam piksel.
boolShowAllLayoutsDgnfalseMenyertakan semua tata letak DGN.
boolAutomaticLayoutScalingtrueMenskalakan tata letak secara otomatis.
floatPdfMargins0.5Margin PDF dalam inci.
RenderQualityQualityImageLowKualitas raster: Low, Medium, atau High.
RenderQualityQualityTextMediumKualitas teks: Low, Medium, atau High.

EmailConfig

Format: EML, EMLX, MSG. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRendering email asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstance baruPengaturan jalur PDF.
Encoding?EmailEncodingnullMenimpa enkoding pesan.
Encoding?SubjectEncodingnullMenimpa enkoding subjek.
Encoding?BodyEncodingnullMenimpa enkoding isi.
boolSkipExternalImagesfalseTidak memuat gambar yang direferensikan secara remote. Disarankan untuk email yang tidak dipercaya.
boolRemoveLastWhitePagefalseMenghapus halaman putih terakhir.
boolUseAntiAliasingfalseMengaktifkan anti-aliasing.
boolUseHighQualityRenderingfalseMemilih rendering yang lebih bersih namun lebih lambat.
TimeSpan?TimeZoneOffsetnullMenimpa zona waktu yang digunakan untuk tanggal.
boolForcePageSizefalseMemaksa dimensi halaman tetap.

ImageConfig, TiffConfig, and PsdConfig

ImageConfig mencakup JPG, JPEG, JPE, PNG, BMP, GIF, ICO, EPS, TGA, WEBP, CDR, CMX, DNG, EMF, WMF, AVIF, dan SVG. DPI defaultnya adalah 100.

KonfigPropertiBawaanPerilaku
ImageConfigMaxImagePixelSize3000Lebar/tinggi maksimum. 0 berarti tak terbatas; nilai nonzero di bawah 50 diabaikan.
ImageConfigTransparentPngtrueMempertahankan transparansi PNG; false menggunakan latar putih.
TiffConfigtidak ada properti tambahanDPI 200Hanya menggunakan BaseConfig; mendukung TIFF multi-halaman.
PsdConfigMaxImagePixelSize3000Validasi 0/minimum-50 yang sama seperti ImageConfig; DPI default adalah 100.

DicomConfig

Format: DCM, IMA. DPI efektif default: 100. Membutuhkan plugin DICOM.

TipePropertiBawaanPerilaku
intHorizontalResolution100 efektifDPI horizontal eksplisit; jika tidak ImageResolution, kemudian 100.
intVerticalResolution100 efektifDPI vertikal eksplisit; jika tidak ImageResolution, kemudian 100.
intAnimationFrameDelayMs100Penundaan animasi multi-frame; timing GIF menggunakan satuan 10 ms.
ushortLoopCount00 loop selamanya; nilai positif berhenti setelah jumlah tersebut.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly, atau ikhtisar gabungan plus frame statis.

TxtConfig

Format: TXT. DPI default: 200.

TipePropertiBawaanPerilaku
DocPaperSizePaperSizeA4Ukuran kertas output.
Encoding?FileEncodingnullnull menggunakan UTF-8.
stringFontInformation""Informasi font untuk rendering teks.

Gunakan WordConfig ketika teks biasa membutuhkan perilaku tata letak halaman yang lebih kaya.

ProjectConfig

Format: MPP, MPPX, MPX. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueGambar Gantt asli; false menggunakan jalur PDF berbasis teks.
PdfConfigPdfConfiginstance baruPengaturan jalur PDF.
boolExportPdfAtrueOutput PDF/A arsip.
MppPaperSizePaperSizeLedgerUkuran kertas output proyek.
MppTimeScaleTimeScaleMonthsDays atau Months.
MppFormatPresentationFormatGanttChartGanttChart, TaskUsage, ResourceUsage, ResourceSheet, atau TaskSheet.

Untuk pencarian koordinat teks yang tepat, gunakan DefaultRender = false.

VisioConfig

Format: VSD, VSDX, VSS, VSSX, VST, VSTX, VDX, VSX, VSDM. DPI default: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRendering diagram asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstance baruPengaturan jalur PDF.
boolExportPdfAtrueOutput PDF/A arsip.

HtmlConfig, EpubConfig, MhtConfig, and XpsConfig

Keempatnya default ke DPI 200 dan mengekspos PdfConfig bersarang.

KonfigFormatDefaultRenderProperti/perilaku tambahan
HtmlConfigHTML, HTMtrueRendering asli; gunakan false untuk jalur pencarian PDF berbasis teks.
EpubConfigEPUBtrueRendering asli; false menggunakan PDF.
MhtConfigMHT, MHTMLtrue pada kelas; false di katalog otomatisPembukaan normal tanpa konfigurasi menggunakan pengalihan PDF yang dapat dicari. Instance default yang dibangun secara eksplisit merender secara native.
XpsConfigXPSfalseMenggunakan jalur PDF secara default; set true untuk rendering gambar native.

Configuration examples by family

csharp
BaseConfig[] configs =
[
    new PdfConfig
    {
        AllowSearch = true,
        ExtractHyperlinks = true,
        HyperlinksPageCount = 0
    },
    new WordConfig
    {
        PaperSize = DocPaperSize.A4,
        RemovePaperMargin = false,
        FontFolders = ["/usr/share/fonts/truetype"],
        AllowSearch = true
    },
    new ExcelConfig
    {
        PaperLandscape = true,
        AutoFitContents = true,
        CalculateFormula = true,
        SplitWorksheets = false,
        PrintGridlines = false
    },
    new PptConfig
    {
        FastLoad = true,
        FontFolders = ["/usr/share/fonts/truetype"],
        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
    }
];

Per-extension selection

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 redirect → pixel-accurate native text search
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // fall back to the format's default config
};

Apakah halaman ini membantu?