Documentize Namespace

Kelas

Nama KelasDeskripsi
ChatCompletionMewakili respons penyelesaian obrolan yang dikembalikan oleh model, berdasarkan masukan yang diberikan.
ChatGptConstsKelas ini mewakili penyimpanan untuk konstanta.
ChatGptRequestOptionsMewakili opsi untuk plugin Documentize.PdfManager.
ChoicePilihan penyelesaian obrolan.
CompressOptionsMewakili opsi Kompres untuk komponen Documentize.PdfManager.
DecryptOptionsMewakili Opsi Dekripsi untuk plugin Documentize.PdfSecurity.
DirectoryDataMewakili data direktori untuk operasi memuat dan menyimpan.
DocConverterMewakili plugin Documentize.DocConverter. Digunakan untuk mengonversi dokumen PDF ke format DOC/DOCX.
EncryptOptionsMewakili Opsi Enkripsi untuk plugin Documentize.PdfSecurity.
ExtractFormDataToDsvOptionsMewakili opsi untuk mengekspor nilai bidang bagi komponen Documentize.PdfForm dan Documentize.PdfExtractor.
ExtractImagesOptionsMewakili opsi ekstraksi gambar untuk komponen Documentize.PdfExtractor.
ExtractPropertiesOptionsMewakili Opsi Ekstraksi Properti PDF untuk komponen Documentize.PdfExtractor.
ExtractTextOptionsMewakili opsi Ekstraksi Teks untuk komponen Documentize.PdfExtractor.
FileDataMewakili data file untuk operasi memuat dan menyimpan.
FileResultMewakili hasil operasi dalam bentuk string jalur ke file.
FlattenFieldsOptionsMewakili opsi untuk Meratakan Bidang dalam dokumen oleh komponen Documentize.PdfForm.
GetFieldNamesOptionsMewakili opsi untuk Mendapatkan Nama Bidang dalam dokumen oleh komponen Documentize.PdfForm.
HtmlConverterMewakili plugin Documentize.HtmlConverter. Digunakan untuk mengonversi dokumen PDF ke format HTML dan dokumen HTML ke format PDF.
HtmlToPdfOptionsMewakili opsi konverter HTML ke PDF untuk plugin Documentize.PdfConverter.
InfoKelas ini menyediakan informasi tentang build produk saat ini.
JpegConverterMewakili plugin Documentize.JpegConverter. Digunakan untuk mengonversi dokumen PDF ke format JPEG.
LicenseMenyediakan metode untuk mengatur Lisensi.
MergeOptionsMewakili opsi Penggabungan untuk plugin Documentize.PdfManager.
MergerMewakili plugin Documentize.Merger. Digunakan untuk menggabungkan beberapa dokumen PDF menjadi satu PDF.
MessagePesan penyelesaian obrolan yang dihasilkan oleh model.
ObjectResultMewakili hasil operasi dalam bentuk string.
OptimizeOptionsMewakili opsi Optimasi untuk plugin Documentize.PdfManager.
OptimizerMewakili plugin Documentize.Optimizer. Digunakan untuk mengoptimasi, memutar, mengubah ukuran, dan mengompres dokumen PDF.
OptionsWithInputMewakili Opsi dasar untuk operasi dengan 1 Data Masukan.
OptionsWithInputAndOutputMewakili Opsi dasar untuk operasi dengan 1 Data Masukan dan 1 Data Keluaran.
PageInfoMewakili informasi halaman.
PageSizeKelas yang mewakili ukuran halaman dalam dokumen PDF.
PdfAConverterMewakili plugin untuk menangani konversi dokumen PDF ke format PDF/A dan untuk validasi kepatuhan PDF/A.
PdfAOptionsBaseMewakili kelas dasar untuk opsi plugin Documentize.PdfAConverter. Kelas ini menyediakan properti dan metode untuk mengkonfigurasi proses konversi dan validasi PDF/A.
PdfAValidateOptionsMewakili opsi untuk memvalidasi kepatuhan PDF/A dokumen PDF dengan plugin Documentize.PdfConverter.
PdfAValidationResultMewakili hasil proses validasi PDF/A.
PdfChatGptMewakili plugin PdfChatGpt.
PdfConverterMewakili komponen Documentize.PdfConverter. Digunakan untuk mengonversi dokumen PDF ke format lain seperti DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Juga memungkinkan Anda melakukan Validasi PDF/A dan Mengonversi HTML ke PDF.
PdfExtractorMewakili komponen Documentize.PdfExtractor. Digunakan untuk mengekstrak Teks, Gambar, Data Formulir, Properti (Meta Data) dari dokumen PDF.
PdfFormMewakili komponen Documentize.PdfForm. Digunakan untuk Meratakan, Mengekstrak Data Formulir. Juga memungkinkan Anda Mendapatkan Nama Bidang.
PdfManagerMewakili komponen Documentize.PdfManager. Digunakan untuk Menggabungkan, Membagi, Mengoptimasi, Memutar, Mengubah ukuran, Mengompres dokumen PDF serta Menambahkan Tabel, Menambahkan Daftar Isi ke dokumen PDF. Dapat Menggabungkan beberapa dokumen PDF menjadi satu PDF. Dapat Membagi dokumen PDF menjadi halaman terpisah. Dapat Mengoptimasi, Memutar, Mengubah ukuran, Mengompres dokumen PDF. Dapat Memutar, Mengubah ukuran Halaman dokumen PDF. Dapat Menambahkan Tabel ke dokumen PDF. Dapat Menambahkan Daftar Isi ke dokumen PDF.
PdfPropertiesMewakili Properti dan informasi meta dari dokumen PDF.
PdfSecurityMewakili komponen Documentize.PdfSecurity. Digunakan untuk Mengenkripsi, Mendekripsi, Menandatangani, dan Menyaring dokumen PDF.
PdfToDocOptionsMewakili opsi konverter PDF ke DOC untuk plugin Documentize.PdfConverter.
PdfToHtmlOptionsMewakili opsi konverter PDF ke HTML untuk plugin Documentize.PdfConverter.
PdfToJpegOptionsMewakili opsi konverter PDF ke JPEG untuk plugin Documentize.PdfConverter.
PdfToPdfAOptionsMewakili opsi untuk mengonversi dokumen PDF ke format PDF/A dengan plugin Documentize.PdfConverter.
PdfToPngOptionsMewakili opsi konverter PDF ke PNG untuk plugin Documentize.PdfConverter.
PdfToTiffOptionsMewakili opsi konverter PDF ke TIFF untuk plugin Documentize.PdfConverter.
PdfToXlsOptionsMewakili opsi konverter PDF ke XLS/XLSX untuk plugin Documentize.PdfConverter.
PluginBaseOptionsMewakili opsi dasar untuk komponen.
PngConverterMewakili plugin Documentize.PngConverter. Digunakan untuk mengonversi dokumen PDF ke format PNG.
RectangleKelas yang mewakili persegi panjang.
RemoveFieldsOptionsMewakili opsi untuk Menghapus Bidang dalam dokumen oleh plugin Documentize.PdfForm.
ResizeOptionsMewakili opsi Mengubah Ukuran untuk plugin Documentize.PdfManager.
ResultContainerMewakili kontainer yang berisi kumpulan hasil pemrosesan plugin.
RotateOptionsMewakili opsi Memutar untuk plugin Documentize.PdfManager.
SanitizeOptionsMewakili opsi konfigurasi untuk membersihkan data tersembunyi dalam dokumen.
SecurityMewakili plugin Documentize.Security. Digunakan untuk mengenkripsi dan mendekripsi dokumen PDF.
SignOptionsMewakili Opsi Tanda Tangan untuk komponen Documentize.PdfSecurity.
SplitOptionsMewakili opsi Membagi untuk plugin Documentize.PdfManager.
SplitterMewakili plugin Documentize.Splitter. Digunakan untuk Membagi dokumen PDF menjadi halaman terpisah.
StreamDataMewakili data aliran untuk operasi memuat dan menyimpan.
StreamResultMewakili hasil operasi dalam bentuk Stream.
StringResultMewakili hasil operasi dalam bentuk string.
TableBuilderKelas yang mewakili pembuat tabel pada halaman PDF.
TableCellBuilderKelas yang mewakili pembuat sel tabel.
TableGeneratorMewakili plugin Documentize.TableGenerator. Digunakan untuk menambahkan tabel ke dokumen PDF.
TableOptionsMewakili opsi untuk menambahkan tabel ke dokumen oleh plugin Documentize.PdfManager.
TableRowBuilderKelas yang mewakili pembuat baris tabel.
TiffConverterMewakili plugin Documentize.TiffConverter. Digunakan untuk mengonversi dokumen PDF ke format TIFF.
TimestampOptions
TocGeneratorMewakili plugin Documentize.TocGenerator. Digunakan untuk menambahkan Daftar Isi ke dokumen PDF.
TocHeadingMewakili opsi untuk Heading atau Judul Daftar Isi pada dokumen oleh plugin Documentize.PdfManager.
TocOptionsMewakili opsi untuk menambahkan Daftar Isi ke dokumen oleh plugin Documentize.PdfManager.
UsageStatistik penggunaan untuk permintaan penyelesaian.
XlsConverterMewakili plugin Documentize.XlsConverter. Digunakan untuk mengonversi dokumen PDF ke format XLSX/XLS/CSV/XLSM/ODS.

Antarmuka

Nama AntarmukaDeskripsi
IDataAntarmuka data umum yang mendefinisikan anggota umum yang harus diimplementasikan oleh data konkret.
IHaveInputAntarmuka data umum yang mendefinisikan Data Masukan yang harus diimplementasikan oleh Opsi.
IOperationResultAntarmuka hasil operasi umum yang mendefinisikan metode umum yang harus diimplementasikan oleh hasil operasi komponen konkret.
IPluginOptionsAntarmuka opsi komponen umum yang mendefinisikan metode umum yang harus diimplementasikan oleh opsi komponen konkret.

Enum

Nama EnumDeskripsi
ConvertErrorActionKelas ini mewakili aksi untuk kesalahan konversi.
ConvertSoftMaskActionAksi ini mewakili tindakan untuk konversi gambar dengan soft mask.
DataTypeMewakili tipe data yang mungkin untuk pemrosesan komponen.
DocConversionModeMendefinisikan mode konversi dokumen keluaran.
PdfToXlsOptions.ExcelFormatMengizinkan untuk menentukan format file xls/xlsx/xml/csv. Nilai default adalah XLSX.
HtmlMediaTypeMenentukan tipe media yang mungkin digunakan selama render.
HtmlPageLayoutOptionMenentukan flag yang bersama dengan opsi lain menentukan ukuran dan tata letak halaman.
PdfAStandardVersionMenentukan versi standar PDF/A untuk dokumen PDF.
RolePeran penulis pesan.
RotationEnumerasi nilai rotasi yang mungkin.
PdfToHtmlOptions.SaveDataTypeMenentukan tipe keluaran file HTML.
TextFormattingModeMendefinisikan mode berbeda yang dapat digunakan saat mengonversi dokumen PDF menjadi teks. Lihat kelas Documentize.ExtractTextOptions.
TiffColorDepthDigunakan untuk menentukan Kedalaman Warna untuk Documentize.PdfToTiffOptions.
TiffCompressionDigunakan untuk menentukan tipe Kompresi untuk Documentize.PdfToTiffOptions.

Subbagian Documentize Namespace

Class AddTimestampOptions

Info

Mewakili Opsi Penambahan Tanda Waktu untuk plugin Documentize.Timestamp.

[Obsolete("The class will be deleted soon. Please use SignOptions class.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsAddTimestampOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

AddTimestampOptions(Stream, string, string, string)

Menginisialisasi sebuah instance baru dari objek Documentize.AddTimestampOptions dengan opsi default.

public AddTimestampOptions(Stream pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Parameter

  • pfx Stream: Jalur ke file pfx.
  • password string: Password ke file pfx.
  • serverUrl string: URL server timestamp.
  • serverBasicAuthCredentials string: Kredensial otentikasi dasar, nama pengguna dan kata sandi digabungkan menjadi string “username:password”. (Opsional).

AddTimestampOptions(string, string, string, string)

Menginisialisasi sebuah instance baru dari objek Documentize.AddTimestampOptions dengan opsi default.

public AddTimestampOptions(string pfx, string password, string serverUrl, string serverBasicAuthCredentials = "")

Parameter

  • pfx string: Jalur ke file pfx.
  • password string: Password ke file pfx.
  • serverUrl string: URL server timestamp.
  • serverBasicAuthCredentials string: Kredensial otentikasi dasar, nama pengguna dan kata sandi digabungkan menjadi string “username:password”. (Opsional).

Namespace: Documentize Assembly: Documentize.dll

Class ChatCompletion

Info

Mewakili respons penyelesaian obrolan yang dikembalikan oleh model, berdasarkan input yang diberikan.

public class ChatCompletion
{
}

Pewarisan

objectChatCompletion

Anggota yang Diwarisi

Konstruktor

ChatCompletion()

public ChatCompletion()
{
}

Properti

Choices

Daftar pilihan penyelesaian obrolan. Bisa lebih dari satu jika n lebih besar dari 1.

[JsonProperty("choices")]
public List<Choice> Choices { get; set; }

Nilai Properti

List<Choice>

Created

Stempel waktu Unix (dalam detik) saat penyelesaian obrolan dibuat.

[JsonProperty("created")]
public long Created { get; set; }

Nilai Properti

long

Id

Pengidentifikasi unik untuk penyelesaian obrolan.

[JsonProperty("id")]
public string Id { get; set; }

Nilai Properti

string

Model

Model yang digunakan untuk penyelesaian obrolan.

[JsonProperty("model")]
public string Model { get; set; }

Nilai Properti

string

Object

Tipe objek, yang selalu chat.completion.

[JsonProperty("object")]
public string Object { get; set; }

Nilai Properti

string

SystemFingerprint

Sidik jari ini mewakili konfigurasi backend tempat model dijalankan.

[JsonProperty("system_fingerprint")]
public string SystemFingerprint { get; set; }

Nilai Properti

string

Usage

Statistik penggunaan untuk permintaan penyelesaian.

[JsonProperty("usage")]
public Usage Usage { get; set; }

Nilai Properti

Usage

Namespace: Documentize
Assembly: Documentize.dll

Class ChatGptConsts

Info

Kelas ini mewakili penyimpanan untuk konstanta.

public static class ChatGptConsts

Inheritance

objectChatGptConsts

Inherited Members

Fields

ApiUrl

public static string ApiUrl

Field Value

string

ModelName

public static string ModelName

Field Value

string

SystemRole

public static string SystemRole

Field Value

string

SystemRoleDescription

public static string SystemRoleDescription

Field Value

string

UserRole

public static string UserRole

Field Value

string

Ruang Nama: Documentize Assembly: Documentize.dll

Class ChatGptRequestOptions

Info

Mewakili opsi untuk plugin Documentize.PdfManager.

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsChatGptRequestOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

ChatGptRequestOptions()

Menginisialisasi instance baru dari objek Documentize.ChatGptRequestOptions dengan opsi default.

public ChatGptRequestOptions()

ChatGptRequestOptions(string, string, string, string)

Menginisialisasi instance baru dari objek Documentize.ChatGptRequestOptions dengan opsi.

public ChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Parameter

Properti

ApiKey

Mendapatkan atau mengatur kunci untuk mengakses API ChatGPT.

public string ApiKey { get; set; }

Nilai Properti

string

ApiUrl

Mendapatkan atau mengatur URL API ChatGPT.

public string ApiUrl { get; set; }

Nilai Properti

string

CancellationToken

Token pembatalan.

public CancellationToken CancellationToken { get; set; }

Nilai Properti

CancellationToken

MaxTokens

Jumlah maksimum token dalam respons. Nilai default adalah null, yang berarti tak terhingga.

public int? MaxTokens { get; set; }

Nilai Properti

int?

Messages

Mendapatkan atau mengatur koleksi objek Documentize.Message.

public List<message> Messages { get; set; }

Nilai Properti

List<Message>

Catatan

Saat menambahkan banyak pesan ke opsi, urutan dalam koleksi pesan adalah sebagai berikut:

  • Pesan pertama (jika ada) berasal dari options.Query, didahului oleh pesan dengan konten: “You are a helpful assistant.”, dan perannya adalah “system”.
  • Kemudian (jika ada) pesan‑pesan dari koleksi options.Messages ditambahkan.
  • Pesan dari sumber berkas (jika ada) ditambahkan terakhir, satu objek pesan untuk setiap dokumen dengan peran “user”. Jika tidak ada satu pun pesan yang disediakan, ArgumentException akan dilemparkan.

Model

Mengatur atau mendapatkan ID model yang akan digunakan.

public string Model { get; set; }

Nilai Properti

string

NumberOfChoices

Berapa banyak pilihan penyelesaian chat yang dihasilkan untuk setiap pesan masuk.

public int NumberOfChoices { get; set; }

Nilai Properti

int

Query

Mendapatkan atau mengatur permintaan string ke ChatGPT. Jika tidak kosong, ini adalah pesan pertama dalam koleksi yang akan dikirim dalam permintaan.

public string Query { get; set; }

Nilai Properti

string

Temperature

Temperatur sampling yang digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0.8 akan membuat hasil lebih acak, sedangkan nilai yang lebih rendah seperti 0.2 akan membuatnya lebih terfokus dan deterministik. Nilai default adalah 1.

public double Temperature { get; set; }

Nilai Properti

double

Namespace: Documentize Assembly: Documentize.dll

Class Choice

Info

Pilihan penyelesaian obrolan.

public class Choice

Pewarisan

objectChoice

Anggota yang Diwarisi

Konstruktor

Choice()

public Choice()

Properti

FinishReason

Alasan mengapa model menghentikan pembuatan token.
Ini akan berhenti jika model mencapai titik henti alami atau urutan henti yang diberikan, atau panjang jika jumlah maksimum token yang ditentukan dalam permintaan telah tercapai.

[JsonProperty("finish_reason")]
public string FinishReason { get; set; }

Nilai Properti

string

Index

Indeks pilihan dalam daftar pilihan.

[JsonProperty("index")]
public int Index { get; set; }

Nilai Properti

int

Message

Pesan penyelesaian obrolan yang dihasilkan oleh model.

[JsonProperty("message")]
public Message Message { get; set; }

Nilai Properti

Message

Ruang Nama: Documentize
Rakitan: Documentize.dll

Class CompressOptions

Info

Mewakili opsi kompresi untuk komponen Documentize.PdfManager.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsCompressOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

CompressOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.CompressOptions dengan opsi default.

public CompressOptions()

Namespace: Documentize
Assembly: Documentize.dll

Class DecryptionOptions

Info

Mewakili Opsi Dekripsi untuk plugin Documentize.Security.

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsDecryptionOptions

Mengimplementasikan

Anggota yang Dwarisi

Konstruktur

DecryptionOptions(string)

Menginisialisasi instansi baru dari objek Documentize.DecryptionOptions dengan opsi default.

public DecryptionOptions(string ownerPassword)

Parameter

  • ownerPassword string: Kata sandi pemilik.

Properti

OwnerPassword

Kata sandi pemilik.

public string OwnerPassword { get; set; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class DecryptOptions

Info

Mewakili Opsi Dekripsi untuk plugin Documentize.PdfSecurity.

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsDecryptOptions

Implements

Inherited Members

Constructors

DecryptOptions(string)

Menginisialisasi sebuah instance baru dari objek Documentize.DecryptOptions dengan opsi default.

public DecryptOptions(string ownerPassword)

Parameters

  • ownerPassword string: Kata sandi pemilik.

Properties

OwnerPassword

Kata sandi pemilik.

public string OwnerPassword { get; set; }

Property Value

string

Namespace: Documentize Assembly: Documentize.dll

Class DirectoryData

Info

Mewakili data direktori untuk operasi memuat dan menyimpan.

public sealed class DirectoryData : IData

Inheritance

objectDirectoryData

Implements

Inherited Members

Constructors

DirectoryData(string)

Menginisialisasi data direktori baru dengan jalur yang ditentukan.

public DirectoryData(string path)

Parameters

  • path string: Sebuah string yang mewakili jalur ke direktori.

Properties

DataType

Jenis sumber data.

public DataType DataType { get; }

Property Value

DataType

Path

Mendapatkan jalur ke direktori data saat ini.

public string Path { get; }

Property Value

string

Namespace: Documentize
Assembly: Documentize.dll

Class DirectoryDataSource

Info

Mewakili data direktori untuk operasi muat dan simpan dari plugin.

public sealed class DirectoryDataSource : IDataSource

Pewarisan

objectDirectoryDataSource

Mengimplementasikan

Anggota yang Dwarisi

Konstruktor

DirectoryDataSource(string)

Menginisialisasi data direktori baru dengan jalur yang ditentukan.

public DirectoryDataSource(string path)

Parameter

  • path string: Sebuah string yang mewakili jalur ke direktori.

Properti

DataType

Tipe sumber data.

public DataType DataType { get; }

Nilai Properti

DataType

Path

Mendapatkan jalur ke direktori dari data saat ini.

public string Path { get; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class DocConverter

Info

Mewakili plugin Documentize.DocConverter. Digunakan untuk mengonversi dokumen PDF ke format DOC/DOCX.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class DocConverter

Pewarisan

object
DocConverter

Anggota yang Diwariskan

Metode

Process(PdfToDocOptions)

Mengonversi dokumen PDF ke format DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Parameter

  • optionsPdfToDocOptions: Sebuah objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

Namespace: Documentize
Assembly: Documentize.dll

Class EncryptionOptions

Info

Mewakili Opsi Enkripsi untuk plugin Documentize.Security.

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsEncryptionOptions

Mengimplementasikan

Anggota yang Dwarisi

Konstruktor

EncryptionOptions(string, string)

Menginisialisasi instance baru dari objek Documentize.EncryptionOptions dengan opsi default.

public EncryptionOptions(string ownerPassword, string userPassword)

Parameter

  • ownerPassword string: Kata sandi pemilik.
  • userPassword string: Kata sandi pengguna.

Properti

OwnerPassword

Kata sandi pemilik.

public string OwnerPassword { get; set; }

Nilai Properti

string

UserPassword

Kata sandi pengguna.

public string UserPassword { get; set; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class EncryptOptions

Info

Mewakili Opsi Enkripsi untuk plugin Documentize.PdfSecurity.

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsEncryptOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

EncryptOptions(string, string)

Menginisialisasi instance baru dari objek Documentize.EncryptOptions dengan opsi default.

public EncryptOptions(string ownerPassword, string userPassword)

Parameter

  • ownerPassword string: Password pemilik.
  • userPassword string: Password pengguna.

Properti

OwnerPassword

Password pemilik.

public string OwnerPassword { get; set; }

Nilai Properti

string

UserPassword

Password pengguna.

public string UserPassword { get; set; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class ExtractFormDataToDsvOptions

Info

Mewakili opsi untuk mengekspor nilai bidang pada komponen Documentize.PdfForm dan Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsExtractFormDataToDsvOptions

Implements

Inherited Members

Constructors

ExtractFormDataToDsvOptions(char, bool)

Menginisialisasi instance baru dari objek Documentize.ExtractFormDataToDsvOptions.

public ExtractFormDataToDsvOptions(char delimiter = ',', bool addFieldNames = false)

Parameters

  • delimiter char: Menentukan pemisah yang digunakan dalam data yang diekspor antara nilai. Nilai default adalah ‘,’.
  • addFieldNames bool: Menambahkan nama bidang sebelum nilai. Format: Nama + pemisah + Nilai + pemisah.

Properties

AddFieldName

Menambahkan nama bidang sebelum nilai.
Format: Nama + pemisah + Nilai + pemisah.

public bool AddFieldName { get; set; }

Property Value

bool

Delimiter

Pemisah yang digunakan untuk nilai yang diekspor.

public char Delimiter { get; set; }

Property Value

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Info

Mewakili opsi ekstraksi gambar untuk komponen Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsExtractImagesOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

ExtractImagesOptions()

Menginisialisasi instance baru dari objek Documentize.ExtractImagesOptions dengan opsi default.

public ExtractImagesOptions()

Namespace: Documentize Assembly: Documentize.dll

Class ExtractPropertiesOptions

Info

Mewakili Opsi Ekstraksi Properti PDF untuk komponen Documentize.PdfExtractor.

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Pewarisan

objectOptionsWithInputExtractPropertiesOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

ExtractPropertiesOptions()

Menginisialisasi instance baru dari objek Documentize.ExtractPropertiesOptions dengan opsi default.

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

Menginisialisasi instance baru dari objek Documentize.ExtractPropertiesOptions dengan data masuk yang ditentukan.

public ExtractPropertiesOptions(IData inputData)

Parameter

  • inputData IData: Data masuk.

ExtractPropertiesOptions(string)

Menginisialisasi instance baru dari objek Documentize.ExtractPropertiesOptions dengan berkas masuk yang ditentukan.

public ExtractPropertiesOptions(string inputFile)

Parameter

  • inputFile string: Jalur berkas masuk.

ExtractPropertiesOptions(Stream)

Menginisialisasi instance baru dari objek Documentize.ExtractPropertiesOptions dengan aliran masuk yang ditentukan.

public ExtractPropertiesOptions(Stream inputStream)

Parameter

  • inputStream Stream: Aliran masuk.

Properti

Input

Mendapatkan atau menetapkan Data Masuk.

public override IData Input { get; set; }

Nilai Properti

IData

Ruang Nama: Documentize
Assemby: Documentize.dll

Class ExtractTextOptions

Info

Mewakili opsi ekstraksi teks untuk komponen Documentize.PdfExtractor.

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Inheritance

objectOptionsWithInputExtractTextOptions

Implements

Inherited Members

Constructors

ExtractTextOptions(TextFormattingMode)

Menginisialisasi instance baru dari objek Documentize.ExtractTextOptions untuk mode pemformatan teks yang ditentukan.

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

ExtractTextOptions(IData, TextFormattingMode)

Menginisialisasi instance baru dari objek Documentize.ExtractTextOptions dengan data yang ditentukan.

public ExtractTextOptions(IData data, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

ExtractTextOptions(string, TextFormattingMode)

Menginisialisasi instance baru dari objek Documentize.ExtractTextOptions dengan file yang ditentukan.

public ExtractTextOptions(string file, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

ExtractTextOptions(Stream, TextFormattingMode)

Menginisialisasi instance baru dari objek Documentize.ExtractTextOptions dengan aliran yang ditentukan.

public ExtractTextOptions(Stream stream, TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

Properties

FormattingMode

Mengambil atau mengatur mode pemformatan.

public TextFormattingMode FormattingMode { get; set; }

Property Value

TextFormattingMode

Input

Mengambil atau mengatur Data Input.

public override IData Input { get; set; }

Property Value

IData

Namespace: Documentize Assembly: Documentize.dll

Class FileData

Info

Mewakili data file untuk operasi memuat dan menyimpan.

public sealed class FileData : IData

Pewarisan

objectFileData

Mengimplementasikan

Anggota yang Dwariskan

Konstruktor

FileData(string)

Menginisialisasi sumber data file baru dengan path yang ditentukan.

public FileData(string path)

Parameter

  • path string: Sebuah string yang mewakili path ke file sumber.

Properti

DataType

Tipe sumber data.

public DataType DataType { get; }

Nilai Properti

DataType

Path

Mendapatkan path ke file data saat ini.

public string Path { get; }

Nilai Properti

string

Metode

ToString()

Mengonversi instance menjadi System.String.

public override string ToString()

Mengembalikan

string : Path ke file.

Namespace: Documentize Assembly: Documentize.dll

Class FileDataSource

Info

Mewakili data file untuk operasi memuat dan menyimpan dari sebuah plugin.

public sealed class FileDataSource : IDataSource

Pewarisan

objectFileDataSource

Mengimplementasikan

Anggota yang Dwarisi

Konstruktor

FileDataSource(string)

Menginisialisasi sumber data file baru dengan jalur yang ditentukan.

public FileDataSource(string path)

Parameter

  • path string: Sebuah string yang mewakili jalur ke file sumber.

Properti

DataType

Tipe sumber data.

public DataType DataType { get; }

Nilai Properti

DataType

Path

Mendapatkan jalur ke file data saat ini.

public string Path { get; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class FileResult

Info

Mewakili hasil operasi dalam bentuk jalur string ke file.

public sealed class FileResult : IOperationResult

Inheritance

objectFileResult

Implements

Inherited Members

Properties

Data

Mendapatkan data mentah.

public object Data { get; }

Property Value

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file output.

public bool IsFile { get; }

Property Value

bool

IsStream

Menunjukkan apakah hasilnya adalah aliran keluaran.

public bool IsStream { get; }

Property Value

bool

IsString

Menunjukkan apakah hasilnya adalah string teks.

public bool IsString { get; }

Property Value

bool

Methods

ToFile()

Mencoba mengonversi hasil menjadi file.

public string ToFile()

Returns

string : String yang mewakili jalur ke file output jika hasilnya berupa file; jika tidak null.

ToStream()

Mencoba mengonversi hasil menjadi objek aliran.

public Stream ToStream()

Returns

Stream : Objek aliran yang mewakili data keluaran jika hasilnya berupa aliran; jika tidak null.

Namespace: Documentize
Assembly: Documentize.dll

Class FlattenFieldsOptions

Info

Mewakili opsi untuk Flatten Fields dalam dokumen oleh komponen Documentize.PdfForm.

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsFlattenFieldsOptions

Mengimplementasikan

Anggota yang Diturunkan

Konstruktor

FlattenFieldsOptions()

Menginisialisasi instance baru dari objek Documentize.FlattenFieldsOptions dengan opsi default.

public FlattenFieldsOptions()

Properti

SkipFields

Daftar bidang yang tidak akan di‑Flatten.

public List<string> SkipFields { get; set; }

Nilai Properti

List<string>

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

Info

Mewakili plugin Documentize.FormExporter. Digunakan untuk mengekspor nilai Formulir dokumen PDF ke file DSV atau CSV.

[Obsolete("The class will be deleted soon. Please use PdfExtractor or PdfForm class.")]
public static class FormExporter

Pewarisan

objectFormExporter

Anggota yang Diwarisi

Metode

Process(ExtractFormDataToDsvOptions)

Memulai pemrosesan Documentize.FormExporter dengan parameter yang ditentukan.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class FormExportToDsvOptions

Info

Mewakili opsi untuk mengekspor nilai-nilai bidang untuk plugin Documentize.FormExporter.

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsFormExportToDsvOptions

Mengimplementasikan

Anggota yang diwarisi

Konstruktor

FormExportToDsvOptions(char, bool)

Menginisialisasi instance baru dari objek Documentize.FormExportToDsvOptions.

public FormExportToDsvOptions(char delimeter = ',', bool addFieldNames = false)

Parameter

  • delimeter char: Menentukan pemisah yang akan digunakan dalam data yang diekspor antar nilai. Nilai default adalah ‘,’.
  • addFieldNames bool: Menambahkan nama bidang sebelum nilai. Format: Nama + pemisah + Nilai + pemisah.

Properti

AddFieldName

Menambahkan nama bidang sebelum nilai. Format: Nama + pemisah + Nilai + pemisah.

public bool AddFieldName { get; set; }

Nilai Properti

bool

Delimeter

Pemisah yang digunakan untuk nilai-nilai yang diekspor.

public char Delimeter { get; set; }

Nilai Properti

char

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattener

Info

Mewakili plugin Documentize.FormFlattener. Digunakan untuk Meratakan bidang dalam dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfForm class.")]
public static class FormFlattener

Pewarisan

objectFormFlattener

Anggota yang Diturunkan

Metode

GetFieldNames(string)

Mendapatkan Nama Bidang dalam Dokumen PDF.

public static List<string> GetFieldNames(string path)

Parameter

  • path string: Jalur ke Dokumen PDF.

Mengembalikan

List<string>

Daftar nama dalam Dokumen PDF.

GetFieldNames(Stream) : Mendapatkan Nama Bidang dalam Dokumen PDF.

public static List<string> GetFieldNames(Stream stream)

Parameter

  • stream Stream: Stream yang berisi Dokumen PDF.

Mengembalikan

List<string>

Daftar nama dalam Dokumen PDF.

Process(FlattenFieldsOptions) : Meratakan bidang formulir dalam dokumen PDF.

public static ResultContainer Process(FlattenFieldsOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class FormFlattenerOptions

Info

Mewakili opsi untuk Melipat Bidang dalam dokumen oleh plugin Documentize.FormFlattener.

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsFormFlattenerOptions

Mengimplementasikan

Anggota yang diwarisi

Konstruktor

FormFlattenerOptions()

Menginisialisasi instansi baru dari objek Documentize.FormFlattenerOptions dengan opsi default.

public FormFlattenerOptions()

Properti

SkipFields

Daftar bidang yang tidak akan Dilipat.

public List<string> SkipFields { get; set; }

Nilai Properti

List<string>

Namespace: Documentize Assembly: Documentize.dll

Class GetFieldNamesOptions

Info

Mewakili opsi untuk Get Field Names dalam dokumen oleh komponen Documentize.PdfForm.

public class GetFieldNamesOptions : OptionsWithInput, IHaveInput

Pewarisan

objectOptionsWithInputGetFieldNamesOptions

Menerapkan

Anggota yang Diwariskan

Konstruktor

GetFieldNamesOptions(string)

Konstruktor untuk opsi dengan Path input ke file.

public GetFieldNamesOptions(string path)

Parameter

  • path string: Path input ke file.

GetFieldNamesOptions(Stream)

Konstruktor untuk opsi dengan Stream input.

public GetFieldNamesOptions(Stream stream)

Parameter

Properti

Input

Mendapatkan atau mengatur Data Input.

public override IData Input { get; set; }

Nilai Properti

IData

Namespace: Documentize Assembly: Documentize.dll

Class HtmlConverter

Info

Mewakili plugin Documentize.HtmlConverter. Digunakan untuk mengonversi dokumen PDF ke format HTML dan dokumen HTML ke format PDF.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class HtmlConverter

Warisan

object
HtmlConverter

Anggota yang Dwarisi

Metode

Process(PdfToHtmlOptions)

Mengonversi dokumen PDF ke format HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Parameter

  • options PdfToHtmlOptions: Sebuah objek opsi yang berisi instruksi untuk operasi ini.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

ArgumentException – Jika opsi tidak disetel.

Process(HtmlToPdfOptions)

Mengonversi dokumen HTML ke format PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Parameter

  • options HtmlToPdfOptions: Sebuah objek opsi yang berisi instruksi untuk operasi ini.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

ArgumentException – Jika opsi tidak disetel.

Namespace: Documentize
Assembly: Documentize.dll

Class HtmlToPdfOptions

Info

Mewakili opsi konversi HTML ke PDF untuk plugin Documentize.PdfConverter.

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Warisan

objectPluginBaseOptionsHtmlToPdfOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

HtmlToPdfOptions()

Menginisialisasi instance baru dari objek Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Properti

BasePath

Jalur dasar/URL untuk file html.

public string BasePath { get; set; }

Nilai Properti

string

HtmlMediaType

Mendapatkan atau mengatur jenis media yang memungkinkan digunakan selama proses rendering.

public HtmlMediaType HtmlMediaType { get; set; }

Nilai Properti

HtmlMediaType

IsRenderToSinglePage

Mendapatkan atau mengatur rendering seluruh dokumen ke satu halaman.

public bool IsRenderToSinglePage { get; set; }

Nilai Properti

bool

PageInfo

Mendapatkan atau mengatur informasi halaman dokumen.

public PageInfo PageInfo { get; set; }

Nilai Properti

PageInfo

PageLayoutOption

Mendapatkan atau mengatur opsi tata letak.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Nilai Properti

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

Info

Mewakili komponen Documentize.ImageExtractor. Digunakan untuk mengekstrak gambar dari dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfExtractor class.")]
public static class ImageExtractor

Inheritance

objectImageExtractor

Inherited Members

Methods

Process(ExtractImagesOptions)

Mengekstrak gambar dari dokumen PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Exceptions

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractorOptions

Info

Mewakili opsi ekstraksi gambar untuk plugin Documentize.ImageExtractor.

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsImageExtractorOptions

Mengimplementasikan

Anggota yang diwarisi

Konstruktor

ImageExtractorOptions()

Menginisialisasi instance baru dari objek Documentize.ImageExtractorOptions dengan opsi default.

public ImageExtractorOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Info

Info

Kelas ini menyediakan informasi tentang build produk saat ini.

public static class Info

Keturunan

objectInfo

Anggota yang Diwarisi

Bidang

AssemblyVersion Versi Assembly.

public const string AssemblyVersion = "26.9.0"

Nilai Bidang

string

Product

Nama Produk.

public const string Product = "Documentize"

Nilai Bidang

string

Namespace: Documentize Assembly: Documentize.dll

Class JpegConverter

Info

Mewakili plugin Documentize.JpegConverter. Digunakan untuk mengonversi dokumen PDF menjadi format JPEG.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class JpegConverter

Pewarisan

objectJpegConverter

Anggota yang Diwarisi

Metode

Process(PdfToJpegOptions)

Mengonversi dokumen PDF menjadi format JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Parameter

  • options PdfToJpegOptions: Objek opsi yang berisi instruksi untuk Documentize.JpegConverter.

Mengembalikan

ResultContainer : Objek yang berisi hasil dari operasi tersebut.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class License

Info

Menyediakan metode untuk mengatur Lisensi.

public static class License

Inheritance

objectLicense

Inherited Members

Examples

Menampilkan cara mengaktifkan lisensi.

// Set License
License.Set("PathToLicense.lic");

Methods

Set(string)

Memberi lisensi pada komponen.

public static void Set(string licenseName)

Parameters

  • licenseName string: Bisa berupa nama file lengkap atau singkat. Gunakan string kosong untuk beralih ke mode evaluasi.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Info

Mewakili opsi Penggabungan untuk plugin Documentize.PdfManager.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsMergeOptions

Mengimplementasikan

Anggota yang Diperoleh

Konstruktor

MergeOptions()

Menginisialisasi instance baru dari objek Documentize.MergeOptions dengan opsi default.

public MergeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Merger

Info

Mewakili plugin Documentize.Merger. Digunakan untuk menggabungkan beberapa dokumen PDF menjadi satu PDF.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class Merger

Pewarisan

objectMerger

Anggota yang Duwasi

Metode

Process(MergeOptions)

Menggabungkan dokumen PDF.

public static ResultContainer Process(MergeOptions options)

Parameter

  • options MergeOptions: Sebuah objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class Message

Info

Pesan penyelesaian obrolan yang dihasilkan oleh model.

public class Message

Inheritance

objectMessage

Inherited Members

Constructors

Message()

public Message()

Properties

Content

Isi pesan.

[JsonProperty("content")]
public string Content { get; set; }

Property Value

string

Role

Mengatur atau mendapatkan peran penulis pesan ini.

[JsonProperty("role")]
[JsonConverter(typeof(StringEnumConverter), new object[] { true })]
public Role Role { get; set; }

Property Value

Role

Namespace: Documentize Assembly: Documentize.dll

Class ObjectResult

Info

Mewakili hasil operasi dalam bentuk string.

public sealed class ObjectResult : IOperationResult

Inheritance

objectObjectResult

Implements

Inherited Members

Properties

Data

Mendapatkan data mentah.

public object Data { get; }

Property Value

object

IsFile

Menunjukkan apakah hasil adalah jalur ke file output.

public bool IsFile { get; }

Property Value

bool

IsObject

Menunjukkan apakah hasil adalah sebuah objek.

public bool IsObject { get; }

Property Value

bool

IsStream

Menunjukkan apakah hasil adalah jalur ke file output.

public bool IsStream { get; }

Property Value

bool

IsString

Menunjukkan apakah hasil adalah sebuah string.

public bool IsString { get; }

Property Value

bool

Text

Mengembalikan representasi string dari hasil.

public string Text { get; }

Property Value

string

Methods

ToFile()

Mencoba mengonversi hasil menjadi file.

public string ToFile()

Returns

string : Sebuah string yang mewakili jalur ke file output jika hasil berupa file; selain itu null.

ToStream()

Mencoba mengonversi hasil menjadi objek stream.

public Stream ToStream()

Returns

Stream : Sebuah objek stream yang mewakili data output jika hasil berupa stream; selain itu null.

ToString()

Mencoba mengonversi hasil menjadi string.

public override string ToString()

Returns

string : Sebuah string yang mewakili konten teks jika hasil berupa string; selain itu mengembalikan base.ToString().

Namespace: Documentize
Assembly: Documentize.dll

Class OptimizeOptions

Info

Mewakili opsi Optimize untuk plugin Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsOptimizeOptions

Implements

Inherited Members

Constructors

OptimizeOptions()

Menginisialisasi instance baru dari objek Documentize.OptimizeOptions dengan opsi default. Linearize dokumen agar:

  • membuka halaman pertama secepat mungkin;
  • menampilkan halaman berikutnya atau mengikuti tautan ke halaman berikutnya secepat mungkin;
  • menampilkan halaman secara bertahap saat data untuk halaman tersebut diterima melalui saluran yang lambat (menampilkan data yang paling berguna terlebih dahulu);
  • memungkinkan interaksi pengguna, seperti mengikuti tautan, dilakukan bahkan sebelum seluruh halaman diterima dan ditampilkan.
public OptimizeOptions()

Namespace: Documentize Assembly: Documentize.dll

Class Optimizer

Info

Mewakili plugin Documentize.Optimizer. Digunakan untuk Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompres dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class Optimizer

Pewarisan

objectOptimizer

Anggota yang Ditarik

Metode

Process(OptimizeOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(OptimizeOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Process(RotateOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(RotateOptions options)

Parameter

  • options RotateOptions: Objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Process(ResizeOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(ResizeOptions options)

Parameter

  • options ResizeOptions: Objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Process(CompressOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(CompressOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Namespace: Documentize Assembly: Documentize.dll

Class OptionsWithInput

Info

Mewakili opsi dasar untuk operasi dengan 1 Data Input.

public abstract class OptionsWithInput : IHaveInput

Pewarisan

objectOptionsWithInput

Diturunkan

Mengimplementasikan

Anggota yang Diturunkan

Bidang

  • input

    protected IData input;

Nilai Field

IData

Properti

Input

Mendapatkan atau menetapkan Data Input.

public virtual IData Input { get; set; }

Nilai Properti

IData

Namespace: Documentize
Assembly: Documentize.dll

Class OptionsWithInputAndOutput

Info

Mewakili opsi dasar untuk operasi dengan 1 Data Masukan dan 1 Data Keluaran.

public abstract class OptionsWithInputAndOutput : OptionsWithInput, IHaveInput

Pewarisan

objectOptionsWithInputOptionsWithInputAndOutput

Turunan

Mengimplementasikan

Anggota yang Diwarisi

Bidang

output

protected IData output

Nilai Bidang

IData

Properti

Output

Mendapatkan atau menetapkan Data Output.

public virtual IData Output { get; set; }

Nilai Properti

IData

Namespace: Documentize
Assembly: Documentize.dll

Class PageInfo

Info

Mewakili informasi halaman.

public class PageInfo : PageSize

Pewarisan

object
PageSize
PageInfo

Anggota yang Diwariskan

Konstruktor

PageInfo()

Konstruktor dari Documentize.PageInfo.

public PageInfo()

PageInfo(double, double)

Konstruktor dari Documentize.PageInfo.

public PageInfo(double width, double height)

Parameter

Properti

MarginBottom

Mendapatkan atau mengatur nilai yang menunjukkan margin bawah.

public double MarginBottom { get; set; }

Nilai Properti

double

MarginLeft

Mendapatkan atau mengatur nilai yang menunjukkan margin kiri.

public double MarginLeft { get; set; }

Nilai Properti

double

MarginRight

Mendapatkan atau mengatur nilai yang menunjukkan margin kanan.

public double MarginRight { get; set; }

Nilai Properti

double

MarginTop

Mendapatkan atau mengatur nilai yang menunjukkan margin atas.

public double MarginTop { get; set; }

Nilai Properti

double

Namespace: Documentize
Assembly: Documentize.dll

Class PageSize

Info

Kelas yang merepresentasikan ukuran halaman dalam dokumen PDF.

public class PageSize

Inheritance

objectPageSize

Derived

Inherited Members

Constructors

PageSize()

Konstruktor Documentize.PageSize. Ukuran A4 secara default.

public PageSize()

PageSize(double, double)

Konstruktor Documentize.PageSize.

public PageSize(double width, double height)

Parameters

Properties

A0

Ukuran A0 (1189x840 mm).

public static PageSize A0 { get; }

Property Value

PageSize

A1

Ukuran A1 (840x594 mm).

public static PageSize A1 { get; }

Property Value

PageSize

A2

Ukuran A2 (594x420 mm).

public static PageSize A2 { get; }

Property Value

PageSize

A3

Ukuran A3 (420x297 mm).

public static PageSize A3 { get; }

Property Value

PageSize

A4

Ukuran A4 (297x210 mm).

public static PageSize A4 { get; }

Property Value

PageSize

A5

Ukuran A5 (210x148 mm).

public static PageSize A5 { get; }

Property Value

PageSize

A6

Ukuran A6 (148x105 mm).

public static PageSize A6 { get; }

Property Value

PageSize

B5

Ukuran B5 (250x176 mm).

public static PageSize B5 { get; }

Property Value

PageSize

Height

Mendapatkan atau mengatur tinggi halaman.

public double Height { get; set; }

Property Value

double

IsLandscape

Mendapatkan orientasi halaman. Mengembalikan true jika ini berorientasi lanskap dan false jika berorientasi potret.

public bool IsLandscape { get; }

Property Value

bool

P11x17

Format 11x17 inci.

public static PageSize P11x17 { get; }

Property Value

PageSize

PageLedger

Ukuran ledger (432x279 mm).

public static PageSize PageLedger { get; }

Property Value

PageSize

Ukuran legal (356x216 mm).

public static PageSize PageLegal { get; }

Property Value

PageSize

PageLetter

Ukuran letter (279x216 mm).

public static PageSize PageLetter { get; }

Property Value

PageSize

Width

Mendapatkan atau mengatur lebar halaman.

public double Width { get; set; }

Property Value

double

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAConverter

Info

Merepresentasikan plugin untuk menangani konversi dokumen PDF ke format PDF/A dan untuk validasi kepatuhan PDF/A.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class PdfAConverter

Pewarisan

objectPdfAConverter

Anggota yang Diwariskan

Metode

Process(PdfToPdfAOptions)

Mengonversi dokumen PDF ke format PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Parameter

  • options PdfToPdfAOptions: Sebuah objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

ArgumentException
Jika opsi tidak diatur.

Process(PdfAValidateOptions)

Memeriksa dokumen PDF untuk kepatuhan terhadap format PDF/A yang ditentukan.

public static ResultContainer Process(PdfAValidateOptions options)

Parameter

Pengembalian

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

ArgumentException
Jika opsi tidak diatur.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfAConvertOptions

Info

Mewakili opsi untuk mengonversi dokumen PDF ke format PDF/A dengan plugin Documentize.PdfAConverter.

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Inheritance

objectPdfAOptionsBasePdfAConvertOptions

Implements

Inherited Members

Constructors

PdfAConvertOptions()

public PdfAConvertOptions()

Properties

Outputs

Mengambil koleksi target yang telah ditambahkan (sumber data file atau stream) untuk hasil operasi simpan.

public List<idatasource> Outputs { get; }

Property Value

List<IDataSource>

Methods

AddOutput(IDataSource)

Menambahkan target simpan hasil baru.

public void AddOutput(IDataSource dataSource)

Parameters

  • dataSource IDataSource: Target (file atau sumber data stream) untuk hasil operasi simpan. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfAOptionsBase

Info

Mewakili kelas dasar untuk opsi plugin Documentize.PdfAConverter. Kelas ini menyediakan properti dan metode untuk mengkonfigurasi proses konversi dan validasi PDF/A.

Represents the base class for the Documentize.PdfAConverter plugin options. This class provides properties and methods for configuring the PDF/A conversion and validation process.

public abstract class PdfAOptionsBase : IPluginOptions

Pewarisan

objectPdfAOptionsBase

Turunan

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

PdfAOptionsBase()

protected PdfAOptionsBase()

Properti

AlignText

Mendapatkan atau menetapkan nilai yang menunjukkan apakah diperlukan cara tambahan untuk mempertahankan perataan teks selama proses konversi PDF/A.

public bool AlignText { get; set; }

Nilai Properti

bool

Catatan

Ketika diatur ke true, proses konversi akan berusaha mengembalikan batas segmen teks asli. Untuk kebanyakan dokumen tidak perlu mengubah properti ini dari nilai default false, karena perataan teks tidak berubah selama proses konversi default.

CheckDifferentNamesInFontDictionaries

Mendapatkan flag yang mengontrol konversi PDF/A untuk kasus ketika dokumen PDF sumber tidak sesuai dengan spesifikasi PDF.

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Nilai Properti

bool

ErrorAction

Mendapatkan atau menetapkan aksi yang akan diambil untuk objek yang tidak dapat dikonversi.

public ConvertErrorAction ErrorAction { get; set; }

Nilai Properti

ConvertErrorAction

IccProfileFileName

Mendapatkan atau menetapkan nama file profil ICC (International Color Consortium) yang akan digunakan untuk konversi PDF/A menggantikan profil default.

public string IccProfileFileName { get; set; }

Nilai Properti

string

Inputs

Mendapatkan koleksi data.

public List<IData> Inputs { get; }

Nilai Properti

List<IData>

IsLowMemoryMode

Mendapatkan atau menetapkan nilai yang menunjukkan apakah mode memori rendah diaktifkan selama proses konversi PDF/A.

public bool IsLowMemoryMode { get; set; }

Nilai Properti

bool

LogOutputSource

Mendapatkan atau menetapkan sumber data untuk output log.

public IData LogOutputSource { get; set; }

Nilai Properti

IData

OptimizeFileSize

Mendapatkan atau menetapkan nilai yang menunjukkan apakah akan mencoba mengurangi ukuran file selama proses konversi PDF/A.

public bool OptimizeFileSize { get; set; }

Nilai Properti

bool

Catatan

Ketika diatur ke true, proses konversi akan berusaha meminimalkan ukuran file yang dihasilkan. Hal ini dapat mempengaruhi kinerja proses konversi.

PdfAVersion

Mendapatkan atau menetapkan versi standar PDF/A yang akan digunakan untuk validasi atau konversi.

public PdfAStandardVersion PdfAVersion { get; set; }

Nilai Properti

PdfAStandardVersion

Catatan

Versi standar PDF/A digunakan untuk menentukan tingkat kepatuhan untuk validasi dan konversi PDF/A. Jika versi diatur ke Documentize.PdfAStandardVersion.Auto, sistem akan secara otomatis menentukan versi standar PDF/A yang tepat untuk validasi berdasarkan metadata dokumen. Untuk proses konversi PDF/A, Documentize.PdfAStandardVersion.Auto secara default mengacu pada versi standar PDF/A-1b.

SoftMaskAction

Mendapatkan atau menetapkan aksi yang akan diambil selama konversi gambar dengan soft mask.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Nilai Properti

ConvertSoftMaskAction

Metode

AddInput(IData)

Menambahkan data baru ke koleksi

public void AddInput(IData data)

Parameter

Ruang Nama: Documentize Rakitan: Documentize.dll

Class PdfAValidateOptions

Info

Mewakili opsi untuk memvalidasi kepatuhan PDF/A dokumen PDF dengan plugin Documentize.PdfConverter.

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Pewarisan

objectPdfAOptionsBasePdfAValidateOptions

Mengimplementasikan

Anggota yang diwariskan

Konstruktor

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidationResult

Info

Mewakili hasil proses validasi PDF/A.

public sealed class PdfAValidationResult

Pewarisan

objectPdfAValidationResult

Anggota yang Diwarisi

Fields

Data

Mengambil sumber data yang divalidasi.

public readonly IData Data

Nilai Field

IData

IsValid

Mengambil nilai yang menunjukkan apakah validasi berhasil.

public readonly bool IsValid

Nilai Field

bool

StandardVersion

Mengambil versi standar PDF/A yang digunakan untuk validasi.

public readonly PdfAStandardVersion StandardVersion

Nilai Field

PdfAStandardVersion

Namespace: Documentize
Assembly: Documentize.dll

Class PdfChatGpt

Info

Mewakili plugin PdfChatGpt.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class PdfChatGpt

Inheritance

objectPdfChatGpt

Inherited Members

Remarks

Documentize.PdfChatGpt digunakan untuk mengirim permintaan ke ChatGPT secara langsung atau dengan menambahkan sumber file PDF dan menyimpan balasan ke sumber keluaran.

Methods

Process(IPluginOptions)

Metode ini tidak memiliki versi sinkron. Gunakan metode ProcessAsync sebagai gantinya.

public static ResultContainer Process(IPluginOptions options)

Parameters

  • options IPluginOptions: Objek opsi yang berisi instruksi untuk PdfChatGpt.

Returns

ResultContainer :

Exceptions

NotImplementedException

ProcessAsync(IPluginOptions)

Memulai pemrosesan PdfChatGpt dengan parameter yang ditentukan.

public static Task<ResultContainer> ProcessAsync(IPluginOptions options)

Parameters

  • options IPluginOptions: Objek opsi yang berisi instruksi untuk PdfChatGpt.

Returns

Task<ResultContainer>

Objek tugas yang mewakili operasi asinkron.

Exceptions

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptOptions

Info

Mewakili opsi untuk plugin Documentize.PdfChatGpt.

public class PdfChatGptOptions : IPluginOptions

Pewarisan

objectPdfChatGptOptions

Turunan

Mengimplementasikan

Anggota yang Dwarisi

Konstruktor

PdfChatGptOptions()

Menginisialisasi instance baru dari objek Documentize.PdfChatGptOptions.

public PdfChatGptOptions()

Properti

Inputs

public List<idatasource> Inputs { get; }

Nilai Properti

List<IDataSource>

Outputs

public List<idatasource> Outputs { get; }

Nilai Properti

List<IDataSource>

Metode

AddInput(IDataSource)

Menambahkan sumber data baru ke koleksi data plugin PdfChatGpt.

public void AddInput(IDataSource dataSource)

Parameter

  • dataSource IDataSource: Sumber data (file atau stream) yang akan ditambahkan.

AddOutput(IDataSource)

Menambahkan sumber data penyimpanan baru ke koleksi data plugin PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Parameter

  • saveDataSource IDataSource: Sumber data (file atau stream) untuk menyimpan hasil operasi. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGptRequestOptions

Info

Mewakili opsi untuk plugin Documentize.PdfChatGpt.

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Inheritance

objectPdfChatGptOptionsPdfChatGptRequestOptions

Implements

Inherited Members

Constructors

PdfChatGptRequestOptions()

Menginisialisasi instance baru dari objek Documentize.PdfChatGptRequestOptions dengan opsi default.

public PdfChatGptRequestOptions()

PdfChatGptRequestOptions(string, string, string, string)

Menginisialisasi instance baru dari objek Documentize.PdfChatGptRequestOptions dengan opsi.

public PdfChatGptRequestOptions(string apiKey, string model, string apiUrl, string query)

Parameters

Properties

ApiKey

Mendapatkan atau menetapkan kunci untuk mengakses API ChatGPT.

public string ApiKey { get; set; }

Property Value

string

ApiUrl

Mendapatkan atau menetapkan URL API ChatGPT.

public string ApiUrl { get; set; }

Property Value

string

CancellationToken

Token pembatalan.

public CancellationToken CancellationToken { get; set; }

Property Value

CancellationToken

MaxTokens

Jumlah maksimum token dalam respons. Nilai default adalah null, yang berarti tak terhingga.

public int? MaxTokens { get; set; }

Property Value

int?

Messages

Mendapatkan atau menetapkan koleksi objek Documentize.Message.

public List<message> Messages { get; set; }

Property Value

List<Message>

Remarks

Saat menambahkan beberapa pesan ke opsi, urutan dalam koleksi pesan adalah sebagai berikut:

  • Pesan pertama (jika ada) berasal dari options.Query, diawali dengan pesan yang berisi konten: “Anda adalah asisten yang membantu.”, dan perannya adalah “system”.
  • Kemudian (jika ada) pesan dari koleksi options.Messages ditambahkan.
  • Pesan dari sumber file (jika ada) ditambahkan terakhir, satu objek pesan untuk setiap dokumen dengan peran “user”. Jika tidak ada satu pesan pun yang disediakan, maka akan terjadi ArgumentException.

Model

Menetapkan atau mendapatkan ID model yang akan digunakan.

public string Model { get; set; }

Property Value

string

NumberOfChoices

Berapa banyak pilihan penyelesaian chat yang akan dihasilkan untuk setiap pesan input.

public int NumberOfChoices { get; set; }

Property Value

int

Query

Mendapatkan atau menetapkan string permintaan ke ChatGPT. Jika tidak kosong, ini adalah pesan pertama dalam koleksi, yang akan dikirim dalam permintaan.

public string Query { get; set; }

Property Value

string

Temperature

Suhu sampling yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0.8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0.2 akan membuatnya lebih fokus dan deterministik. Nilai default adalah 1.

public double Temperature { get; set; }

Property Value

double

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverter

Info

Mewakili komponen Documentize.PdfConverter. Digunakan untuk Mengonversi dokumen PDF ke format lain seperti DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Juga memungkinkan Anda melakukan Validasi PDF/A dan Mengonversi HTML ke PDF.

Mewakili komponen Documentize.PdfConverter. Digunakan untuk Mengonversi dokumen PDF ke format lain seperti DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A.
Juga memungkinkan Anda melakukan Validasi PDF/A dan Mengonversi HTML ke PDF.

public static class PdfConverter

Pewarisan

objectPdfConverter

Anggota yang Diwarisi

Metode

Convert(PdfToDocOptions)

Mengonversi dokumen PDF ke format DOC/DOCX.

public static ResultContainer Convert(PdfToDocOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format Doc.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format Doc dengan mengatur Mode.

// Create PdfToDocOptions object to set instructions
var options = new PdfToDocOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_file.doc"));
// Set Mode
options.Mode = DocConversionMode.Flow;
// Perform the process
PdfConverter.Convert(options);

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(PdfToXlsOptions)

Mengonversi dokumen PDF ke format XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Convert(PdfToXlsOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi PDF ke dokumen XLSX.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xlsx"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi PDF ke dokumen XLS.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Specify XLS format
options.Format = PdfToXlsOptions.ExcelFormat.XMLSpreadSheet2003;
options.InsertBlankColumnAtFirst = true;
options.MinimizeTheNumberOfWorksheets = true;
// Set output file path
options.AddOutput(new FileData("path_to_result_xlsx_file.xls"));
// Perform the process
PdfConverter.Convert(options);

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(PdfToHtmlOptions)

Mengonversi dokumen PDF ke format HTML.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi PDF ke dokumen HTML.

// Create PdfToHtmlOptions object to set output data type as file with embedded resources
var options = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.html"));
//Perform the process
PdfConverter.Convert(options);

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(HtmlToPdfOptions)

Mengonversi dokumen HTML ke format PDF.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi HTML ke dokumen PDF.

// Create HtmlToPdfOptions
var options = new HtmlToPdfOptions();
// Add input file path
options.AddInput(new FileData("path_to_input.html"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
//Perform the process
PdfConverter.Convert(options);

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(PdfToJpegOptions)

Mengonversi dokumen PDF ke format JPEG.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format JPEG.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format JPEG dengan pengaturan halaman, resolusi, kualitas.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Process only the first page
options.PageList = [1];
// Set output resolution to 200 DPI
options.OutputResolution = 200;
// Set output quality to 50
options.Quality = 50;
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format JPEG ke stream.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(PdfToPngOptions)

Mengonversi dokumen PDF ke format PNG.

public static ResultContainer Convert(PdfToPngOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format PNG.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi 1 halaman dokumen PDF ke format PNG.

// Create PdfToPngOptions object to set instructions
var options = new PdfToPngOptions()
// Process only the first page
options.PageList = [1];
// Set output resolution to 200 DPI
options.OutputResolution = 200;
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format PNG ke stream.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(PdfToTiffOptions)

Mengonversi dokumen PDF ke format TIFF.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format TIFF.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format TIFF dengan menyesuaikan halaman dan DPI.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Pages
options.PageList = [1, 3];
// Set result image Resolution
options.OutputResolution = 400;
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke TIFF sebagai Multi‑Page.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Enable Multi-Page TIFF output
options.MultiPage = true;
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format TIFF dengan menyesuaikan Kompresi dan Kedalaman Warna.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_output_directory"));
// Set Compression and ColorDepth
options.Compression = TiffCompression.RLE;
options.ColorDepth = TiffColorDepth.Format24bpp;
// Perform the process
PdfConverter.Convert(options);

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format TIFF ke stream.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileData("path_to_input.pdf"));
// Perform the process
var results = PdfConverter.Convert(options);
// Get stream results
foreach (var result in results.ResultCollection)
{
    var streamResultPage1 = result.ToStream();
}

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Convert(PdfToPdfAOptions)

Mengonversi dokumen PDF ke format PDF/A.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format PDF/A (PDF/A‑3b dalam contoh ini):

// Create the options class to set up the conversion process
var options = new PdfToPdfAOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_3B
};

// Add the source file
options.AddInput(new FileData("path_to_your_pdf_file.pdf")); // replace with your actual file path

// Add the path to save the converted file
options.AddOutput(new FileData("path_to_the_converted_file.pdf"));

// Run the conversion
PdfConverter.Convert(options);

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Validate(PdfAValidateOptions)

Memeriksa dokumen PDF untuk kepatuhan terhadap format PDF/A yang ditentukan.

public static ResultContainer Validate(PdfAValidateOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara memvalidasi kepatuhan dokumen PDF terhadap format PDF/A (PDF/A‑1a dalam contoh ini):

// Create the options class to set up the validation process
var options = new PdfAValidateOptions
{
    PdfAVersion = PdfAStandardVersion.PDF_A_1A
};

// Add one or more files to be validated
options.AddInput(new FileData("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileData("path_to_your_second_pdf_file.pdf"));
// add more files as needed

// Run the validation and get results
var resultContainer = PdfConverter.Validate(options);

// Check the resultContainer.ResultCollection property for validation results for each file:
foreach (var result in resultContainer.ResultCollection)
{
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for document
}

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class PdfConverterOptions

Info

Mewakili opsi untuk plugin konversi Pdf.

public abstract class PdfConverterOptions : IPluginOptions

Pewarisan

objectPdfConverterOptions

Turunan

Mengimplementasikan

Anggota yang Dwarisi

Properti

Inputs

Mengembalikan koleksi data plugin PdfConverterOptions.

public List<idatasource> Inputs { get; }

Nilai Properti

List<IDataSource>

Outputs

Mengambil koleksi target yang ditambahkan untuk menyimpan hasil operasi.

public List<idatasource> Outputs { get; }

Nilai Properti

List<IDataSource>

Metode

AddInput(IDataSource)

Menambahkan sumber data baru ke koleksi data plugin PdfConverter.

public void AddInput(IDataSource dataSource)

Parameter

  • dataSource IDataSource: Sumber data yang akan ditambahkan.

AddOutput(IDataSource)

Menambahkan sumber data baru ke koleksi data plugin PdfToXLSXConverterOptions.

public void AddOutput(IDataSource saveDataSource)

Parameter

  • saveDataSource IDataSource: Sumber data (file atau aliran) untuk menyimpan hasil operasi.

Pengecualian

NotImplementedException

Namespace: Documentize Assembly: Documentize.dll

Class PdfExtractor

Info

Mewakili komponen Documentize.PdfExtractor. Digunakan untuk Mengekstrak Teks, Gambar, Data Formulir, Properti (Meta Data) dari dokumen PDF.

public static class PdfExtractor

Pewarisan

objectPdfExtractor

Anggota yang Dwarisi

Metode

Extract(ExtractTextOptions)

Mengekstrak Teks dari dokumen PDF.

public static string Extract(ExtractTextOptions options)

Parameter

Mengembalikan

string : Teks yang diekstrak.

Contoh

Contoh berikut memperlihatkan cara Mengekstrak konten Teks dari file PDF.

// Buat objek ExtractTextOptions untuk mengatur jalur file input
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Lakukan proses dan dapatkan teks yang diekstrak
var textExtracted = PdfExtractor.Extract(options);

Contoh berikut memperlihatkan cara Mengekstrak konten Teks dari aliran PDF.

// Buat objek ExtractTextOptions untuk mengatur aliran input
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Lakukan proses dan dapatkan teks yang diekstrak
var textExtracted = PdfExtractor.Extract(options);

Contoh berikut memperlihatkan cara Mengekstrak konten Teks dokumen PDF dengan TextFormattingMode.

// Buat objek ExtractTextOptions untuk mengatur jalur file input dan TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Lakukan proses dan dapatkan teks yang diekstrak
var textExtracted = PdfExtractor.Extract(options);

Contoh berikut memperlihatkan cara Mengekstrak Teks dari file PDF dalam gaya yang paling singkat.

// Lakukan proses dan dapatkan teks yang diekstrak
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Extract(ExtractImagesOptions)

Mengekstrak gambar dari dokumen PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut memperlihatkan cara Mengekstrak Gambar dari dokumen PDF.

// Buat ExtractImagesOptions untuk mengatur instruksi
var options = new ExtractImagesOptions();
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Atur jalur Direktori output
options.AddOutput(new DirectoryData("path_to_results_directory"));
 // Lakukan proses
var results = PdfExtractor.Extract(options);
// Dapatkan jalur ke hasil gambar
var imageExtracted = results.ResultCollection[0].ToFile();

Contoh berikut memperlihatkan cara Mengekstrak Gambar dari dokumen PDF ke Stream tanpa folder.

// Buat ExtractImagesOptions untuk mengatur instruksi
var options = new ExtractImagesOptions();
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tidak mengatur output - hasil akan ditulis ke stream
// Lakukan proses
var results = PdfExtractor.Extract(options);
// Dapatkan Stream
var ms = results.ResultCollection[0].ToStream();
// Salin data ke file untuk demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Extract(ExtractFormDataToDsvOptions)

Mengekstrak Data Formulir dari dokumen PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut memperlihatkan cara Mengekspor nilai Formulir ke file CSV.

// Buat ExtractFormDataToDsvOptions untuk mengatur instruksi
var options = new ExtractFormDataToDsvOptions(',', true);
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Atur jalur file output
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Lakukan proses
PdfExtractor.Extract(options);

Contoh berikut memperlihatkan cara Mengekspor nilai Formulir ke file TSV dan mengatur Properti.

// Buat ExtractFormDataToDsvOptions untuk mengatur instruksi
var options = new ExtractFormDataToDsvOptions();
//Atur Pembatas
options.Delimiter = '\t';
//Tambahkan Nama Kolom ke hasil
options.AddFieldName = true;
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Atur jalur file output
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Lakukan proses
PdfExtractor.Extract(options);

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Extract(ExtractPropertiesOptions)

Mengekstrak Properti dari dokumen PDF.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Parameter

Mengembalikan

PdfProperties : Objek yang berisi hasil operasi.

Contoh

Contoh berikut memperlihatkan cara Mengekstrak Properti (FileName, Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) dari file PDF.

// Buat ExtractPropertiesOptions untuk mengatur file input
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Lakukan proses dan dapatkan Properti
var pdfProperties = PdfExtractor.Extract(options);
var filename = pdfProperties.FileName;
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

Contoh berikut memperlihatkan cara Mengekstrak Properti (Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) dari aliran PDF.

// Buat ExtractPropertiesOptions untuk mengatur aliran input
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Lakukan proses dan dapatkan Properti
var pdfProperties = PdfExtractor.Extract(options);
var title = pdfProperties.Title;
var author = pdfProperties.Author;
var subject = pdfProperties.Subject;
var keywords = pdfProperties.Keywords;
var created = pdfProperties.Created;
var modified = pdfProperties.Modified;
var application = pdfProperties.Application;
var pdfProducer = pdfProperties.PdfProducer;
var numberOfPages = pdfProperties.NumberOfPages;

Contoh berikut memperlihatkan cara Mengekstrak Properti dari file PDF dalam gaya yang paling singkat.

// Lakukan proses dan dapatkan Properti
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class PdfForm

Info

Mewakili komponen Documentize.PdfForm. Digunakan untuk Flatten, mengekstrak data formulir. Juga memungkinkan Anda untuk mendapatkan nama bidang.

Mewakili komponen Documentize.PdfForm. Digunakan untuk Flatten, mengekstrak data formulir.
Juga memungkinkan Anda untuk mendapatkan nama bidang.

public static class PdfForm

Inheritance

objectPdfForm

Inherited Members

Methods

Extract(ExtractFormDataToDsvOptions)

Mengekstrak data formulir dari dokumen PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil dari operasi.

Examples

Contoh menunjukkan cara mengekspor nilai formulir ke file CSV.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions(',', true);
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.csv"));
// Perform the process
PdfForm.Extract(options);

Contoh menunjukkan cara mengekspor nilai formulir ke file TSV dan mengatur properti.

// Create ExtractFormDataToDsvOptions object to set instructions
var options = new ExtractFormDataToDsvOptions();
//Set Delimiter
options.Delimiter = '\t';
//Add Field Names to result
options.AddFieldName = true;
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_csv_file.tsv"));
// Perform the process
PdfForm.Extract(options);

Exceptions

ArgumentException
Jika opsi tidak diatur.

Flatten(FlattenFieldsOptions)

Meluruskan (flatten) bidang pada dokumen PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil dari operasi.

Examples

Contoh menunjukkan cara meluruskan bidang pada file PDF.

// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Flatten(options);

Contoh menunjukkan cara meluruskan bidang pada file PDF dan melewati bidang pertama.

// Get Fields Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));
// Create FlattenFieldsOptions object to set instructions
var options = new FlattenFieldsOptions();
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Skip 1 field.
options.SkipFields.Add(fieldNames[0]);
// Perform the process
PdfForm.Flatten(options);

Exceptions

ArgumentException
Jika opsi tidak diatur.

GetNames(GetFieldNamesOptions)

Mendapatkan nama bidang dalam dokumen PDF.

public static List<string> GetNames(GetFieldNamesOptions options)

Parameters

Returns

List<string>
Daftar nama dalam dokumen PDF.

Examples

Contoh menunjukkan cara mendapatkan nama bidang dari file PDF.

// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions("path_to_your_pdf_file.pdf"));

Contoh menunjukkan cara mendapatkan nama bidang dari aliran PDF.

// Prepare input stream
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
// Get Field Names
var fieldNames = PdfForm.GetNames(new GetFieldNamesOptions(inputStream));

Remove(RemoveFieldsOptions) : Menghapus bidang dari dokumen PDF.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil dari operasi.

Examples

Contoh menunjukkan cara menghapus bidang dari file PDF.

// Create RemoveFieldsOptions object to set instructions
var options = new RemoveFieldsOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfForm.Remove(options);

Exceptions

ArgumentException
Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class PdfManager

Info

Mewakili komponen Documentize.PdfManager. Digunakan untuk Menggabungkan, Memisahkan, Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompres dokumen PDF serta Menambahkan Tabel, Menambahkan Daftar Isi ke dokumen PDF. Dapat Menggabungkan beberapa dokumen PDF menjadi satu PDF. Dapat Memisahkan dokumen PDF menjadi halaman terpisah. Dapat Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompres dokumen PDF. Dapat Memutar, Mengubah Ukuran Halaman dokumen PDF. Dapat Menambahkan Tabel ke dokumen PDF. Dapat Menambahkan Daftar Isi ke dokumen PDF.

Mewakili komponen Documentize.PdfManager. Digunakan untuk Menggabungkan, Memisahkan, Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompres dokumen PDF serta Menambahkan Tabel, Menambahkan Daftar Isi ke dokumen PDF.
Dapat Menggabungkan beberapa dokumen PDF menjadi satu PDF.
Dapat Memisahkan dokumen PDF menjadi halaman terpisah.
Dapat Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompres dokumen PDF.
Dapat Memutar, Mengubah Ukuran Halaman dokumen PDF.
Dapat Menambahkan Tabel ke dokumen PDF.
Dapat Menambahkan Daftar Isi ke dokumen PDF.

public static class PdfManager

Pewarisan

object
PdfManager

Anggota yang Diwarisi

Metode

AddTable(TableOptions)

Menambahkan Tabel ke dokumen PDF.

public static ResultContainer AddTable(TableOptions options)

Parameter

  • options TableOptions: Objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Menambahkan Tabel ke file PDF.

// Konfigurasi opsi tabel
var options = new TableOptions();
options.InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_input.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_output.pdf"));
// Lakukan proses
PdfManager.AddTable(options);

Contoh berikut menunjukkan cara Menambahkan Tabel ke file PDF sebelum halaman ke‑2.

// Konfigurasi opsi tabel
var options = new TableOptions();
options.InsertPageBefore(2) // Tambahkan tabel sebelum halaman 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_input.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_output.pdf"));
// Lakukan proses
PdfManager.AddTable(options);

Pengecualian

ArgumentException
Jika opsi tidak diatur.

AddTableOfContents(TocOptions)

Menambahkan Daftar Isi (TOC) ke dokumen PDF.

public static ResultContainer AddTableOfContents(TocOptions options)

Parameter

  • options TocOptions: Objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara menambahkan Daftar Isi ke file PDF.

// Buat objek TocOptions untuk mengatur instruksi
var options = new TocOptions();
// Tetapkan Judul
options.Title = "My Table of Contents";
// Rancang Heading
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.AddTableOfContents(options);

Contoh berikut menunjukkan cara menambahkan Daftar Isi ke file PDF sambil menghasilkan bookmark.

// Buat objek TocOptions untuk mengatur instruksi
var options = new TocOptions();
// Tetapkan Judul
options.Title = "My Table of Contents";
// Hasilkan link dalam bookmark
options.GenerateBookmarks = true;
// Rancang Heading
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.AddTableOfContents(options);

Contoh berikut menunjukkan cara menambahkan Daftar Isi ke file PDF dan menyimpannya sebagai stream.

// Buat objek TocOptions untuk mengatur instruksi
var options = new TocOptions();
// Tetapkan Judul
options.Title = "My Table of Contents";
// Rancang Heading
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan stream output 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Lakukan proses
PdfManager.AddTableOfContents(options);

Contoh berikut menunjukkan cara menambahkan Daftar Isi ke file PDF dengan menyesuaikan Heading TOC.

// Buat objek TocOptions untuk mengatur instruksi
var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
// Tambahkan file input dan output
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Hasilkan TOC dengan opsi yang disesuaikan
PdfManager.AddTableOfContents(tocOptions);

Pengecualian

ArgumentException
Jika opsi tidak diatur.

Compress(CompressOptions)

Mengompres dokumen PDF. Mencoba mengurangi ukuran dokumen.

public static ResultContainer Compress(CompressOptions options)

Parameter

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Mengompres dokumen PDF.

// Buat objek CompressOptions untuk mengatur instruksi
var options = new CompressOptions();
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.Compress(options);

Pengecualian

ArgumentException
Jika opsi tidak diatur.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Membuat dokumen PDF berdasarkan balasan ChatGpt.
Digunakan untuk mengirim permintaan ke ChatGPT secara langsung atau dengan menambahkan sumber file PDF dan menyimpan balasannya ke sumber output.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Parameter

Pengembalian

Task<ResultContainer>

Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara menggunakan ChatGpt dengan menambahkan pesan ke permintaan.

var options = new ChatGptRequestOptions();
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key."; // Anda harus menyediakan kunci untuk mengakses API.
options.MaxTokens = 1000; // Jumlah token maksimum yang akan dihasilkan dalam chat completion.

// Tambahkan pesan permintaan.
options.Messages.Add(new Message
{
    Content = "You are a helpful assistant.",
    Role = Role.System
});
options.Messages.Add(new Message
{
    Content = "What is the biggest pizza diameter ever made?",
    Role = Role.User
});

// Proses permintaan.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Objek chat completion dari API ChatGPT.

Contoh berikut menunjukkan cara menggunakan ChatGpt dengan menambahkan satu pesan ke permintaan.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); // Tambahkan jalur file output.
options.ApiKey = "Your API key."; // Anda harus menyediakan kunci untuk mengakses API.
options.MaxTokens = 1000; // Jumlah token maksimum yang akan dihasilkan dalam chat completion.

// Tambahkan pesan permintaan.
// Dalam kasus ini, pesan sistem dengan Content = "You are a helpful assistant." ditambahkan secara default.
// Peran pesan query secara default adalah "user".
options.Query = "What is the lowest temperature recorded on the Earth?";

// Proses permintaan.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Objek chat completion dari API ChatGPT.

Contoh berikut menunjukkan cara menggunakan Chat dengan menambahkan file(s) sebagai sumber pesan.

var options = new ChatGptRequestOptions();
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));

// Tambahkan sumber teks PDF.
// Jika terdapat beberapa sumber, teks dari tiap dokumen akan ditambahkan ke koleksi pesan permintaan
// sebagai pesan terpisah dengan peran "user".
options.AddInput(new FileData("TextSource.pdf"));

options.ApiKey = "Your API key."; // Anda harus menyediakan kunci untuk mengakses API.
options.MaxTokens = 1000; // Jumlah token maksimum yang akan dihasilkan dalam chat completion.

// Tambahkan pesan permintaan.
// Dalam kasus ini, pesan sistem dengan Content = "You are a helpful assistant." ditambahkan secara default.
// Peran pesan query secara default adalah "user".
options.Query = "How many letters in the provided text?";

// Proses permintaan.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

var fileResultPath = result.ResultCollection[0].Data;
var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Objek chat completion dari API ChatGPT.

Pengecualian

ArgumentException : Jika opsi tidak diatur.

Merge(MergeOptions)

Menggabungkan dokumen PDF.

public static ResultContainer Merge(MergeOptions options)

Parameter

  • options MergeOptions: Objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Menggabungkan dua dokumen PDF.

// Buat objek MergeOptions untuk mengatur instruksi
var options = new MergeOptions();
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileData("path_to_your_pdf_file_2.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.Merge(options);

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Optimize(OptimizeOptions)

Mengoptimalkan dokumen PDF.
Linearize dokumen agar:

  • membuka halaman pertama secepat mungkin;
  • menampilkan halaman berikutnya atau mengikuti tautan ke halaman selanjutnya secepat mungkin;
  • menampilkan halaman secara bertahap saat data untuk halaman tersebut tiba melalui saluran lambat (menampilkan data paling berguna terlebih dahulu);
  • memungkinkan interaksi pengguna, seperti mengikuti tautan, dilakukan sebelum seluruh halaman diterima dan ditampilkan.
public static ResultContainer Optimize(OptimizeOptions options)

Parameter

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Mengoptimalkan dokumen PDF.

// Buat objek OptimizeOptions untuk mengatur instruksi
var options = new OptimizeOptions();
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.Optimize(options);

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Resize(ResizeOptions)

Mengubah Ukuran Halaman dokumen PDF.

public static ResultContainer Resize(ResizeOptions options)

Parameter

  • options ResizeOptions: Objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Mengubah Ukuran dokumen PDF.

// Buat objek ResizeOptions untuk mengatur instruksi
var options = new ResizeOptions();
// Tentukan ukuran halaman baru
options.PageSize = PageSize.A3;
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.Resize(options);

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Rotate(RotateOptions)

Memutar Halaman dokumen PDF.

public static ResultContainer Rotate(RotateOptions options)

Parameter

  • options RotateOptions: Objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Memutar dokumen PDF.

// Buat objek RotateOptions untuk mengatur instruksi
var options = new RotateOptions();
// Tentukan rotasi baru
options.Rotation = Rotation.On90;
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Lakukan proses
PdfManager.Rotate(options);

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Split(SplitOptions)

Memisahkan dokumen PDF berdasarkan halaman.

public static ResultContainer Split(SplitOptions options)

Parameter

  • options SplitOptions: Objek opsi yang berisi instruksi untuk operasi.

Pengembalian

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh berikut menunjukkan cara Memisahkan dokumen PDF.

// Buat objek SplitOptions untuk mengatur instruksi
var options = new SplitOptions();
// Tambahkan jalur file input
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Tentukan jalur file output
options.AddOutput(new FileData("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_2.pdf"));
// Lakukan proses
PdfManager.Split(options);

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfProperties

Info

Mewakili Properti dan informasi meta dokumen PDF.

public class PdfProperties

Pewarisan

objectPdfProperties

Anggota yang Ditarik

Konstruktor

PdfProperties()

public PdfProperties()

Properti

Application

Mendapatkan atau mengatur Aplikasi PDF.

public string Application { get; set; }

Nilai Properti

string

Author

Mendapatkan atau mengatur Penulis PDF.

public string Author { get; set; }

Nilai Properti

string

Created

Mendapatkan atau mengatur Tanggal Pembuatan PDF.

public DateTime? Created { get; set; }

Nilai Properti

DateTime?

FileName

Mendapatkan atau mengatur Nama Berkas PDF, bila tersedia.

public string FileName { get; set; }

Nilai Properti

string

Keywords

Mendapatkan atau mengatur Kata Kunci PDF.

public string Keywords { get; set; }

Nilai Properti

string

Modified

Mendapatkan atau mengatur Tanggal Modifikasi PDF.

public DateTime? Modified { get; set; }

Nilai Properti

DateTime?

NumberOfPages

Mendapatkan atau mengatur Jumlah Halaman PDF.

public int NumberOfPages { get; set; }

Nilai Properti

int

PdfProducer

Mendapatkan atau mengatur Produsen PDF.

public string PdfProducer { get; set; }

Nilai Properti

string

Subject

Mendapatkan atau mengatur Subjek PDF.

public string Subject { get; set; }

Nilai Properti

string

Title

Mendapatkan atau mengatur Judul PDF.

public string Title { get; set; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class PdfSecurity

Info

Mewakili komponen Documentize.PdfSecurity. Digunakan untuk Mengenkripsi, Mendekripsi, Menandatangani, Menyaring dokumen PDF.

public static class PdfSecurity

Inheritance

objectPdfSecurity

Inherited Members

Methods

Decrypt(DecryptOptions)

Mendekripsi dokumen PDF.

public static ResultContainer Decrypt(DecryptOptions options)

Parameters

  • options DecryptOptions: Sebuah objek opsi yang berisi instruksi untuk operasi ini.

Returns

ResultContainer : Sebuah objek yang berisi hasil operasi.

Examples

Contoh berikut memperlihatkan cara Mendekripsi dokumen PDF.

// Buat objek DecryptOptions untuk mengatur instruksi
var options = new DecryptOptions("123456");
// Tambahkan jalur file masukan
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Atur jalur file keluaran
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Jalankan proses
PdfSecurity.Decrypt(options);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Encrypt(EncryptOptions)

Mengenkripsi dokumen PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parameters

  • options EncryptOptions: Sebuah objek opsi yang berisi instruksi untuk operasi ini.

Returns

ResultContainer : Sebuah objek yang berisi hasil operasi.

Examples

Contoh berikut memperlihatkan cara Mengenkripsi dokumen PDF.

// Buat objek EncryptOptions untuk mengatur instruksi
var options = new EncryptOptions("123456", "qwerty");
// Tambahkan jalur file masukan
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Atur jalur file keluaran
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Jalankan proses
PdfSecurity.Encrypt(options);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Sanitize(SanitizeOptions)

Membersihkan data tersembunyi dari dokumen PDF, memastikan bahwa informasi sensitif atau tidak diperlukan seperti metadata, lampiran, anotasi, JavaScript, formulir, lapisan, indeks pencarian, atau konten pribadi dihapus atau diubah.

public static ResultContainer Sanitize(SanitizeOptions options)

Parameters

  • options SanitizeOptions: Sebuah objek opsi yang berisi instruksi untuk operasi ini.

Returns

ResultContainer : Sebuah objek yang berisi hasil operasi.

Examples

Contoh berikut memperlihatkan cara Menyaring dokumen PDF.

// Buat objek SanitizeOptions untuk mengatur file masukan dan keluaran
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF dari aliran ke aliran.

// Siapkan aliran masukan dan keluaran
using var inputStream = File.OpenRead("path_to_your_pdf_file.pdf");
using var outputStream = new MemoryStream();
// Buat objek SanitizeOptions untuk mengatur aliran masukan dan keluaran
var options = new SanitizeOptions(inputStream, outputStream);
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF dari file ke aliran.

// Siapkan aliran keluaran
using var outputStream = new MemoryStream();
// Buat objek SanitizeOptions untuk mengatur file masukan dan aliran keluaran
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", outputStream);
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF dari file ke aliran dengan mengatur properti masukan dan keluaran secara manual.

// Siapkan aliran keluaran
using var outputStream = new MemoryStream();
// Buat objek SanitizeOptions
var options = new SanitizeOptions();
//Set Input file
options.Input = new FileData("path_to_your_pdf_file.pdf");
//Set Output stream
options.Output = new StreamData(outputStream);
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF tanpa menghapus Metadata.

// Buat objek SanitizeOptions untuk mengatur file masukan dan keluaran
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveMetadata = false;
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF tanpa menghapus Lampiran.

// Buat objek SanitizeOptions untuk mengatur file masukan dan keluaran
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveAttachments = false;
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF dengan mengonversi semua halaman menjadi gambar dan mengatur DPI hasil.

// Buat objek SanitizeOptions untuk mengatur file masukan dan keluaran
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
// Aktifkan konversi dan atur DPI
options.ConvertPagesToImages = true;
options.ImageDpi = 200;
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring PDF tanpa menghapus JavaScript dan Aksi.

// Buat objek SanitizeOptions untuk mengatur file masukan dan keluaran
var options = new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf");
options.RemoveJavaScriptsAndActions = false;
// Jalankan proses
PdfSecurity.Sanitize(options);

Contoh berikut memperlihatkan cara Menyaring file PDF dalam gaya sesingkat mungkin.

PdfSecurity.Sanitize(new SanitizeOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf"));

Exceptions

ArgumentException

Jika opsi tidak diatur.

Sign(SignOptions)

Menandatangani dokumen PDF dengan tanda tangan digital.

public static ResultContainer Sign(SignOptions options)

Parameters

  • options SignOptions: Sebuah objek opsi yang berisi instruksi untuk operasi ini.

Returns

ResultContainer : Sebuah objek yang berisi hasil operasi.

Examples

Contoh berikut memperlihatkan cara Menandatangani dokumen PDF.

// Buat objek SignOptions untuk mengatur instruksi
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Jalankan proses
PdfSecurity.Sign(options);

Contoh berikut memperlihatkan cara Menandatangani dokumen PDF menggunakan aliran.

// Siapkan aliran
using var pdfStreamInput = File.OpenRead(@"path_to_your_pdf_file.pdf");
using var pfxStreamInput = File.OpenRead(@"path_to_your_pfx_file.pfx");
using var pdfStreamOutput = new MemoryStream();
// Buat objek SignOptions untuk mengatur instruksi
var options = new SignOptions(pdfStreamInput, pdfStreamOutput, pfxStreamInput, "password_of_your_pfx_file");
// Jalankan proses
PdfSecurity.Sign(options);

Contoh berikut menunjukkan cara menandatangani dokumen PDF dan mengatur parameter masukan serta keluaran secara terpisah.

// Buat objek SignOptions untuk mengatur instruksi
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Set masukan dan keluaran file
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Jalankan proses
PdfSecurity.Sign(options);

Contoh berikut memperlihatkan cara Menandatangani dokumen PDF dengan aliran PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
// Set masukan dan keluaran file
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Jalankan proses
PdfSecurity.Sign(options);

Contoh berikut memperlihatkan cara Menandatangani dokumen PDF dengan tanda tangan tidak terlihat.

// Buat objek SignOptions untuk mengatur instruksi
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Konfigurasikan tanda tangan tidak terlihat
options.Visible = false;
// Jalankan proses
PdfSecurity.Sign(options);

Contoh berikut memperlihatkan cara Menandatangani dokumen PDF dengan opsi tambahan.

// Buat objek SignOptions untuk mengatur instruksi
var options = new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf","path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// Parameter opsional
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Jalankan proses
PdfSecurity.Sign(options);

Contoh berikut memperlihatkan cara Menandatangani file PDF dalam gaya sesingkat mungkin.

PdfSecurity.Sign(new SignOptions("path_to_your_pdf_file.pdf", "path_to_result_pdf_file.pdf", "path_to_your_pfx_file.pfx", "password_of_your_pfx_file"));

Contoh berikut memperlihatkan cara Menandatangani dokumen PDF dengan Timestamp.

// Buat objek SignOptions untuk mengatur Timestamp
var options = new SignOptions(new TimestampOptions("server_url"));
// Set masukan dan keluaran file
options.Input = new FileData("path_to_your_pdf_file.pdf");
options.Output = new FileData("path_to_result_pdf_file.pdf");
// Jalankan proses
PdfSecurity.Sign(options);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class PdfToDocOptions

Info

Mewakili opsi konverter PDF ke DOC untuk plugin Documentize.PdfConverter.

public sealed class PdfToDocOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object
PluginBaseOptions
PdfToDocOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

PdfToDocOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.PdfToDocOptions dengan opsi default.

public PdfToDocOptions()

Properti

Mode

Memungkinkan mengontrol bagaimana dokumen PDF dikonversi menjadi dokumen pengolah kata.

public DocConversionMode Mode { get; set; }

Nilai Properti

DocConversionMode

Catatan

Gunakan mode Documentize.DocConversionMode.TextBox ketika dokumen yang dihasilkan tidak akan banyak diedit lagi. Textbox mudah dimodifikasi ketika tidak banyak yang harus diubah.

Gunakan mode Documentize.DocConversionMode.Flow ketika dokumen keluaran membutuhkan penyuntingan lanjutan. Paragraf dan baris teks dalam mode flow memungkinkan modifikasi teks yang mudah, tetapi objek pemformatan yang tidak didukung akan terlihat lebih buruk dibandingkan dengan mode Documentize.DocConversionMode.TextBox.

Ruang Nama: Documentize
Assembly: Documentize.dll

Class PdfToHtmlOptions

Info

Mewakili opsi konverter PDF ke HTML untuk plugin Documentize.PdfConverter.

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsPdfToHtmlOptions

Mengimplementasikan

Anggota yang Dwarisi

Konstruktor

PdfToHtmlOptions(SaveDataType)

Menginisialisasi instance baru dari objek Documentize.PdfToHtmlOptions untuk tipe data output yang ditentukan.

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType = SaveDataType.FileWithExternalResources)

Parameter

Properti

OutputDataType

Mendapatkan tipe data output.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }

Nilai Properti

PdfToHtmlOptions.SaveDataType

Namespace: Documentize Assembly: Documentize.dll

Class PdfToJpegOptions

Info

Mewakili opsi konverter PDF ke JPEG untuk plugin Documentize.PdfConverter.

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsPdfToJpegOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

PdfToJpegOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.PdfToJpegOptions.

public PdfToJpegOptions()

Properti

OutputResolution

Mendapatkan atau menetapkan nilai resolusi gambar yang dihasilkan.

public int OutputResolution { get; set; }

Nilai Properti

int

PageList

Mendapatkan atau menetapkan daftar halaman untuk proses.

public List<int> PageList { get; set; }

Nilai Properti

List<int>

Quality

Mendapatkan dan menetapkan kualitas output.
Menentukan tingkat kompresi untuk sebuah gambar.
Rentang nilai yang berguna untuk kualitas adalah dari 0 hingga 100.
Semakin rendah angka yang ditentukan, semakin tinggi kompresi dan akibatnya kualitas gambar menjadi lebih rendah.
Angka 0 akan menghasilkan gambar dengan kualitas terendah dan 100 kualitas tertinggi.

public int Quality { get; set; }

Nilai Properti

int

Namespace: Documentize Assembly: Documentize.dll

Class PdfToPdfAOptions

Info

Mewakili opsi untuk mengonversi dokumen PDF ke format PDF/A dengan plugin Documentize.PdfConverter.

public sealed class PdfToPdfAOptions : PdfAOptionsBase, IPluginOptions

Inheritance

objectPdfAOptionsBasePdfToPdfAOptions

Implements

Inherited Members

Constructors

PdfToPdfAOptions()

public PdfToPdfAOptions()

Properties

Outputs

Mendapatkan koleksi target yang ditambahkan (sumber data file atau aliran) untuk menyimpan hasil operasi.

public List<IData> Outputs { get; }

Property Value

List<IData>

Methods

AddOutput(IData)

Menambahkan target penyimpanan hasil baru.

public void AddOutput(IData data)

Parameters

  • data IData: Target (sumber data file atau aliran) untuk menyimpan hasil operasi.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfToPngOptions

Info

Mewakili opsi konverter PDF ke PNG untuk plugin Documentize.PdfConverter.

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsPdfToPngOptions

Mengimplementasikan

Anggota yang diwariskan

Konstruktor

PdfToPngOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToPngOptions.

public PdfToPngOptions()

Properti

OutputResolution

Mendapatkan atau menetapkan nilai resolusi gambar yang dihasilkan.

public int OutputResolution { get; set; }

Nilai Properti

int

PageList

Mendapatkan atau menetapkan daftar halaman untuk proses.

public List<int> PageList { get; set; }

Nilai Properti

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToTiffOptions

Info

Mewakili opsi konverter PDF ke TIFF untuk plugin Documentize.PdfConverter.

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsPdfToTiffOptions

Mengimplementasikan

Anggota yang Diteruskan

Konstruktor

PdfToTiffOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

Properti

ColorDepth

Mendapatkan atau menetapkan kedalaman warna.

public TiffColorDepth ColorDepth { get; set; }

Nilai Properti

TiffColorDepth

Keterangan

Nilai default adalah Documentize.TiffColorDepth.Format32bpp.

Compression

Mendapatkan atau menetapkan tipe kompresi.

public TiffCompression Compression { get; set; }

Nilai Properti

TiffCompression

Keterangan

Nilai default adalah Documentize.TiffCompression.LZW.

MultiPage

Mendapatkan dan menetapkan flag yang memungkinkan menyimpan semua halaman dalam satu file TIFF multi‑halaman.

Nilai default adalah false.
public bool MultiPage { get; set; }

Nilai Properti

bool

OutputResolution

Mendapatkan atau menetapkan nilai resolusi gambar yang dihasilkan.

public int OutputResolution { get; set; }

Nilai Properti

int

PageList

Mendapatkan atau menetapkan daftar halaman untuk proses.

public List<int> PageList { get; set; }

Nilai Properti

List<int>

Namespace: Documentize Assembly: Documentize.dll

Class PdfToXlsOptions

Info

Mewakili opsi konverter PDF ke XLS/XLSX untuk plugin Documentize.PdfConverter.

public sealed class PdfToXlsOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsPdfToXlsOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

PdfToXlsOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.PdfToXlsOptions dengan opsi default.

public PdfToXlsOptions()

Properti

Format

Format keluaran.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Nilai Properti

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Atur true jika Anda memerlukan penyisipan kolom kosong sebagai kolom pertama pada lembar kerja.
Nilai default adalah false; artinya kolom kosong tidak akan disisipkan.

public bool InsertBlankColumnAtFirst { get; set; }

Nilai Properti

bool

MinimizeTheNumberOfWorksheets

Atur true jika Anda perlu meminimalkan jumlah lembar kerja dalam workbook hasil.
Nilai default adalah false; artinya setiap halaman PDF disimpan sebagai lembar kerja terpisah.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Nilai Properti

bool

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Info

Mewakili opsi dasar untuk komponen.

public class PluginBaseOptions : IPluginOptions

Pewarisan

objectPluginBaseOptions

Turunan

Mengimplementasikan

Anggota yang Ditarik

Properti

CloseInputStreams

Menutup aliran input setelah operasi selesai.

public bool CloseInputStreams { get; set; }

Nilai Properti

bool

CloseOutputStreams

Menutup aliran output setelah operasi selesai.

public bool CloseOutputStreams { get; set; }

Nilai Properti

bool

Inputs

Mengembalikan data Input untuk operasi.

public List<idata> Inputs { get; }

Nilai Properti

List<IData>

Outputs

Mengembalikan data Output untuk operasi.

public List<idata> Outputs { get; }

Nilai Properti

List<IData>

Metode

AddInput(IData)

Menambahkan Data baru ke Input.

public void AddInput(IData data)

Parameter

  • data IData: Data yang akan ditambahkan.

AddOutput(IData)

Menambahkan Data baru ke Output.

public void AddOutput(IData data)

Parameter

  • data IData: Data yang akan ditambahkan.

Namespace: Documentize Assembly: Documentize.dll

Class PngConverter

Info

Mewakili plugin Documentize.PngConverter. Digunakan untuk mengonversi dokumen PDF ke format PNG.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class PngConverter

Pewarisan

objectPngConverter

Anggota yang Ditarik

Metode

Process(PdfToPngOptions)

Mengonversi dokumen PDF ke format PNG.

public static ResultContainer Process(PdfToPngOptions options)

Parameter

  • options PdfToPngOptions: Objek opsi yang berisi instruksi untuk operasi ini.

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

Info

Kelas mewakili persegi panjang.

public class Rectangle

Pewarisan

objectRectangle

Anggota yang Diwarisi

Konstruktor

Rectangle(double, double, double, double)

Konstruktor dari Rectangle.

public Rectangle(double llx, double lly, double urx, double ury)

Parameter

  • llx double: X sudut kiri bawah.
  • lly double: Y sudut kiri bawah.
  • urx double: X sudut kanan atas.
  • ury double: Y sudut kanan atas.

Namespace: Documentize Assembly: Documentize.dll

Class RemoveFieldsOptions

Info

Mewakili opsi untuk Remove Fields dalam dokumen oleh plugin Documentize.PdfForm.

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object
PluginBaseOptions
RemoveFieldsOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

RemoveFieldsOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.RemoveFieldsOptions dengan opsi default.

public RemoveFieldsOptions()

Namespace: Documentize
Assembly: Documentize.dll

Class ResizeOptions

Info

Mewakili opsi Resize untuk plugin Documentize.PdfManager.

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsResizeOptions

Mengimplementasikan

Anggota yang Diturunkan

Konstruktor

ResizeOptions()

Menginisialisasi instance baru dari objek Documentize.ResizeOptions dengan opsi default.

public ResizeOptions()

Properti

PageSize

Mendapatkan atau mengatur ukuran halaman baru.

public PageSize PageSize { get; set; }

Nilai Properti

PageSize

Namespace: Documentize
Assembly: Documentize.dll

Class ResultContainer

Info

Mewakili kontainer yang berisi koleksi hasil dari pemrosesan plugin.

public class ResultContainer

Pewarisan

objectResultContainer

Anggota yang Diwariskan

Properti

ResultCollection

Mendapatkan koleksi hasil operasi

public List<IOperationResult> ResultCollection { get; }

Nilai Properti

List<IOperationResult>

Namespace: Documentize
Assembly: Documentize.dll

Class RotateOptions

Info

Mewakili opsi Rotasi untuk plugin Documentize.PdfManager.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsRotateOptions

Mengimplementasikan

Anggota yang Dwarisi

Konstruktor

RotateOptions()

Menginisialisasi instance baru dari objek Documentize.RotateOptions dengan opsi default.

public RotateOptions()

Properti

Rotation

Mendapatkan atau mengatur rotasi halaman baru.

public Rotation Rotation { get; set; }

Nilai Properti

Rotation

Namespace: Documentize
Assembly: Documentize.dll

Class SanitizeOptions

Info

Mewakili opsi konfigurasi untuk membersihkan data tersembunyi dalam sebuah dokumen.

public class SanitizeOptions : OptionsWithInputAndOutput, IHaveInput

Inheritance

objectOptionsWithInputOptionsWithInputAndOutputSanitizeOptions

Implements

Inherited Members

Constructors

SanitizeOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.SanitizeOptions dengan opsi default.

public SanitizeOptions()

SanitizeOptions(IData, IData)

Menginisialisasi sebuah instance baru dari objek Documentize.SanitizeOptions dengan data input yang ditentukan.

public SanitizeOptions(IData inputData, IData outputData = null)

Parameters

  • inputData IData: Data input.
  • outputData IData: Data output.

SanitizeOptions(string, string)

Menginisialisasi sebuah instance baru dari objek Documentize.SanitizeOptions dengan file input dan output yang ditentukan.

public SanitizeOptions(string inputFile, string outputFile)

Parameters

  • inputFile string: Jalur file input.
  • outputFile string: Jalur file output.

SanitizeOptions(Stream, Stream)

Menginisialisasi sebuah instance baru dari objek Documentize.SanitizeOptions dengan aliran input dan output yang ditentukan.

public SanitizeOptions(Stream inputStream, Stream outputStream)

Parameters

  • inputStream Stream: Aliran input.
  • outputStream Stream: Aliran output.

SanitizeOptions(string, Stream)

Menginisialisasi sebuah instance baru dari objek Documentize.SanitizeOptions dengan file input dan aliran output yang ditentukan.

public SanitizeOptions(string inputFile, Stream outputStream)

Parameters

  • inputFile string: Jalur file input.
  • outputStream Stream: Aliran output.

SanitizeOptions(Stream, string)

Menginisialisasi sebuah instance baru dari objek Documentize.SanitizeOptions dengan aliran input dan file output yang ditentukan.

public SanitizeOptions(Stream inputStream, string outputFile)

Parameters

  • inputStream Stream: Aliran input.
  • outputFile string: Jalur file output.

Properties

ConvertPagesToImages

Mendapatkan atau mengatur opsi untuk mengonversi halaman menjadi gambar.
Konversi halaman ke gambar akan dilakukan setelah membersihkan data tersembunyi utama, yang dikendalikan oleh opsi lain.
Defaultnya adalah false.

public bool ConvertPagesToImages { get; set; }

Property Value

bool

FlattenForms

Mendapatkan atau mengatur nilai yang menunjukkan apakah formulir dalam dokumen harus diratakan selama proses sanitasi.
Meratakan formulir mengubah bidang formulir interaktif menjadi konten statis, sehingga tidak dapat diedit atau diisi.
Defaultnya adalah true.

public bool FlattenForms { get; set; }

Property Value

bool

FlattenLayers

Mendapatkan atau mengatur opsi untuk meratakan lapisan‑lapisan dalam dokumen PDF.
Jika diaktifkan, semua lapisan dalam dokumen digabungkan menjadi satu lapisan, menghilangkan struktur terpisahnya.
Opsi ini berguna untuk menyederhanakan konten dokumen dan memastikan tidak ada data tersembunyi di dalam lapisan.
Defaultnya adalah true.

public bool FlattenLayers { get; set; }

Property Value

bool

ImageDpi

Mendapatkan atau mengatur opsi untuk menentukan DPI gambar halaman selama konversi halaman ke gambar.
Properti ini berfungsi jika properti Documentize.SanitizeOptions.ConvertPagesToImages bernilai true.

public int ImageDpi { get; set; }

Property Value

int

Input

Mendapatkan atau mengatur Data Input.

public override IData Input { get; set; }

Property Value

IData

Output

Mendapatkan atau mengatur Data Output.

public override IData Output { get; set; }

Property Value

IData

RemoveAnnotations

Mendapatkan atau mengatur nilai yang menunjukkan apakah anotasi harus dihapus dari dokumen.
Jika diaktifkan, semua anotasi yang ada dalam dokumen akan dihapus selama proses sanitasi. Anotasi redaksi akan diterapkan.
Defaultnya adalah true.

public bool RemoveAnnotations { get; set; }

Property Value

bool

RemoveAttachments

Mendapatkan atau mengatur opsi untuk menghapus semua file terlampir dari dokumen.
Jika diaktifkan, akan memastikan bahwa semua lampiran dalam PDF dihilangkan selama proses sanitasi.
Defaultnya adalah true.

public bool RemoveAttachments { get; set; }

Property Value

bool

RemoveJavaScriptsAndActions

Mendapatkan atau mengatur nilai yang menunjukkan apakah JavaScript dan aksi terkait harus dihapus dari dokumen.
Opsi ini berguna untuk menghilangkan potensi kerentanan keamanan yang disebabkan oleh skrip yang disematkan.
Defaultnya adalah true.

public bool RemoveJavaScriptsAndActions { get; set; }

Property Value

bool

RemoveMetadata

Mendapatkan atau mengatur opsi untuk menghapus metadata dari dokumen.
Jika diset ke true, metadata seperti properti dokumen dan informasi metadata tersemat tambahan akan dihapus selama sanitasi.
Defaultnya adalah true.

public bool RemoveMetadata { get; set; }

Property Value

bool

RemoveSearchIndexAndPrivateInfo

Mendapatkan atau mengatur nilai yang menunjukkan apakah indeks pencarian dan informasi pribadi harus dihapus dari dokumen.
Mengaktifkan penghapusan indeks pencarian tersemat dan data pribadi untuk meningkatkan keamanan dan privasi dokumen.
Defaultnya adalah true.

public bool RemoveSearchIndexAndPrivateInfo { get; set; }

Property Value

bool

Namespace: Documentize
Assembly: Documentize.dll

Class Security

Info

Mewakili plugin Documentize.Security. Digunakan untuk mengenkripsi dan mendekripsi dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
public static class Security

Pewarisan

objectSecurity

Anggota yang Diwarisi

Metode

Process(EncryptOptions)

Mengenkripsi Dokumen PDF.

public static ResultContainer Process(EncryptOptions options)

Parameter

  • options EncryptOptions: Objek opsi yang berisi instruksi untuk operasi tersebut.

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Process(DecryptOptions)

Mendekripsi Dokumen PDF.

public static ResultContainer Process(DecryptOptions options)

Parameter

  • options DecryptOptions: Objek opsi yang berisi instruksi untuk operasi tersebut.

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class Signature

Info

Mewakili plugin Documentize.Signature. Digunakan untuk menandatangani dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
public static class Signature

Pewarisan

objectSignature

Anggota yang Dwariskan

Metode

Process(SignOptions)

Menandatangani dokumen PDF.

public static ResultContainer Process(SignOptions options)

Parameter

  • options SignOptions: Objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Info

Mewakili Opsi Tanda Tangan untuk komponen Documentize.PdfSecurity.

public sealed class SignOptions : OptionsWithInputAndOutput, IHaveInput

Pewarisan

objectOptionsWithInputOptionsWithInputAndOutputSignOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

SignOptions(Stream, string)

Menginisialisasi instance baru dari objek Documentize.SignOptions dengan menetapkan aliran pfx dan kata sandi.

public SignOptions(Stream pfx, string password)

Parameter

  • pfx Stream: Aliran yang berisi file pfx.
  • password string: Kata sandi untuk file pfx.

SignOptions(string, string)

Menginisialisasi instance baru dari objek Documentize.SignOptions dengan menetapkan file pfx dan kata sandi.

public SignOptions(string pfx, string password)

Parameter

  • pfx string: Jalur ke file pfx.
  • password string: Kata sandi untuk file pfx.

SignOptions(IData, IData, IData, string)

Menginisialisasi instance baru dari objek Documentize.SignOptions dengan menetapkan data masukan, keluaran, pfx, dan kata sandi.

public SignOptions(IData inputData, IData outputData, IData pfxData, string password)

Parameter

  • inputData IData: Data masukan.
  • outputData IData: Data keluaran.
  • pfxData IData: Data pfx.
  • password string: Kata sandi untuk pfx.

SignOptions(string, string, string, string)

Menginisialisasi instance baru dari objek Documentize.SignOptions dengan menetapkan file masukan, keluaran, pfx, dan kata sandi.

public SignOptions(string inputFile, string outputFile, string pfxFile, string pfxPassword)

Parameter

  • inputFile string: Jalur file masukan.
  • outputFile string: Jalur file keluaran.
  • pfxFile string: Jalur ke file pfx.
  • pfxPassword string: Kata sandi untuk pfx.

SignOptions(Stream, Stream, Stream, string)

Menginisialisasi instance baru dari objek Documentize.SignOptions dengan menetapkan aliran masukan, keluaran, pfx, dan kata sandi.

public SignOptions(Stream inputStream, Stream outputStream, Stream pfxStream, string pfxPassword)

Parameter

  • inputStream Stream: Aliran file masukan.
  • outputStream Stream: Aliran file keluaran.
  • pfxStream Stream: Aliran pfx.
  • pfxPassword string: Kata sandi untuk pfx.

SignOptions(TimestampOptions)

Menginisialisasi instance baru dari objek Documentize.SignOptions dengan menetapkan Timestamp. Anda dapat menambahkan timestamp pada dokumen sebagai tanda tangan terpisah.

public SignOptions(TimestampOptions timestampOptions)

Parameter

  • timestampOptions TimestampOptions: Timestamp yang digunakan untuk membuat tanda tangan timestamp tanpa harus menyediakan sertifikat.

Properti

Contact

Kontak tanda tangan.

public string Contact { get; set; }

Nilai Properti

string

Input

Mendapatkan atau menetapkan Data Masukan.

public override IData Input { get; set; }

Nilai Properti

IData

Location

Lokasi tanda tangan.

public string Location { get; set; }

Nilai Properti

string

Name

Nama bidang tanda tangan yang sudah ada. null untuk membuat bidang baru.

public string Name { get; set; }

Nilai Properti

string

Output

Mendapatkan atau menetapkan Data Keluaran.

public override IData Output { get; set; }

Nilai Properti

IData

PageNumber

Nomor halaman tempat tanda tangan dibuat.

public int PageNumber { get; set; }

Nilai Properti

int

Pfx

Aliran yang berisi data PFX.

public Stream Pfx { get; set; }

Nilai Properti

Stream

PfxPassword

Kata sandi untuk Documentize.SignOptions.Pfx.

public string PfxPassword { get; set; }

Nilai Properti

string

Reason

Alasan tanda tangan.

public string Reason { get; set; }

Nilai Properti

string

Rectangle

Ukuran persegi panjang tanda tangan.

public Rectangle Rectangle { get; set; }

Nilai Properti

Rectangle

TimestampOptions

Opsi Timestamp. Timestamp digunakan untuk membuat tanda tangan timestamp tanpa perlu menyediakan sertifikat.
Jika properti ini diatur dan sertifikat diberikan ke konstruktor kelas Documentize.SignOptions, tanda tangan digital akan dicap waktu dengan timestamp tersemat.
Jika properti ini diatur namun tidak ada sertifikat yang diberikan ke konstruktor, timestamp akan ditambahkan sebagai tanda tangan terpisah.

public TimestampOptions TimestampOptions { get; set; }

Nilai Properti

TimestampOptions

Visible

Visibilitas tanda tangan. Nilai default adalah true.

public bool Visible { get; set; }

Nilai Properti

bool

Namespace: Documentize
Assembly: Documentize.dll

Class SplitOptions

Info

Mewakili opsi Split untuk plugin Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsSplitOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

SplitOptions()

Menginisialisasi instance baru dari objek Documentize.SplitOptions dengan opsi default.

public SplitOptions()

Namespace: Documentize
Assembly: Documentize.dll

Class Splitter

Info

Mewakili plugin Documentize.Splitter. Digunakan untuk Membagi dokumen PDF menjadi halaman terpisah.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class Splitter

Warisan

objectSplitter

Anggota yang Diwarisi

Metode

Process(SplitOptions)

Membagi dokumen PDF per halaman.

public static ResultContainer Process(SplitOptions options)

Parameter

  • options SplitOptions: Sebuah objek opsi yang berisi instruksi untuk operasi tersebut.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi tersebut.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Ruang Nama: Documentize Assembly: Documentize.dll

Class StreamData

Info

Mewakili data aliran untuk operasi memuat dan menyimpan.

public sealed class StreamData : IData

Warisan

objectStreamData

Mengimplementasikan

Anggota yang Diteruskan

Konstruktor

StreamData(Stream)

Menginisialisasi sumber data aliran baru dengan objek aliran yang ditentukan.

public StreamData(Stream data)

Parameter

Properti

Data

Mendapatkan objek aliran dari sumber data saat ini.

public Stream Data { get; }

Nilai Properti

Stream

DataType

Tipe data (aliran).

public DataType DataType { get; }

Nilai Properti

DataType

Namespace: Documentize
Assembly: Documentize.dll

Class StreamDataSource

Info

Mewakili sumber data stream untuk operasi load dan save dari sebuah plugin.

public sealed class StreamDataSource : IDataSource

Inheritance

objectStreamDataSource

Implements

Inherited Members

Constructors

StreamDataSource(Stream)

Menginisialisasi sumber data stream baru dengan objek stream yang ditentukan.

public StreamDataSource(Stream data)

Parameters

Properties

Data

Mendapatkan objek stream dari sumber data saat ini.

public Stream Data { get; }

Property Value

Stream

DataType

Jenis sumber data (stream).

public DataType DataType { get; }

Property Value

DataType

Namespace: Documentize Assembly: Documentize.dll

Class StreamResult

Info

Mewakili hasil operasi dalam bentuk Stream.

public sealed class StreamResult : IOperationResult

Pewarisan

objectStreamResult

Mengimplementasikan

Anggota yang Diwarisi

Properti

Data

Mendapatkan data mentah.

public object Data { get; }

Nilai Properti

object

IsFile

Menunjukkan apakah hasil adalah path ke file keluaran.

public bool IsFile { get; }

Nilai Properti

bool

IsStream

Menunjukkan apakah hasil adalah stream.

public bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasil adalah string.

public bool IsString { get; }

Nilai Properti

bool

Metode

ToFile()

Mencoba mengubah hasil menjadi sebuah file.

public string ToFile()

Mengembalikan

string : String yang mewakili path ke file keluaran jika hasilnya berupa file; jika tidak null.

ToStream()

Mencoba mengubah hasil menjadi objek stream.

public Stream ToStream()

Mengembalikan

Stream : Objek stream yang mewakili data keluaran jika hasilnya berupa stream; jika tidak null.

Namespace: Documentize Assembly: Documentize.dll

Class StringResult

Info

Mewakili hasil operasi dalam bentuk string.

public sealed class StringResult : IOperationResult

Inheritance

objectStringResult

Implements

Inherited Members

Properties

Data

Mendapatkan data mentah.

public object Data { get; }

Property Value

object

IsFile

Menunjukkan apakah hasilnya berupa path ke file output.

public bool IsFile { get; }

Property Value

bool

IsStream

Menunjukkan apakah hasilnya berupa stream.

public bool IsStream { get; }

Property Value

bool

IsString

Menunjukkan apakah hasilnya berupa string.

public bool IsString { get; }

Property Value

bool

Text

Mengembalikan representasi string dari hasil.

public string Text { get; }

Property Value

string

Methods

ToFile()

Mencoba mengonversi hasil menjadi file.

public string ToFile()

Returns

string : String yang mewakili path ke file output jika hasilnya berupa file; jika tidak null.

ToStream()

Mencoba mengonversi hasil menjadi objek stream.

public Stream ToStream()

Returns

Stream : Objek stream yang mewakili data output jika hasilnya berupa stream; jika tidak null.

ToString()

Mencoba mengonversi hasil menjadi string.

public override string ToString()

Returns

string : String yang mewakili konten teks jika hasilnya berupa string; jika tidak, mengembalikan base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Info

Kelas merepresentasikan builder untuk tabel di halaman pdf.

public class TableBuilder

Warisan

objectTableBuilder

Turunan

Anggota yang Ditarik

Metode

AddRow()

Tambahkan baris baru ke tabel.

public virtual TableRowBuilder AddRow()

Mengembalikan

TableRowBuilder : Instance dari Documentize.TableRowBuilder saat ini.

AddTable()

Tambahkan tabel baru ke dokumen.

public TableBuilder AddTable()

Mengembalikan

TableBuilder : Instance dari Documentize.TableBuilder saat ini.

InsertPageAfter(int)

Sisipkan halaman setelah halaman yang ditentukan.

public TableOptions InsertPageAfter(int page)

Parameter

  • page int: Nomor halaman untuk menyisipkan tabel setelahnya.

Mengembalikan

TableOptions : Instance dari Documentize.TableOptions saat ini.

InsertPageBefore(int)

Sisipkan halaman sebelum halaman yang ditentukan.

public TableOptions InsertPageBefore(int page)

Parameter

  • page int: Nomor halaman untuk menyisipkan tabel setelahnya.

Mengembalikan

TableOptions : Instance dari Documentize.TableOptions saat ini.

Operator

operator implisit TableOptions(TableBuilder)

Mengonversi builder Documentize.TableBuilder menjadi opsi Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

Parameter

  • builder TableBuilder: Instance dari Documentize.TableBuilder saat ini.

Mengembalikan

TableOptions : Hasil konversi ke PdfGeneratorTableOptions.

Namespace: Documentize Assembly: Documentize.dll

Class TableCellBuilder

Info

Kelas mewakili pembuat untuk sel tabel.

public class TableCellBuilder : TableRowBuilder

Pewarisan

objectTableBuilderTableRowBuilderTableCellBuilder

Anggota yang Ditarik

Metode

AddCell()

Menambahkan sel ke tabel.

public override TableCellBuilder AddCell()

Mengembalikan

TableCellBuilder : Instance of current Documentize.TableCellBuilder.

AddParagraph(params string[])

Menambahkan paragraf ke sel tabel.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Parameter

  • paragraphs string[]: Teks untuk Paragraf.

Mengembalikan

TableCellBuilder : Instance of current Documentize.TableCellBuilder.

Namespace: Documentize
Assembly: Documentize.dll

Class TableGenerator

Info

Mewakili plugin Documentize.TableGenerator. Digunakan untuk menambahkan tabel ke dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class TableGenerator

Inheritance

objectTableGenerator

Inherited Members

Examples

Contoh ini menunjukkan cara menambahkan tabel ke file PDF.

// Configure table options
var options = new TableOptions().InsertPageBefore(1)
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age")
        .AddRow()
            .AddCell().AddParagraph("Bob")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Sam")
            .AddCell().AddParagraph("20")
        .AddRow()
            .AddCell().AddParagraph("Sandy")
            .AddCell().AddParagraph("26")
        .AddRow()
            .AddCell().AddParagraph("Tom")
            .AddCell().AddParagraph("12")
        .AddRow()
            .AddCell().AddParagraph("Jim")
            .AddCell().AddParagraph("27");
// Add input file path
options.AddInput(new FileData("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_output.pdf"));
// Perform the process
TableGenerator.Process(options);

Methods

Process(TableOptions)

Menambahkan tabel ke dokumen PDF.

public static ResultContainer Process(TableOptions options)

Parameters

  • options TableOptions: Objek opsi yang berisi instruksi untuk operasi tersebut.

Returns

ResultContainer : Objek yang berisi hasil operasi.

Exceptions

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class TableOptions

Info

Mewakili opsi untuk menambahkan tabel ke dokumen dengan plugin Documentize.PdfManager.

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsTableOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

TableOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.TableOptions dengan opsi default.

public TableOptions()

Metode

AddTable()

Menambahkan tabel ke dokumen.

public TableBuilder AddTable()

Mengembalikan

TableBuilder : Instansi baru dari Documentize.TableBuilder.

Create()

Membuat instance dari Documentize.TableOptions.

public static TableOptions Create()

Mengembalikan

TableOptions : Instansi baru dari Documentize.TableOptions.

InsertPageAfter(int)

Menyisipkan halaman setelah halaman yang ditentukan.

public TableOptions InsertPageAfter(int page)

Parameter

  • page int: Nomor halaman untuk menyisipkan tabel setelahnya.

Mengembalikan

TableOptions : Instansi dari Documentize.TableOptions saat ini.

InsertPageBefore(int)

Menyisipkan halaman sebelum halaman yang ditentukan.

public TableOptions InsertPageBefore(int page)

Parameter

  • page int: Nomor halaman untuk menyisipkan tabel sebelum halaman tersebut.

Mengembalikan

TableOptions : Instansi dari Documentize.TableOptions saat ini.

Namespace: Documentize
Assembly: Documentize.dll

Class TableRowBuilder

Info

Kelas mewakili pembuat baris tabel.

public class TableRowBuilder : TableBuilder

Pewarisan

objectTableBuilderTableRowBuilder

Turunan

Anggota yang Diwariskan

Metode

AddCell()

Menambahkan sel ke baris tabel.

public virtual TableCellBuilder AddCell()

Mengembalikan

TableCellBuilder : Instansi dari Documentize.TableCellBuilder yang dibuat.

AddRow()

Menimpa AddRow.

public override TableRowBuilder AddRow()

Mengembalikan

TableRowBuilder : Instansi dari Documentize.TableRowBuilder saat ini.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractor

Info

Mewakili komponen Documentize.TextExtractor. Digunakan untuk mengekstrak teks dari dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfExtractor class.")]
public static class TextExtractor

Inheritance

objectTextExtractor

Inherited Members

Methods

Process(ExtractTextOptions)

Mengekstrak teks dari dokumen PDF.

public static string Process(ExtractTextOptions options)

Parameters

  • options ExtractTextOptions: Sebuah objek opsi yang berisi instruksi untuk operasi tersebut.

Returns

string : Sebuah objek yang berisi hasil ekstraksi.

Exceptions

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractorOptions

Info

Mewakili opsi ekstraksi teks untuk plugin Documentize.TextExtractor.

public sealed class TextExtractorOptions

Pewarisan

objectTextExtractorOptions

Anggota Yang Dwarisi

Konstruktor

TextExtractorOptions(TextFormattingMode)

Menginisialisasi instance baru dari objek Documentize.TextExtractorOptions untuk mode formatting teks yang ditentukan.

public TextExtractorOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameter

Properti

FormattingMode

Mendapatkan mode formatting.

public TextFormattingMode FormattingMode { get; set; }

Nilai Properti

TextFormattingMode

Inputs

Mengembalikan data Inputs untuk operasi.

public List<idatasource> Inputs { get; }

Nilai Properti

List<IDataSource>

Metode

AddInput(IDataSource)

Menambahkan Data baru ke Inputs.

public void AddInput(IDataSource dataSource)

Parameter

  • dataSource IDataSource: Sumber data yang akan ditambahkan. :

Namespace: Documentize Assembly: Documentize.dll

Class Timestamp

Info

Mewakili plugin Documentize.Timestamp. Digunakan untuk menambahkan Timestamp ke dalam dokumen.

[Obsolete("The class will be deleted soon. Please use PdfSecurity class.")]
public static class Timestamp

Pewarisan

objectTimestamp

Anggota yang Dwarisi

Metode

Process(AddTimestampOptions)

Memulai proses Documentize.Timestamp dengan parameter yang ditentukan.

public static ResultContainer Process(AddTimestampOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class TimestampOptions

public class TimestampOptions

Pewarisan

objectTimestampOptions

Anggota yang Dwarisi

Konstruktor

TimestampOptions(string, string)

Menginisialisasi instance baru dari kelas Documentize.TimestampOptions.

public TimestampOptions(string serverUrl, string basicAuthCredentials = "")

Parameter

  • serverUrl string: URL server timestamp.
  • basicAuthCredentials string: Kredensial otentikasi dasar, nama pengguna dan kata sandi digabungkan menjadi string “username:password”.

Properti

BasicAuthCredentials

Mendapatkan/menetapkan kredensial otentikasi dasar, Nama Pengguna dan kata sandi digabungkan menjadi string “username:password”.

public string BasicAuthCredentials { get; set; }

Nilai Properti

string

ServerUrl

Mendapatkan/menetapkan URL server timestamp.

public string ServerUrl { get; set; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class TocGenerator

Info

Mewakili plugin Documentize.TocGenerator. Digunakan untuk menambahkan Daftar Isi ke dokumen PDF.

[Obsolete("The class will be deleted soon. Please use PdfManager class.")]
public static class TocGenerator

Inheritance

objectTocGenerator

Inherited Members

Examples

Contoh ini menunjukkan cara menambahkan Daftar Isi ke file PDF.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2));
options.Headings.Add(new TocHeading("Chapter I", 3));
options.Headings.Add(new TocHeading("Chapter II", 4));
options.Headings.Add(new TocHeading("Chapter III", 5));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

Contoh ini menunjukkan cara menambahkan Daftar Isi ke file PDF dengan menghasilkan bookmark.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Generate links in bookmarks
options.GenerateBookmarks = true;
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
options.Headings.Add(new TocHeading("Chapter I", 3, true, 1));
options.Headings.Add(new TocHeading("Chapter II", 4, true, 1));
options.Headings.Add(new TocHeading("Example A", 4, true, 2));
options.Headings.Add(new TocHeading("Example B", 4, true, 2));
options.Headings.Add(new TocHeading("Example C", 4, true, 2));
options.Headings.Add(new TocHeading("Example D", 4, true, 2));
options.Headings.Add(new TocHeading("Chapter III", 5, true, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
TocGenerator.Process(options);

Contoh ini menunjukkan cara menambahkan Daftar Isi ke file PDF dan menyimpannya sebagai stream.

// Create TocOptions object to set instructions
var options = new TocOptions();
// Set the Title
options.Title = "My Table of Contents";
// Design Headings
options.Headings.Add(new TocHeading("Introduction", 2, false, 1));
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output stream 
var outputStream = new MemoryStream();
options.AddOutput(new StreamData(outputStream));
options.CloseOutputStreams = false;
// Perform the process
TocGenerator.Process(options);

Methods

Process(TocOptions)

Memulai pemrosesan Documentize.TocGenerator dengan parameter yang ditentukan.

public static ResultContainer Process(TocOptions options)

Parameters

  • options TocOptions: Objek opsi yang berisi instruksi untuk operasi.

Returns

ResultContainer : Objek Documentize.ResultContainer yang berisi hasil dari operasi.

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

Info

Mewakili opsi untuk Heading atau Judul dari Daftar Isi yang didokumentasikan oleh plugin Documentize.PdfManager.

public class TocHeading

Inheritance

objectTocHeading

Inherited Members

Constructors

TocHeading(string, int, bool, int)

Menginisialisasi sebuah instance baru dari Documentize.TocHeading.

public TocHeading(string text = "", int pageNumber = 1, bool generateNumbering = false, int level = 1)

Parameters

  • text string: Teks dari Heading.
  • pageNumber int: Nomor halaman untuk tautan.
  • generateNumbering bool: Menggunakan pembuatan nomor.
  • level int: Tingkatnya.

Properties

GenerateNumbering

Menggunakan pembuatan nomor.
Jika true, penomoran akan dilakukan secara otomatis; jika tidak, penomoran harus dilakukan secara manual.

public bool GenerateNumbering { get; set; }

Property Value

bool

Level

Tingkatnya.
Digunakan untuk pembuatan nomor.

public int Level { get; set; }

Property Value

int

PageNumber

Nomor halaman untuk tautan.

public int PageNumber { get; set; }

Property Value

int

Text

Teks dari Judul.

public string Text { get; set; }

Property Value

string

Namespace: Documentize Assembly: Documentize.dll

Class TocOptions

Info

Mewakili opsi untuk menambahkan Daftar Isi ke dokumen menggunakan plugin Documentize.PdfManager.

public sealed class TocOptions : PluginBaseOptions, IPluginOptions

Inheritance

object
PluginBaseOptions
TocOptions

Implements

Inherited Members

Constructors

TocOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.TocOptions dengan opsi default.

public TocOptions()

Properties

GenerateBookmarks

Menggunakan pembuatan Bookmark.
Jika disetel true maka Bookmark akan dibersihkan dan dibuat ulang berdasarkan Heading; bila tidak, Bookmark tidak akan berubah.

public bool GenerateBookmarks { get; set; }

Property Value

bool

Headings

Heading atau Judul untuk Daftar Isi.

public List<TocHeading> Headings { get; set; }

Property Value

List<TocHeading>

Title

Judul Daftar Isi.

public string Title { get; set; }

Property Value

string

Namespace: Documentize
Assembly: Documentize.dll

Class Usage

Info

Statistik penggunaan untuk permintaan penyelesaian.

public class Usage

Pewarisan

objectUsage

Anggota yang Dwariskan

Konstruktor

Usage()

public Usage()

Properti

CompletionTokens

Jumlah token dalam penyelesaian yang dihasilkan.

[JsonProperty("completion_tokens")]
public int CompletionTokens { get; set; }

Nilai Properti

int

PromptTokens

Jumlah token dalam prompt.

[JsonProperty("prompt_tokens")]
public int PromptTokens { get; set; }

Nilai Properti

int

TotalTokens

Total jumlah token yang digunakan dalam permintaan (prompt + penyelesaian).

[JsonProperty("total_tokens")]
public int TotalTokens { get; set; }

Nilai Properti

int

Ruang Nama: Documentize
Rakitan: Documentize.dll

Class XlsConverter

Info

Mewakili plugin Documentize.XlsConverter. Digunakan untuk mengonversi dokumen PDF ke format XLSX/XLS/CSV/XLSM/ODS.

[Obsolete("The class will be deleted soon. Please use PdfConverter class.")]
public static class XlsConverter

Pewarisan

objectXlsConverter

Anggota yang Diwarisi

Metode

Process(PdfToXlsOptions)

Mengonversi dokumen PDF ke format XLSX/XLS/CSV/XLSM/ODS.

public static ResultContainer Process(PdfToXlsOptions options)

Parameter

  • options PdfToXlsOptions: Sebuah objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil operasi.

Pengecualian

ArgumentException
Jika opsi tidak diatur.

Namespace: Documentize
Assembly: Documentize.dll

Enum ConvertErrorAction

Info

Kelas ini mewakili tindakan untuk kesalahan konversi.

public enum ConvertErrorAction

Bidang

  • Delete = 0
  • None = 1

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertSoftMaskAction

Info

Aksi ini mewakili aksi untuk konversi gambar dengan soft mask.

public enum ConvertSoftMaskAction

Fields

  • ConvertToStencilMask = 1: Soft mask akan dikonversi menjadi stencil mask.
  • Default = 0: Gunakan strategi default.

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

Info

Mewakili tipe data yang mungkin untuk pemrosesan komponen.

public enum DataType

Fields

  • Directory = 2: Tipe data adalah direktori yang direpresentasikan oleh jalurnya.
  • File = 0: Tipe data adalah file yang direpresentasikan oleh jalurnya.
  • Stream = 1: Tipe data adalah aliran.

Namespace: Documentize Assembly: Documentize.dll

Enum DocConversionMode

Info

Mendefinisikan mode konversi dokumen keluaran.

public enum DocConversionMode

Fields

  • Flow = 1: Mode pengenalan penuh, mesin melakukan pengelompokan dan analisis multi‑tingkat untuk mengembalikan maksud asli penulis dokumen dan menghasilkan dokumen yang dapat diedit secara maksimal. Kekurangannya adalah dokumen keluaran mungkin terlihat berbeda dari file PDF asli.
  • TextBox = 0: Mode ini cepat dan baik untuk mempertahankan tampilan asli file PDF sebanyak mungkin, namun kemampuan mengedit dokumen hasil dapat terbatas. Setiap blok teks yang dikelompokkan secara visual dalam file PDF asli diubah menjadi kotak teks dalam dokumen hasil. Ini menghasilkan kemiripan maksimal dokumen keluaran dengan file PDF asli. Dokumen keluaran akan terlihat bagus, tetapi akan sepenuhnya terdiri dari kotak teks dan dapat membuat penyuntingan lebih lanjut di Microsoft Word cukup sulit. Ini adalah mode default.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlMediaType

Info

Menentukan jenis media yang mungkin digunakan selama rendering.

public enum HtmlMediaType

Bidang

  • Print = 0: Cetak.
  • Screen = 1: Layar.

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

Info

Menentukan flag yang bersama dengan opsi lain menentukan ukuran dan tata letak halaman.

public enum HtmlPageLayoutOption

Fields

  • FitToWidestContentWidth = 3: Menunjukkan bahwa lebar halaman ditentukan dari ukuran konten itu sendiri, bukan dari lebar halaman yang ditentukan.
  • None = 0: Nilai default yang menunjukkan bahwa HtmlPageLayoutOption tidak akan memengaruhi ukuran dan tata letak halaman.
  • ScaleToPageWidth = 256: Menunjukkan bahwa konten dokumen akan diubah skalanya agar sesuai dengan halaman.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Info

Menentukan versi standar PDF/A untuk sebuah dokumen PDF.

public enum PdfAStandardVersion

Bidang

  • Auto = 0: Versi standar PDF/A ditentukan secara otomatis.
  • PDF_A_1A = 1: Menentukan versi standar PDF/A-1a.
  • PDF_A_1B = 2: Menentukan versi standar PDF/A-1b.
  • PDF_A_2A = 3: Menentukan versi standar PDF/A-2a.
  • PDF_A_2B = 4: Menentukan versi standar PDF/A-2b.
  • PDF_A_2U = 5: Menentukan versi standar PDF/A-2u.
  • PDF_A_3A = 6: Menentukan versi standar PDF/A-3a.
  • PDF_A_3B = 7: Menentukan versi standar PDF/A-3b.
  • PDF_A_3U = 8: Menentukan versi standar PDF/A-3u.

Namespace: Documentize
Assembly: Documentize.dll

Enum PdfToHtmlOptions.SaveDataType

Info

Mendefinisikan tipe output file HTML.

public enum PdfToHtmlOptions.SaveDataType

Fields

  • FileWithEmbeddedResources = 1: Simpan HTML ke file dengan sumber daya tersemat
  • FileWithExternalResources = 0: Simpan HTML ke file dengan sumber daya eksternal
  • StreamWithEmbeddedResources = 2: Simpan HTML ke aliran file dengan sumber daya tersemat

Namespace: Documentize
Assembly: Documentize.dll

Enum PdfToXlsOptions.ExcelFormat

Info

Memungkinkan untuk menentukan format file xls/xlsx/xml/csv. Nilai default adalah XLSX.

Memungkinkan untuk menentukan format file xls/xlsx/xml/csv.
Nilai default adalah XLSX.

public enum PdfToXlsOptions.ExcelFormat

Fields

  • CSV = 2: Format file nilai terpisah koma (.csv).
  • ODS = 4: Spreadsheet Open Document.
  • XLSM = 3: Format file Office Open XML (.xlsm) yang mendukung macro.
  • XLSX = 1: Format file Office Open XML (.xlsx).
  • XMLSpreadSheet2003 = 0: Format file Excel 2003 XML (.xls).

Namespace: Documentize Assembly: Documentize.dll

Enum Role

Info

Peran penulis pesan.

public enum Role

Bidang

  • Assistant = 2
  • System = 1
  • User = 0

Namespace: Documentize Assembly: Documentize.dll

Enum Rotation

Info

Enumerasi nilai rotasi yang mungkin.

public enum Rotation

Fields

  • None = 0: Tidak diputar.
  • On180 = 2: Diputar 180 derajat.
  • On270 = 3: Diputar 270 derajat searah jarum jam.
  • On360 = 4: Diputar 360 derajat searah jarum jam.
  • On90 = 1: Diputar 90 derajat searah jarum jam.

Namespace: Documentize Assembly: Documentize.dll

Enum TextExtractorOptions.TextFormattingMode

Info

Mendefinisikan berbagai mode yang dapat digunakan saat mengonversi dokumen PDF menjadi teks. Lihat kelas Documentize.TextExtractorOptions.

public enum TextExtractorOptions.TextFormattingMode  

Fields

  • Plain = 2: Mewakili konten teks PDF dengan mempertimbangkan posisi relatif dari fragmen teks tetapi tanpa menambahkan spasi ekstra.
  • Pure = 0: Mewakili konten teks PDF dengan beberapa rutinitas pemformatan. Ini mencakup mempertimbangkan posisi relatif dan menambahkan spasi ekstra untuk menyelaraskan teks dengan lebar halaman.
  • Raw = 1: Mewakili konten PDF apa adanya, yaitu tanpa pemformatan.

Namespace: Documentize
Assembly: Documentize.dll

Enum TextFormattingMode

Info

Mendefinisikan berbagai mode yang dapat digunakan saat mengonversi dokumen PDF menjadi teks. Lihat Documentize.ExtractTextOptions class.

public enum TextFormattingMode

Bidang

  • Flatten = 2: Merepresentasikan konten PDF dengan fragmen teks yang diposisikan berdasarkan koordinat mereka. Pada dasarnya mirip dengan mode Raw. Namun sementara Raw berfokus pada mempertahankan struktur fragmen teks (operator) dalam dokumen, Flatten berfokus pada menjaga teks dalam urutan yang dibaca.
  • Pure = 0: Merepresentasikan konten teks PDF dengan beberapa rutin pemformatan. Ini termasuk memperhitungkan posisi relatif dan menambahkan spasi ekstra untuk menyelaraskan teks dengan lebar halaman.
  • Raw = 1: Merepresentasikan konten PDF apa adanya, yaitu tanpa pemformatan.

Namespace: Documentize Assembly: Documentize.dll

Enum TiffColorDepth

Info

Digunakan untuk menentukan Kedalaman Warna untuk Documentize.PdfToTiffOptions.

public enum TiffColorDepth

Fields

  • Format1bpp = 4: 1 bit per piksel.
  • Format24bpp = 1: 24 bit per piksel. RGB.
  • Format32bpp = 0: 32 bit per piksel. Digunakan secara default.
  • Format4bpp = 3: 4 bit per piksel.
  • Format8bpp = 2: 8 bit per piksel.

Namespace: Documentize
Assembly: Documentize.dll

Enum TiffCompression

Info

Digunakan untuk menentukan jenis Kompresi untuk Documentize.PdfToTiffOptions.

public enum TiffCompression

Fields

  • CCITT3 = 2: Menentukan skema kompresi CCITT3. Dapat diteruskan ke encoder CCITT3 sebagai parameter yang termasuk dalam kategori Kompresi.
  • CCITT4 = 1: Menentukan skema kompresi CCITT4. Dapat diteruskan ke encoder CCITT4 sebagai parameter yang termasuk dalam kategori Kompresi.
  • LZW = 0: Menentukan skema kompresi LZW. Dapat diteruskan ke encoder Tiff sebagai parameter yang termasuk dalam kategori Kompresi.
  • None = 4: Menentukan tidak ada kompresi. Dapat diteruskan ke encoder Tiff sebagai parameter yang termasuk dalam kategori Kompresi.
  • RLE = 3: Menentukan skema kompresi RLE. Dapat diteruskan ke encoder RLE sebagai parameter yang termasuk dalam kategori Kompresi.

Namespace: Documentize Assembly: Documentize.dll

Interface IData

Info

Antarmuka data umum yang mendefinisikan anggota umum yang harus diimplementasikan oleh data konkret.

public interface IData

Properties

DataType

Jenis sumber data.

DataType DataType { get; }

Property Value

DataType

Namespace: Documentize
Assembly: Documentize.dll

Interface IDataSource

Info

Antarmuka data umum yang mendefinisikan anggota umum yang harus diimplementasikan oleh data konkret.

public interface IDataSource

Properties

DataType

Tipe sumber data.

DataType DataType { get; }

Property Value

DataType

Namespace: Documentize Assembly: Documentize.dll

Interface IHaveInput

Info

Antarmuka data umum yang menentukan Data Input yang harus diimplementasikan oleh Options.

public interface IHaveInput

Properties

Input

Mendapatkan atau mengatur Data Input.

IData Input { get; set; }

Nilai Properti

IData

Namespace: Documentize Assembly: Documentize.dll

Interface IOperationResult

Info

Antarmuka hasil operasi umum yang mendefinisikan metode umum yang harus diimplementasikan oleh hasil operasi komponen konkret.

public interface IOperationResult

Properti

Data

Mendapatkan data mentah.

object Data { get; }

Nilai Properti

object

IsFile

Menunjukkan apakah hasilnya merupakan path ke file output.

bool IsFile { get; }

Nilai Properti

bool

IsStream

Menunjukkan apakah hasilnya merupakan aliran output.

bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasilnya merupakan string teks.

bool IsString { get; }

Nilai Properti

bool

Metode

ToFile()

Mencoba mengonversi hasil menjadi file.

string ToFile()

Mengembalikan

string : String yang mewakili path ke file output jika hasilnya berupa file; jika tidak null.

ToStream()

Mencoba mengonversi hasil menjadi objek aliran.

Stream ToStream()

Mengembalikan

Stream : Objek aliran yang mewakili data output jika hasilnya berupa aliran; jika tidak null.

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

Info

Antarmuka opsi komponen umum yang mendefinisikan metode umum yang harus diimplementasikan oleh opsi komponen konkret.

public interface IPluginOptions

Namespace: Documentize Assembly: Documentize.dll

Kelas PdfExtractorOptions

Info

Mewakili opsi untuk plugin TextExtractor dan ImageExtractor.

public abstract class PdfExtractorOptions : IPluginOptions  

Pewarisan

object
PdfExtractorOptions

Turunan

Mengimplementasikan

Anggota yang diwariskan

Catatan

Documentize.PdfExtractorOptions berisi fungsi dasar untuk menambahkan data (file, aliran) yang mewakili dokumen PDF masukan.
Silakan buat Documentize.TextExtractorOptions atau ImageExtractorOptions bukan yang ini.

Properti

Inputs

Mengembal

 Indonesia