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 di namespace Doconut.

Namespace tunggal itu baru. Perpustakaan .NET Standard sebelumnya menyebarkan tipe-tipe ini di Doconut.Configs, Doconut.Configs.View, dan Doconut.Models. Nama tipe tidak berubah — di sebagian besar file seluruh perubahan hanyalah menghapus dua baris using. Lihat panduan migrasi.

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 mengarahkan ulang melalui PDF mengekspos sebuah PdfConfig bersarang. Di WordConfig, ExcelConfig, dan PptConfig, AllowSearch dan AllowCopy adalah properti kemudahan yang membaca dan menulis PdfConfig bersarang.

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

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

BaseConfig

TipePropertiDefaultPerilaku
intImageResolution00 menggunakan default format. Rentang eksplisit yang valid adalah 25-300 DPI; penugasan yang tidak valid diabaikan.
stringDocumentCulture""Locale untuk tanggal dan angka. Nilai yang tidak kosong dipangkas; penugasan kosong diabaikan.
stringPassword""Kata sandi dokumen terlindungi. DocOptions.Password disalin ke sini secara otomatis.
boolShowUItrueProperti kompatibilitas; renderer saat ini tidak menggunakannya untuk mengontrol toolbar browser.
boolCachePagestrueCache gambar halaman yang dirender untuk sesi dokumen.

PdfConfig

Format: PDF. DPI default: 200.

TipePropertiDefaultPerilaku
boolDefaultRendertrueSakelar kompatibilitas. Pabrik saat ini menggunakan penampil PDF native.
boolAllowSearchfalseMembangun/menggunakan indeks pencarian teks PDF. Membutuhkan kemampuan lisensi Search untuk permintaan.
boolAllowCopyfalseIzinkan operasi pemilihan/penyalinan teks.
boolExtractHyperlinksfalseEkstrak persegi panjang tautan untuk overlay klien.
intHyperlinksPageCount0Maksimum halaman yang dipindai untuk tautan; 0 berarti setiap halaman.
boolCompressImagesfalseKompres gambar tersemat sebelum rendering.
intCompressQuality100Kualitas JPEG yang digunakan ketika kompresi diaktifkan.
boolResizeImagesfalseUbah ukuran gambar tersemat sebelum rendering.
intResizeResolution300DPI target untuk gambar yang diubah ukurannya.
boolCompressFastfalseLebih suka jalur kompresi yang lebih cepat namun kualitas lebih rendah.
boolFixInvalidImagesfalseCoba memperbaiki gambar tersemat yang tidak valid.
boolSplitSegmentsfalseGabungkan kembali kata yang terpisah di antara 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.

TipePropertiDefaultPerilaku
boolDefaultRendertrueRender Word native; false menggunakan pengalihan PDF.
PdfConfigPdfConfignew instancePengaturan yang digunakan oleh jalur PDF/pencarian.
DocPaperSizePaperSizeA4Ukuran kertas output. Gunakan Custom dengan lebar/tinggi.
intPaperWidth595Lebar khusus dalam poin.
intPaperHeight841Tinggi khusus dalam poin.
boolRemovePaperMarginfalseHapus margin halaman dokumen.
boolRenderPageColortruePertahankan warna halaman yang dikonfigurasi di Word; false merender halaman putih.
boolExportPdfAfalseGunakan PDF/A arsip pada jalur PDF.
Encoding?FileEncodingnullTimpa enkoding sumber.
stringFontInfo""Informasi substitusi font.
string[]?FontFoldersnullDirektori font tambahan — berguna pada server yang tidak memiliki font yang digunakan dokumen.
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.

TipePropertiDefaultPerilaku
boolDefaultRendertrueRender lembar asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstansi baruPengaturan untuk jalur PDF/pencarian.
ExcelPaperSizePaperSizePaperA4Ukuran kertas output.
doublePaperMargins0.25Margin halaman dalam inci.
boolPaperLandscapetrueRender lembar lanskap.
boolAutoFitContentsfalseSesuaikan otomatis tinggi baris dan lebar kolom.
boolRemoveEmptyContenttrueMemperketat output dengan mengecualikan konten kosong.
boolCalculateFormulatrueHitung ulang rumus sebelum render.
boolShowRowColumnHeaderstrueSertakan header spreadsheet.
boolExportPdfAfalseGunakan PDF/A pada jalur PDF.
boolSplitWorksheetsfalseSimpan lembar kerja sebagai grup halaman terpisah.
boolShowEmptyWorkSheetsfalseSertakan lembar kerja kosong.
boolExportLandscapefalsePaksa ekspor lanskap.
boolExportOnePagePerSheetfalseSesuaikan setiap lembar kerja ke satu halaman output.
boolMemoryOptimizationPreferencetrueKurangi memori puncak, mungkin mengorbankan sedikit kecepatan.
boolAutoTrimWorksheetRenderRangetrueRender hanya rentang yang terlihat digunakan ketika tidak ada area cetak eksplisit.
boolAutoTrimPreserveExistingPrintAreatruePertahankan area cetak yang ditentukan buku kerja selama pemangkasan otomatis.
string?PrintAreanullRentang eksplisit seperti "A1:Z100".
boolPrintGridlinesfalseCetak garis kisi lembar kerja.
boolPrintHeadingsfalseCetak judul baris/kolom.
List<string>SheetNameskosongBatasi render ke lembar kerja bernama.
CustomStyleCell?CustomStylesnullPenimpaan format tanggal/desimal/integer opsional.
boolAllowSearchfalseMendelegasikan ke PdfConfig.AllowSearch.
boolAllowCopyfalseMendelegasikan ke PdfConfig.AllowCopy.

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

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

PptConfig

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

TipePropertiDefaultPerilaku
boolDefaultRendertrueRender slide asli; false menggunakan pengalihan PDF.
boolFastLoadfalseHindari merender slide pertama saat membuka; gunakan metadata dan render sesuai permintaan.
PdfConfigPdfConfiginstansi baruPengaturan untuk perilaku PDF/pencarian.
stringFontInfo""Informasi substitusi font.
string[]?FontFoldersnullDirektori font tambahan.
boolAllowSearchfalseMendelegasikan ke PdfConfig.AllowSearch.
boolAllowCopyfalseMendelegasikan ke PdfConfig.AllowCopy.

Pasang font yang digunakan presentasi pada server, atau arahkan FontFolders ke folder yang menyimpannya. Font yang hilang akan disubstitusi tanpa kesalahan apapun.

CadConfig

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

TipePropertiDefaultPerilaku
boolDefaultRendertrueRender CAD asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstansi baruPengaturan jalur PDF.
boolExportPdfAfalseOutput PDF/A arsip.
boolShowColortrueWarna bukan monokrom.
boolWhiteBackgroundtrueLatar belakang putih bukan hitam.
shortLineWidth25Lebar goresan CAD.
boolShowLayoutsfalseRender tab tata letak.
boolShowModeltrueRender ruang model.
boolCheck3DSolidtrueProses padatan 3D.
boolExportAllLayoutsfalseEkspor semua tata letak, mengganti pilihan model/tata letak.
boolLimitMinimumSizefalseTerapkan MinimumSize.
intMinimumSize700Ukuran output minimum dalam piksel.
boolLimitMaximumSizefalseTerapkan MaximumSize.
intMaximumSize700Ukuran output maksimum dalam piksel.
boolShowAllLayoutsDgnfalseSertakan semua tata letak DGN.
boolAutomaticLayoutScalingtrueSkala 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 Bawaan: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRender email asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstansi baruPengaturan jalur PDF.
Encoding?EmailEncodingnullTimpa pengkodean pesan.
Encoding?SubjectEncodingnullTimpa pengkodean subjek.
Encoding?BodyEncodingnullTimpa pengkodean isi.
boolSkipExternalImagesfalseJangan memuat gambar yang direferensikan secara remote. Disarankan untuk email yang tidak terpercaya.
boolRemoveLastWhitePagefalseHapus halaman kosong di akhir.
boolUseAntiAliasingfalseAktifkan anti-aliasing.
boolUseHighQualityRenderingfalseLebih suka rendering yang lebih bersih namun lebih lambat.
TimeSpan?TimeZoneOffsetnullTimpa zona waktu yang digunakan untuk tanggal.
boolForcePageSizefalsePaksa dimensi halaman tetap.

ImageConfig, TiffConfig, dan PsdConfig

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

KonfigurasiPropertiBawaanPerilaku
ImageConfigMaxImagePixelSize3000Lebar/tinggi maksimum. 0 berarti tidak terbatas; nilai bukan nol di bawah 50 diabaikan.
ImageConfigTransparentPngtruePertahankan transparansi PNG; false menggunakan latar belakang putih.
TiffConfigtidak ada properti tambahanDPI 200Hanya menggunakan BaseConfig; mendukung TIFF multi-halaman.
PsdConfigMaxImagePixelSize3000Validasi 0/minimum-50 yang sama seperti ImageConfig; DPI bawaan adalah 100.

DicomConfig

Format: DCM, IMA. DPI efektif bawaan: 100. Membutuhkan plugin DICOM. Pada paket ini file DICOM dirender sepenuhnya, tetapi metadata teknis tidak tersedia — lihat DICOM Plugin.

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 mengulang selamanya; nilai positif berhenti setelah jumlah tersebut.
DicomDisplayModeDisplayModeAnimationAndFramesAnimationOnly, FramesOnly, atau gabungan ikhtisar plus frame statis.

TxtConfig

Format: TXT. DPI bawaan: 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 bawaan: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueGambar Gantt asli; false menggunakan jalur PDF berbasis teks.
PdfConfigPdfConfiginstansi 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 bawaan: 200.

TipePropertiBawaanPerilaku
boolDefaultRendertrueRender diagram asli; false menggunakan pengalihan PDF.
PdfConfigPdfConfiginstansi baruPengaturan jalur PDF.
boolExportPdfAtrueOutput PDF/A arsip.

HtmlConfig, EpubConfig, MhtConfig, dan XpsConfig

Keempatnya secara default menggunakan DPI 200 dan mengekspos PdfConfig bersarang.

KonfigurasiFormatDefaultRenderProperti tambahan/perilaku
HtmlConfigHTML, HTMtrueRender asli; gunakan false untuk jalur pencarian PDF berbasis teks.
EpubConfigEPUBtrueRender asli; false menggunakan PDF.
MhtConfigMHT, MHTMLtrue pada kelas; false dalam katalog otomatisPembukaan normal tanpa konfigurasi menggunakan pengalihan PDF yang dapat dicari. Instance default yang dibangun secara eksplisit merender secara asli.
XpsConfigXPSfalseSecara default menggunakan jalur PDF; atur true untuk rendering gambar asli.

Contoh konfigurasi berdasarkan keluarga

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
    }
};

Pemilihan per ekstensi

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 → pengalihan PDF → pencarian teks asli pixel-accurate
    ".HTML" or ".HTM" => new HtmlConfig { DefaultRender = false },
    ".EML" or ".EMLX" or ".MSG" => new EmailConfig { DefaultRender = false },
    _ => null // kembali ke konfigurasi default format
};

Apakah halaman ini membantu?