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.
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
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
int | ImageResolution | 0 | 0 menggunakan default format. Rentang eksplisit yang valid adalah 25-300 DPI; penetapan yang tidak valid diabaikan. |
string | DocumentCulture | "" | Lokal untuk tanggal dan angka. Nilai yang tidak kosong dipangkas; penetapan kosong diabaikan. |
string | Password | "" | Kata sandi dokumen yang dilindungi. DocOptions.Password disalin ke sini secara otomatis. |
bool | ShowUI | true | Properti kompatibilitas; renderer saat ini tidak menggunakannya untuk mengontrol bilah alat browser. |
bool | CachePages | true | Menyimpan cache gambar halaman yang dirender untuk sesi dokumen. |
PdfConfig
Format: PDF. DPI default: 200.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Saklar kompatibilitas. Pabrik saat ini menggunakan penampil PDF asli. |
bool | AllowSearch | false | Membuat/menggunakan indeks pencarian teks PDF. Membutuhkan kemampuan lisensi Search untuk permintaan. |
bool | AllowCopy | false | Mengizinkan operasi pemilihan/penyalinan teks. |
bool | ExtractHyperlinks | false | Mengekstrak persegi panjang tautan untuk overlay klien. |
int | HyperlinksPageCount | 0 | Jumlah maksimum halaman yang dipindai untuk tautan; 0 berarti semua halaman. |
bool | CompressImages | false | Mengompres gambar tersemat sebelum rendering. |
int | CompressQuality | 100 | Kualitas JPEG yang digunakan saat kompresi diaktifkan. |
bool | ResizeImages | false | Mengubah ukuran gambar tersemat sebelum rendering. |
int | ResizeResolution | 300 | DPI target untuk gambar yang diubah ukurannya. |
bool | CompressFast | false | Memilih jalur kompresi yang lebih cepat namun kualitas lebih rendah. |
bool | FixInvalidImages | false | Mencoba memperbaiki gambar tersemat yang tidak valid. |
bool | SplitSegments | false | Menggabungkan 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.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Rendering Word asli; false menggunakan pengalihan PDF. |
PdfConfig | PdfConfig | instance baru | Pengaturan yang digunakan oleh jalur PDF/pencarian. |
DocPaperSize | PaperSize | A4 | Ukuran kertas output. Gunakan Custom dengan lebar/tinggi. |
int | PaperWidth | 595 | Lebar khusus dalam poin. |
int | PaperHeight | 841 | Tinggi khusus dalam poin. |
bool | RemovePaperMargin | false | Menghapus margin halaman dokumen. |
bool | RenderPageColor | true | Mempertahankan warna halaman yang dikonfigurasi di Word; false merender halaman putih. |
bool | ExportPdfA | false | Menggunakan PDF/A arsip pada jalur PDF. |
Encoding? | FileEncoding | null | Menimpa enkoding sumber. |
string | FontInfo | "" | Informasi substitusi font. |
string[]? | FontFolders | null | Direktori font tambahan, terutama berguna di Linux/kontainer. |
bool | AllowSearch | false | Mendelegasikan ke PdfConfig.AllowSearch. |
bool | AllowCopy | false | Mendelegasikan ke PdfConfig.AllowCopy. |
TableAutoFitBehavior | AutoFitAllTables | None | None, AutoFitToContents, atau AutoFitToWindow. |
ExcelConfig
Format: XLS, XLSX, XLSM, XLSB, XLTX, XLTM, ODS, CSV. DPI default: 200.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Rendering lembar asli; false menggunakan pengalihan PDF. |
PdfConfig | PdfConfig | instance baru | Pengaturan untuk jalur PDF/pencarian. |
ExcelPaperSize | PaperSize | PaperA4 | Ukuran kertas output. |
double | PaperMargins | 0.25 | Margin halaman dalam inci. |
bool | PaperLandscape | true | Rendering lembar lanskap. |
bool | AutoFitContents | false | Menyesuaikan otomatis tinggi baris dan lebar kolom. |
bool | RemoveEmptyContent | true | Memperketat output dengan mengecualikan konten kosong. |
bool | CalculateFormula | true | Menghitung ulang rumus sebelum rendering. |
bool | ShowRowColumnHeaders | true | Menyertakan header spreadsheet. |
bool | ExportPdfA | false | Menggunakan PDF/A pada jalur PDF. |
bool | SplitWorksheets | false | Menjaga lembar kerja sebagai grup halaman terpisah. |
bool | ShowEmptyWorkSheets | false | Menyertakan lembar kerja kosong. |
bool | ExportLandscape | false | Memaksa ekspor lanskap. |
bool | ExportOnePagePerSheet | false | Menyesuaikan setiap lembar kerja ke satu halaman output. |
bool | MemoryOptimizationPreference | true | Mengurangi memori puncak, mungkin mengorbankan sedikit kecepatan. |
bool | AutoTrimWorksheetRenderRange | true | Merender hanya rentang yang terlihat digunakan ketika tidak ada area cetak eksplisit. |
bool | AutoTrimPreserveExistingPrintArea | true | Mempertahankan area cetak yang didefinisikan workbook selama auto-trim. |
string? | PrintArea | null | Rentang eksplisit seperti "A1:Z100". |
bool | PrintGridlines | false | Mencetak garis kisi lembar kerja. |
bool | PrintHeadings | false | Mencetak heading baris/kolom. |
List<string> | SheetNames | kosong | Membatasi rendering ke lembar kerja yang bernama. |
CustomStyleCell? | CustomStyles | null | Penimpaan format tanggal/desimal/integer opsional. |
bool | AllowSearch | false | Mendelegasikan ke PdfConfig.AllowSearch. |
bool | AllowCopy | false | Mendelegasikan 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.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Rendering slide asli; false menggunakan pengalihan PDF. |
bool | FastLoad | false | Menghindari rendering slide pertama saat membuka; gunakan metadata dan render sesuai permintaan. |
PdfConfig | PdfConfig | instance baru | Pengaturan untuk perilaku PDF/pencarian. |
string | FontInfo | "" | Informasi substitusi font. |
string[]? | FontFolders | null | Direktori font tambahan. |
bool | AllowSearch | false | Mendelegasikan ke PdfConfig.AllowSearch. |
bool | AllowCopy | false | Mendelegasikan 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.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Rendering CAD asli; false menggunakan pengalihan PDF. |
PdfConfig | PdfConfig | instance baru | Pengaturan jalur PDF. |
bool | ExportPdfA | false | Output PDF/A arsip. |
bool | ShowColor | true | Warna bukan monokrom. |
bool | WhiteBackground | true | Latar putih bukan hitam. |
short | LineWidth | 25 | Lebar goresan CAD. |
bool | ShowLayouts | false | Merender tab tata letak. |
bool | ShowModel | true | Merender ruang model. |
bool | Check3DSolid | true | Memproses solid 3D. |
bool | ExportAllLayouts | false | Mengekspor semua tata letak, menimpa pemilihan model/tata letak. |
bool | LimitMinimumSize | false | Menerapkan MinimumSize. |
int | MinimumSize | 700 | Ukuran output minimum dalam piksel. |
bool | LimitMaximumSize | false | Menerapkan MaximumSize. |
int | MaximumSize | 700 | Ukuran output maksimum dalam piksel. |
bool | ShowAllLayoutsDgn | false | Menyertakan semua tata letak DGN. |
bool | AutomaticLayoutScaling | true | Menskalakan tata letak secara otomatis. |
float | PdfMargins | 0.5 | Margin PDF dalam inci. |
RenderQuality | QualityImage | Low | Kualitas raster: Low, Medium, atau High. |
RenderQuality | QualityText | Medium | Kualitas teks: Low, Medium, atau High. |
EmailConfig
Format: EML, EMLX, MSG. DPI default: 200.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Rendering email asli; false menggunakan pengalihan PDF. |
PdfConfig | PdfConfig | instance baru | Pengaturan jalur PDF. |
Encoding? | EmailEncoding | null | Menimpa enkoding pesan. |
Encoding? | SubjectEncoding | null | Menimpa enkoding subjek. |
Encoding? | BodyEncoding | null | Menimpa enkoding isi. |
bool | SkipExternalImages | false | Tidak memuat gambar yang direferensikan secara remote. Disarankan untuk email yang tidak dipercaya. |
bool | RemoveLastWhitePage | false | Menghapus halaman putih terakhir. |
bool | UseAntiAliasing | false | Mengaktifkan anti-aliasing. |
bool | UseHighQualityRendering | false | Memilih rendering yang lebih bersih namun lebih lambat. |
TimeSpan? | TimeZoneOffset | null | Menimpa zona waktu yang digunakan untuk tanggal. |
bool | ForcePageSize | false | Memaksa 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.
| Konfig | Properti | Bawaan | Perilaku |
|---|---|---|---|
ImageConfig | MaxImagePixelSize | 3000 | Lebar/tinggi maksimum. 0 berarti tak terbatas; nilai nonzero di bawah 50 diabaikan. |
ImageConfig | TransparentPng | true | Mempertahankan transparansi PNG; false menggunakan latar putih. |
TiffConfig | tidak ada properti tambahan | DPI 200 | Hanya menggunakan BaseConfig; mendukung TIFF multi-halaman. |
PsdConfig | MaxImagePixelSize | 3000 | Validasi 0/minimum-50 yang sama seperti ImageConfig; DPI default adalah 100. |
DicomConfig
Format: DCM, IMA. DPI efektif default: 100. Membutuhkan plugin DICOM.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
int | HorizontalResolution | 100 efektif | DPI horizontal eksplisit; jika tidak ImageResolution, kemudian 100. |
int | VerticalResolution | 100 efektif | DPI vertikal eksplisit; jika tidak ImageResolution, kemudian 100. |
int | AnimationFrameDelayMs | 100 | Penundaan animasi multi-frame; timing GIF menggunakan satuan 10 ms. |
ushort | LoopCount | 0 | 0 loop selamanya; nilai positif berhenti setelah jumlah tersebut. |
DicomDisplayMode | DisplayMode | AnimationAndFrames | AnimationOnly, FramesOnly, atau ikhtisar gabungan plus frame statis. |
TxtConfig
Format: TXT. DPI default: 200.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
DocPaperSize | PaperSize | A4 | Ukuran kertas output. |
Encoding? | FileEncoding | null | null menggunakan UTF-8. |
string | FontInformation | "" | 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.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Gambar Gantt asli; false menggunakan jalur PDF berbasis teks. |
PdfConfig | PdfConfig | instance baru | Pengaturan jalur PDF. |
bool | ExportPdfA | true | Output PDF/A arsip. |
MppPaperSize | PaperSize | Ledger | Ukuran kertas output proyek. |
MppTimeScale | TimeScale | Months | Days atau Months. |
MppFormat | PresentationFormat | GanttChart | GanttChart, 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.
| Tipe | Properti | Bawaan | Perilaku |
|---|---|---|---|
bool | DefaultRender | true | Rendering diagram asli; false menggunakan pengalihan PDF. |
PdfConfig | PdfConfig | instance baru | Pengaturan jalur PDF. |
bool | ExportPdfA | true | Output PDF/A arsip. |
HtmlConfig, EpubConfig, MhtConfig, and XpsConfig
Keempatnya default ke DPI 200 dan mengekspos PdfConfig bersarang.
| Konfig | Format | DefaultRender | Properti/perilaku tambahan |
|---|---|---|---|
HtmlConfig | HTML, HTM | true | Rendering asli; gunakan false untuk jalur pencarian PDF berbasis teks. |
EpubConfig | EPUB | true | Rendering asli; false menggunakan PDF. |
MhtConfig | MHT, MHTML | true pada kelas; false di katalog otomatis | Pembukaan normal tanpa konfigurasi menggunakan pengalihan PDF yang dapat dicari. Instance default yang dibangun secara eksplisit merender secara native. |
XpsConfig | XPS | false | Menggunakan jalur PDF secara default; set true untuk rendering gambar native. |
Configuration examples by family
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
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?