Documentize Namespace

Kelas

Nama KelasDeskripsi
AddTimestampOptionsMewakili Opsi Tambah Timestamp untuk plugin Documentize.Timestamp.
ChatCompletionMewakili respons penyelesaian obrolan yang dikembalikan oleh model, berdasarkan input yang diberikan.
ChatGptConstsKelas ini mewakili penyimpanan untuk konstanta.
ChatGptRequestOptionsMewakili opsi untuk plugin Documentize.PdfManager.
ChoicePilihan penyelesaian obrolan.
CompressOptionsMewakili opsi Kompres untuk plugin Documentize.PdfManager.
DecryptOptionsMewakili Opsi Dekripsi untuk plugin Documentize.PdfSecurity.
DirectoryDataMewakili data direktori untuk operasi muat dan simpan.
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 untuk plugin Documentize.PdfForm dan Documentize.PdfExtractor.
ExtractImagesOptionsMewakili opsi ekstraksi gambar untuk plugin Documentize.PdfExtractor.
ExtractPropertiesOptionsMewakili Opsi Ekstraksi Properti PDF untuk plugin Documentize.PdfExtractor.
ExtractTextOptionsMewakili opsi Ekstraksi Teks untuk plugin Documentize.PdfExtractor.
FileDataMewakili data file untuk operasi muat dan simpan.
FileResultMewakili hasil operasi dalam bentuk path string ke file.
FlattenFieldsOptionsMewakili opsi untuk Meratakan Bidang dalam dokumen oleh plugin Documentize.PdfForm.
FormExporterMewakili plugin Documentize.FormExporter. Digunakan untuk Mengekspor nilai Formulir dokumen PDF ke file DSV atau CSV.
FormFlattenerMewakili plugin Documentize.FormFlattener. Digunakan untuk Meratakan bidang dalam dokumen PDF.
GetFieldNamesOptionsMewakili opsi untuk Mendapatkan Nama Bidang dalam dokumen oleh plugin 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.
ImageExtractorMewakili plugin Documentize.ImageExtractor. Digunakan untuk mengekstrak gambar dari dokumen PDF.
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 Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompresi dokumen PDF.
OptionsWithInputMewakili Opsi dasar untuk operasi dengan 1 Data Input.
PageInfoMewakili informasi halaman.
PageSizeKelas yang mewakili ukuran halaman dalam dokumen PDF.
PdfAConverterMewakili plugin untuk menangani konversi dokumen PDF ke format PDF/A serta untuk validasi kepatuhan PDF/A.
PdfAOptionsBaseMewakili kelas dasar untuk opsi plugin Documentize.PdfAConverter. Kelas ini menyediakan properti dan metode untuk mengonfigurasi proses konversi dan validasi PDF/A.
PdfAValidateOptionsMewakili opsi untuk memvalidasi kepatuhan PDF/A pada dokumen PDF dengan plugin Documentize.PdfConverter.
PdfAValidationResultMewakili hasil proses validasi PDF/A.
PdfChatGptMewakili plugin PdfChatGpt.
PdfConverterMewakili plugin 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 melakukan Validasi PDF/A dan Mengonversi HTML ke PDF.
PdfExtractorMewakili plugin Documentize.PdfExtractor. Digunakan untuk Mengekstrak Teks, Gambar, Data Formulir, Properti (Meta Data) dari dokumen PDF.
PdfFormMewakili plugin Documentize.PdfForm. Digunakan untuk Meratakan, Mengekstrak Data Formulir. Juga memungkinkan untuk Mendapatkan Nama Bidang.
PdfManagerMewakili plugin Documentize.PdfManager. Digunakan untuk Menggabungkan, Memisahkan, Mengoptimalkan, Memutar, Mengubah Ukuran, Mengompresi dokumen PDF serta Menambah Tabel, Menambah 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, Mengompresi dokumen PDF. Dapat Memutar, Mengubah Ukuran Halaman dokumen PDF. Dapat Menambah Tabel ke dokumen PDF. Dapat Menambah Daftar Isi ke dokumen PDF.
PdfPropertiesMewakili Properti dan informasi meta dari dokumen PDF.
PdfSecurityMewakili plugin Documentize.PdfSecurity. Digunakan untuk Enkripsi, Dekripsi, dan Penandatanganan 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 plugin.
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 Pengubahan Ukuran untuk plugin Documentize.PdfManager.
ResultContainerMewakili kontainer yang berisi koleksi hasil pemrosesan plugin.
RotateOptionsMewakili opsi Pemutaran untuk plugin Documentize.PdfManager.
SecurityMewakili plugin Documentize.Security. Digunakan untuk mengenkripsi dan mendekripsi dokumen PDF.
SignOptionsMewakili Opsi Penandatanganan untuk plugin Documentize.PdfSecurity.
SignatureMewakili plugin Documentize.Signature. Digunakan untuk Menandatangani dokumen PDF.
SplitOptionsMewakili opsi Pemisahan untuk plugin Documentize.PdfManager.
SplitterMewakili plugin Documentize.Splitter. Digunakan untuk Memisahkan dokumen PDF menjadi halaman terpisah.
StreamDataMewakili data aliran untuk operasi muat dan simpan.
StreamResultMewakili hasil operasi dalam bentuk Aliran.
StringResultMewakili hasil operasi dalam bentuk string.
TableBuilderKelas yang mewakili pembuat tabel dalam halaman PDF.
TableCellBuilderKelas yang mewakili pembuat sel tabel.
TableGeneratorMewakili plugin Documentize.TableGenerator. Digunakan untuk menambahkan tabel ke dokumen PDF.
TableOptionsMewakili opsi untuk menambah tabel ke dokumen oleh plugin Documentize.PdfManager.
TableRowBuilderKelas yang mewakili pembuat baris tabel.
TextExtractorMewakili plugin Documentize.TextExtractor. Digunakan untuk mengekstrak teks dari dokumen PDF.
TiffConverterMewakili plugin Documentize.TiffConverter. Digunakan untuk mengonversi dokumen PDF ke format TIFF.
TimestampMewakili plugin Documentize.Timestamp. Digunakan untuk menambahkan Timestamp ke dokumen.
TimestampOptionsTocGenerator Mewakili 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 menambah 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 Input yang harus diimplementasikan oleh Opsi.
IOperationResultAntarmuka hasil operasi umum yang mendefinisikan metode umum yang harus diimplementasikan oleh hasil operasi plugin konkret.
IPluginOptionsAntarmuka opsi plugin umum yang mendefinisikan metode umum yang harus diimplementasikan oleh opsi plugin 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 memungkinkan untuk pemrosesan plugin.
DocConversionModeMenentukan mode konversi dokumen output.
PdfToXlsOptions.ExcelFormatMemungkinkan menentukan format file xls/xlsx/xml/csv. Nilai default adalah XLSX.
HtmlMediaTypeMenentukan tipe media yang memungkinkan digunakan selama rendering.
HtmlPageLayoutOptionMenentukan flag yang bersama opsi lain menentukan ukuran dan tata letak halaman.
PdfAStandardVersionMenentukan versi standar PDF/A untuk dokumen PDF.
RolePeran penulis pesan.
RotationEnumerasi nilai rotasi yang memungkinkan.
PdfToHtmlOptions.SaveDataTypeMenentukan tipe output file HTML.
TextFormattingModeMenentukan 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 jenis 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 chat yang dikembalikan oleh model, berdasarkan input yang diberikan.

public class ChatCompletion  

Pewarisan

object
ChatCompletion

Anggota yang Warisan

Konstruktor

ChatCompletion()

public ChatCompletion()  

Properti

Pilihan

Daftar pilihan penyelesaian chat. Dapat lebih dari satu jika n lebih besar dari 1.

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

Nilai Properti

List<Choice>

Dibuat

Timestamp Unix (dalam detik) saat penyelesaian chat dibuat.

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

Nilai Properti

long

Id

Pengidentifikasi unik untuk penyelesaian chat.

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

Nilai Properti

string

Model

Model yang digunakan untuk penyelesaian chat.

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

Nilai Properti

string

Objek

Tipe objek, yang selalu chat.completion.

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

Nilai Properti

string

SystemFingerprint

Sidik jari ini mewakili konfigurasi backend yang digunakan model tersebut.

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

Nilai Properti

string

Penggunaan

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 merepresentasikan penyimpanan untuk konstanta.

public static class ChatGptConsts

Pewarisan

objectChatGptConsts

Anggota yang Dwarisi

Field

  • ApiUrl

Nilai Field

string

ModelName

public static string ModelName

Nilai Field

string

SystemRole

public static string SystemRole

Nilai Field

string

SystemRoleDescription

public static string SystemRoleDescription

Nilai Field

string

UserRole

public static string UserRole

Nilai Field

string

Namespace: 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 terbatas.

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 beberapa 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 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, ArgumentException akan dilempar.

Model

Mengatur atau mendapatkan ID model yang akan digunakan.

public string Model { get; set; }

Nilai Properti

string

NumberOfChoices

Berapa banyak pilihan penyelesaian obrolan yang dihasilkan untuk setiap pesan input.

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

Suhu sampling yang digunakan, antara 0 dan 2.
Nilai yang lebih tinggi seperti 0.8 akan membuat output 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

Ruang Nama: Documentize Assembly: Documentize.dll

Class Choice

Info

Pilihan penyelesaian obrolan.

public class Choice

Pewarisan

objectChoice

Anggota yang Dwarisi

Konstruktor

Choice()

public Choice()

Properti

FinishReason

Alasan mengapa model berhenti menghasilkan token. Ini akan berhenti jika model mencapai titik berhenti alami atau urutan berhenti yang diberikan, 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

Namespace: Documentize Assembly: Documentize.dll

Class CompressOptions

Info

Mewakili opsi Kompres untuk plugin Documentize.PdfManager.

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsCompressOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

CompressOptions()

Menginisialisasi 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 Decrypt 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: Password pemilik.

Properties

OwnerPassword

Password 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

Pewarisan

objectDirectoryData

Mengimplementasikan

Anggota yang Ditarik

Konstruktor

DirectoryData(string)

Menginisialisasi data direktori baru dengan path yang ditentukan.

public DirectoryData(string path)

Parameter

  • path string: String yang merepresentasikan path ke direktori.

Properti

DataType

Tipe sumber data.

public DataType DataType { get; }

Nilai Properti

DataType

Path

Mendapatkan path ke direktori data saat ini.

public string Path { get; }

Nilai Properti

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 mengubah dokumen PDF menjadi format DOC/DOCX.

[Obsolete("Kelas ini akan dihapus segera. Harap gunakan kelas PdfConverter.")]
public static class DocConverter

Pewarisan

objectDocConverter

Anggota yang diwarisi

Metode

Process(PdfToDocOptions)

Mengubah dokumen PDF menjadi format DOC/DOCX.

public static ResultContainer Process(PdfToDocOptions options)

Parameter

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

Mengembalikan

ResultContainer : Objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

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 Ditarik

Konstruktor

EncryptOptions(string, string)

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

public EncryptOptions(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 ExtractFormDataToDsvOptions

Info

Mewakili opsi untuk mengekspor nilai bidang untuk plugin Documentize.PdfForm dan Documentize.PdfExtractor.

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsExtractFormDataToDsvOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

ExtractFormDataToDsvOptions(char, bool)

Menginisialisasi sebuah instance baru dari objek Documentize.ExtractFormDataToDsvOptions.

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

Parameter

  • delimiter char: Menentukan pemisah yang akan digunakan dalam data yang diekspor di antara 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

Delimiter

Pemisah yang digunakan untuk nilai yang diekspor.

public char Delimiter { get; set; }

Nilai Properti

char

Namespace: Documentize Assembly: Documentize.dll

Class ExtractImagesOptions

Info

Mewakili opsi ekstraksi gambar untuk plugin Documentize.PdfExtractor.

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsExtractImagesOptions

Implements

Inherited Members

Constructors

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 plugin Documentize.PdfExtractor.

public sealed class ExtractPropertiesOptions : OptionsWithInput, IHaveInput

Pewarisan

objectOptionsWithInputExtractPropertiesOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

ExtractPropertiesOptions()

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

public ExtractPropertiesOptions()

ExtractPropertiesOptions(IData)

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

public ExtractPropertiesOptions(IData data)

Parameter

ExtractPropertiesOptions(string)

Menginisialisasi sebuah instance baru dari objek Documentize.ExtractPropertiesOptions dengan file yang ditentukan.

public ExtractPropertiesOptions(string file)

Parameter

  • file string: Jalur file input.

ExtractPropertiesOptions(Stream)

Menginisialisasi sebuah instance baru dari objek Documentize.ExtractPropertiesOptions dengan stream yang ditentukan.

public ExtractPropertiesOptions(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 ExtractTextOptions

Info

Mewakili opsi ekstraksi teks untuk plugin Documentize.PdfExtractor.

public sealed class ExtractTextOptions : OptionsWithInput, IHaveInput

Pewarisan

objectOptionsWithInputExtractTextOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameter

ExtractTextOptions(IData, TextFormattingMode)

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

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

Parameter

ExtractTextOptions(string, TextFormattingMode)

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

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

Parameter

ExtractTextOptions(Stream, TextFormattingMode)

Menginisialisasi sebuah instance baru dari objek Documentize.ExtractTextOptions dengan stream yang ditentukan.

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

Parameter

Properti

FormattingMode

Mendapatkan atau mengatur mode format.

public TextFormattingMode FormattingMode { get; set; }

Nilai Properti

TextFormattingMode

Input

Mendapatkan atau mengatur Data Input.

public override IData Input { get; set; }

Nilai Properti

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 Diwariskan

Konstruktor

FileData(string)

Menginisialisasi sumber data file baru dengan jalur yang ditentukan.

public FileData(string path)

Parameter

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

Properti

DataType

Jenis 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 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

Pewarisan

objectFileResult

Mengimplementasikan

Anggota yang Dwarisi

Properti

Data

Mendapatkan data mentah.

public object Data { get; }

Nilai Properti

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file output.

public bool IsFile { get; }

Nilai Properti

bool

IsStream

Menunjukkan apakah hasilnya adalah aliran output.

public bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasilnya adalah string teks.

public bool IsString { get; }

Nilai Properti

bool

Metode

ToFile()

Mencoba untuk mengonversi hasil menjadi sebuah file.

public string ToFile()

Mengembalikan

string : Sebuah string yang mewakili jalur ke file output jika hasilnya adalah file; jika tidak null.

ToStream()

Mencoba untuk mengonversi hasil menjadi objek aliran.

public Stream ToStream()

Mengembalikan

Stream : Sebuah objek aliran yang mewakili data output jika hasilnya adalah aliran; jika tidak null.

Namespace: Documentize Assembly: Documentize.dll

Class FlattenFieldsOptions

Info

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

public class FlattenFieldsOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsFlattenFieldsOptions

Implements

Inherited Members

Constructors

FlattenFieldsOptions()

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

public FlattenFieldsOptions()

Properties

SkipFields

Daftar bidang yang tidak akan di‑Flatten.

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

Property Value

List<string>

Namespace: Documentize Assembly: Documentize.dll

Class FormExporter

Info

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

[Obsolete("Kelas ini akan segera dihapus. Silakan gunakan kelas PdfExtractor atau PdfForm.")]
public static class FormExporter

Inheritance

objectFormExporter

Inherited Members

Methods

Process(ExtractFormDataToDsvOptions)

Memulai pemrosesan Documentize.FormExporter dengan parameter yang ditentukan.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Exceptions

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 Field 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 Field dalam Dokumen PDF.

public static List<string> GetFieldNames(Stream stream)

Parameter

  • stream Stream: Stream dengan Dokumen PDF.

Mengembalikan

List<string>

Daftar nama dalam Dokumen PDF.

Process(FlattenFieldsOptions) : Meratakan field Form dalam dokumen PDF.

public static ResultContainer Process(FlattenFieldsOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

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 Documentize.PdfForm plugin.

public class GetFieldNamesOptions

Inheritance

objectGetFieldNamesOptions

Inherited Members

Constructors

GetFieldNamesOptions(string)

Konstruktor untuk opsi dengan Path input ke file.

public GetFieldNamesOptions(string path)

Parameters

  • path string: Path input ke file.

GetFieldNamesOptions(Stream)

Konstruktor untuk opsi dengan Stream input.

public GetFieldNamesOptions(Stream stream)

Parameters

Namespace: Documentize Assembly: Documentize.dll

Class HtmlConverter

Info

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

[Obsolete("Kelas ini akan dihapus segera. Harap gunakan kelas PdfConverter.")]
public static class HtmlConverter

Pewarisan

objectHtmlConverter

Anggota Yang Dwarisi

Metode

Process(PdfToHtmlOptions)

Mengubah dokumen PDF ke format HTML.

public static ResultContainer Process(PdfToHtmlOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Process(HtmlToPdfOptions)

Mengubah dokumen HTML ke format PDF.

public static ResultContainer Process(HtmlToPdfOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Class HtmlToPdfOptions

Info

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

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsHtmlToPdfOptions

Implements

Inherited Members

Constructors

HtmlToPdfOptions()

Menginisialisasi instance baru dari objek Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Properties

BasePath

Jalur dasar/URL untuk file html.

public string BasePath { get; set; }

Property Value

string

HtmlMediaType

Mendapatkan atau mengatur tipe media yang mungkin digunakan selama proses rendering.

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

Mendapatkan atau mengatur rendering seluruh dokumen menjadi satu halaman.

public bool IsRenderToSinglePage { get; set; }

Property Value

bool

PageInfo

Mendapatkan atau mengatur informasi halaman dokumen.

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

Mendapatkan atau mengatur opsi tata letak.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Namespace: Documentize Assembly: Documentize.dll

Class ImageExtractor

Info

Mewakili plugin 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)

Ekstrak gambar dari dokumen PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil dari operasi tersebut.

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 memberikan informasi tentang build produk saat ini.

public static class Info

Warisan

objectInfo

Anggota yang Diwarisi

Variabel

  • AssemblyVersion Versi Assembly.

Nilai Variabel

string

Product

Nama Produk.

public const string Product = "Documentize"

Nilai Variabel

string

Ruang Nama: Documentize Assembly: Documentize.dll

Class JpegConverter

Info

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

[Obsolete("Kelas ini akan dihapus segera. Harap gunakan kelas PdfConverter.")]
public static class JpegConverter

Pewarisan

objectJpegConverter

Anggota yang Dwarisi

Metode

Process(PdfToJpegOptions)

Mengonversi dokumen PDF ke format JPEG.

public static ResultContainer Process(PdfToJpegOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class MergeOptions

Info

Mewakili opsi Penggabungan untuk Documentize.PdfManager plugin.

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsMergeOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

MergeOptions()

Menginisialisasi sebuah 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("Kelas ini akan dihapus segera. Silakan gunakan kelas PdfManager.")]
public static class Merger

Pewarisan

objectMerger

Anggota yang diwarisi

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 dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

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 dari 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

object
ObjectResult

Implements

Inherited Members

Properties

Data

Mendapatkan data mentah.

public object Data { get; }  

Property Value

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file keluaran.

public bool IsFile { get; }  

Property Value

bool

IsObject

Menunjukkan apakah hasilnya adalah objek.

public bool IsObject { get; }  

Property Value

bool

IsStream

Menunjukkan apakah hasilnya adalah jalur ke file keluaran.

public bool IsStream { get; }  

Property Value

bool

IsString

Menunjukkan apakah hasilnya adalah 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 sebuah file.

public string ToFile()  

Returns

string : Sebuah string yang mewakili jalur ke file keluaran jika hasilnya adalah file; jika tidak null.

ToStream()

Mencoba mengonversi hasil menjadi objek stream.

public Stream ToStream()  

Returns

Stream : Sebuah objek stream yang mewakili data keluaran jika hasilnya adalah stream; jika tidak null.

ToString()

Mencoba mengonversi hasil menjadi sebuah string.

public override string ToString()  

Returns

string : Sebuah string yang mewakili konten teks jika hasilnya adalah string; jika tidak mengembalikan base.ToString().

Namespace: Documentize
Assembly: Documentize.dll

Class OptimizeOptions

Info

Mewakili opsi Optimize untuk plugin Documentize.PdfManager.

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsOptimizeOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

OptimizeOptions()

Menginisialisasi sebuah instance baru dari objek Documentize.OptimizeOptions dengan opsi default. Linearize dokumen untuk

  • membuka halaman pertama secepat mungkin;
  • menampilkan halaman berikutnya atau mengikuti tautan ke halaman berikutnya secepat mungkin;
  • menampilkan halaman secara bertahap saat data halaman diterima melalui saluran 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, Mengompresi dokumen PDF.

[Obsolete("Kelas ini akan dihapus dalam waktu dekat. Harap gunakan kelas PdfManager.")]
public static class Optimizer

Pewarisan

objectOptimizer

Anggota yang Diwarisi

Metode

Process(OptimizeOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(OptimizeOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Process(RotateOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(RotateOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Process(ResizeOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(ResizeOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Process(CompressOptions)

Memulai pemrosesan Documentize.Optimizer dengan parameter yang ditentukan.

public static ResultContainer Process(CompressOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari 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

Turunan

Mengimplementasikan

Anggota yang Diwarisi

Bidang

  • input

  • protected IData input

Nilai Bidang

IData

Properti

Input

Mendapatkan atau mengatur Data Input.

public virtual IData Input { get; set; }

Nilai Properti

IData

Namespace: Documentize Assembly: Documentize.dll

Class PageInfo

Info

Mewakili informasi halaman.

public class PageInfo : PageSize  

Warisan

object
PageSize
PageInfo

Anggota yang Dwarisi

Constructor

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 menetapkan nilai yang menunjukkan margin bawah.

public double MarginBottom { get; set; }  

Nilai Properti

double

MarginLeft

Mendapatkan atau menetapkan nilai yang menunjukkan margin kiri.

public double MarginLeft { get; set; }  

Nilai Properti

double

MarginRight

Mendapatkan atau menetapkan nilai yang menunjukkan margin kanan.

public double MarginRight { get; set; }  

Nilai Properti

double

MarginTop

Mendapatkan atau menetapkan nilai yang menunjukkan margin atas.

public double MarginTop { get; set; }  

Nilai Properti

double

Namespace: Documentize
Assembly: Documentize.dll

Class PageSize

Info

Kelas yang mewakili ukuran halaman dalam dokumen PDF.

public class PageSize

Pewarisan

objectPageSize

Turunan

Anggota yang Dwarisi

Konstruktor

PageSize()

Konstruktor dari Documentize.PageSize. Ukuran A4 secara default.

public PageSize()

PageSize(double, double)

Konstruktor dari Documentize.PageSize.

public PageSize(double width, double height)

Parameter

Properti

A0

Ukuran A0 (1189x840 mm).

public static PageSize A0 { get; }

Nilai Properti

PageSize

A1

Ukuran A1 (840x594 mm).

public static PageSize A1 { get; }

Nilai Properti

PageSize

A2

Ukuran A2 (594x420 mm).

public static PageSize A2 { get; }

Nilai Properti

PageSize

A3

Ukuran A3 (420x297 mm).

public static PageSize A3 { get; }

Nilai Properti

PageSize

A4

Ukuran A4 (297x210 mm).

public static PageSize A4 { get; }

Nilai Properti

PageSize

A5

Ukuran A5 (210x148 mm).

public static PageSize A5 { get; }

Nilai Properti

PageSize

A6

Ukuran A6 (148x105 mm).

public static PageSize A6 { get; }

Nilai Properti

PageSize

B5

Ukuran B5 (250x176 mm).

public static PageSize B5 { get; }

Nilai Properti

PageSize

Height

Mengambil atau mengatur tinggi halaman.

public double Height { get; set; }

Nilai Properti

double

IsLandscape

Mengambil orientasi halaman. Mengembalikan true jika ini adalah orientasi lanskap dan false jika ini adalah potret.

public bool IsLandscape { get; }

Nilai Properti

bool

P11x17

Format 11x17 inci.

public static PageSize P11x17 { get; }

Nilai Properti

PageSize

PageLedger

Ukuran Ledger (432x279 mm).

public static PageSize PageLedger { get; }

Nilai Properti

PageSize

Ukuran Legal (356x216 mm).

public static PageSize PageLegal { get; }

Nilai Properti

PageSize

PageLetter

Ukuran Letter (279x216 mm).

public static PageSize PageLetter { get; }

Nilai Properti

PageSize

Width

Mengambil atau mengatur lebar halaman.

public double Width { get; set; }

Nilai Properti

double

Namespace: Documentize Assembly: Documentize.dll

Class PdfAConverter

Info

Mewakili plugin untuk menangani konversi dokumen PDF dalam format PDF/A dan untuk validasi kesesuaian PDF/A.

[Obsolete("Kelas ini akan dihapus segera. Silakan gunakan kelas PdfConverter.")]
public static class PdfAConverter

Pewarisan

objectPdfAConverter

Anggota yang Dwarisi

Metode

Process(PdfToPdfAOptions)

Mengonversi dokumen PDF ke dalam format PDF/A.

public static ResultContainer Process(PdfToPdfAOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Process(PdfAValidateOptions)

Memeriksa dokumen PDF untuk kesesuaian dengan format PDF/A yang ditentukan.

public static ResultContainer Process(PdfAValidateOptions options)

Parameter

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari 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.

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

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

objectPdfAOptionsBase

Derived

Implements

Inherited Members

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

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

public bool AlignText { get; set; }

Property Value

bool

Remarks

When set to true, the conversion process will attempt to restore the original text segment bounds. For the most of the documents there is no need to change this property from the default false value, as the text alignment doesn’t change during the default conversion process.

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }

Property Value

bool

ErrorAction

Mendapatkan atau mengatur tindakan yang akan diambil untuk objek yang tidak dapat dikonversi.

public ConvertErrorAction ErrorAction { get; set; }

Property Value

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }

Property Value

string

Inputs

Mendapatkan koleksi data.

public List<idata> Inputs { get; }

Property Value

List<IData>

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }

Property Value

bool

LogOutputSource

Mendapatkan atau mengatur sumber data untuk output log.

public IData LogOutputSource { get; set; }

Property Value

IData

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }

Property Value

bool

Remarks

When set to true, the conversion process will attempt to minimize the resulting file size. This might affect the conversion process performance.

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

The PDF/A standard version is used to determine the compliance level for PDF/A validation and conversion. If the version is set to Documentize.PdfAStandardVersion.Auto, the system will automatically determine the appropriate PDF/A standard version for validation based on the document metadata. For the PDF/A conversion process the Documentize.PdfAStandardVersion.Auto defaults to the PDF/A-1b standard version.

SoftMaskAction

Mendapatkan atau mengatur tindakan yang akan diambil selama konversi gambar dengan soft mask.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IData)

Menambahkan data baru ke dalam koleksi

public void AddInput(IData data)

Parameters

  • data IData: Input data. :

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidateOptions

Info

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

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Pewarisan

objectPdfAOptionsBasePdfAValidateOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

PdfAValidateOptions()

public PdfAValidateOptions()

Namespace: Documentize Assembly: Documentize.dll

Class PdfAValidationResult

Info

Mewakili hasil proses validasi PDF/A.

public sealed class PdfAValidationResult

Inheritance

objectPdfAValidationResult

Inherited Members

Fields

  • Data Mendapatkan sumber data yang telah divalidasi.

Field Value

IData

IsValid

Mendapatkan nilai yang menunjukkan apakah validasi berhasil.

public readonly bool IsValid

Field Value

bool

StandardVersion

Mendapatkan versi standar PDF/A yang digunakan untuk validasi.

public readonly PdfAStandardVersion StandardVersion

Field Value

PdfAStandardVersion

Namespace: Documentize Assembly: Documentize.dll

Class PdfChatGpt

Info

Mewakili plugin PdfChatGpt.

[Obsolete("Kelas ini akan dihapus segera. Silakan gunakan kelas PdfManager.")]
public static class PdfChatGpt

Pewarisan

objectPdfChatGpt

Anggota yang Dwarisi

Catatan

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

Metode

Process(IPluginOptions)

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

public static ResultContainer Process(IPluginOptions options)

Parameter

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

Mengembalikan

ResultContainer : #### Pengecualian

NotImplementedException

ProcessAsync(IPluginOptions)

Memulai pemrosesan PdfChatGpt dengan parameter yang ditentukan.

public static Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parameter

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

Mengembalikan

Task<ResultContainer>

Objek tugas yang mewakili operasi asinkron.

Pengecualian

ArgumentException : InvalidOperationException

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 plugin 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 plugin 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

Inheritance

objectPdfConverter

Inherited Members

Methods

Convert(PdfToDocOptions)

Mengonversi dokumen PDF menjadi format DOC/DOCX.

public static ResultContainer Convert(PdfToDocOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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 berikut 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);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(PdfToXlsOptions)

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

public static ResultContainer Convert(PdfToXlsOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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 berikut 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);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(PdfToHtmlOptions)

Mengonversi dokumen PDF menjadi format HTML.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(HtmlToPdfOptions)

Mengonversi dokumen HTML menjadi format PDF.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(PdfToJpegOptions)

Mengonversi dokumen PDF menjadi format JPEG.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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 berikut 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 berikut menunjukkan cara mengonversi dokumen PDF ke format JPEG ke aliran (streams).

// 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();
}

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(PdfToPngOptions)

Mengonversi dokumen PDF menjadi format PNG.

public static ResultContainer Convert(PdfToPngOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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 berikut 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 berikut menunjukkan cara mengonversi dokumen PDF ke format PNG ke aliran (streams).

// 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();
}

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(PdfToTiffOptions)

Mengonversi dokumen PDF menjadi format TIFF.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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 berikut 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 berikut 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 berikut 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 berikut menunjukkan cara mengonversi dokumen PDF ke format TIFF ke aliran (streams).

// 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();
}

Exceptions

ArgumentException

Jika opsi tidak diatur.

Convert(PdfToPdfAOptions)

Mengonversi dokumen PDF menjadi format PDF/A.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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);

Exceptions

ArgumentException

Jika opsi tidak diatur.

Validate(PdfAValidateOptions)

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

public static ResultContainer Validate(PdfAValidateOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh berikut 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
}

Exceptions

ArgumentException

Jika opsi tidak diatur.

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 plugin Documentize.PdfExtractor. Digunakan untuk Mengekstrak Teks, Gambar, Data Formulir, Properti (Meta Data) dari dokumen PDF.

public static class PdfExtractor

Pewarisan

object
PdfExtractor

Anggota yang Diwariskan

Metode

Extract(ExtractTextOptions)

Mengekstrak Teks dari dokumen PDF.

public static string Extract(ExtractTextOptions options)

Parameter

Mengembalikan

string : Teks yang diekstrak.

Contoh

Contoh ini menunjukkan cara Mengekstrak konten Teks dari file PDF.

// Create ExtractTextOptions object to set input file path
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf");
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

Contoh ini menunjukkan cara Mengekstrak konten Teks dari aliran PDF.

// Create ExtractTextOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractTextOptions(stream);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

Contoh ini menunjukkan cara Mengekstrak konten Teks dokumen PDF dengan TextFormattingMode.

// Create ExtractTextOptions object to set input file path and TextFormattingMode
var options = new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure);
// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(options);

Contoh ini menunjukkan cara Mengekstrak Teks dari file PDF dengan gaya paling singkat.

// Perform the process and get the extracted text
var textExtracted = PdfExtractor.Extract(new ExtractTextOptions("path_to_your_pdf_file.pdf", TextFormattingMode.Pure));

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Extract(ExtractImagesOptions)

Mengekstrak gambar dari dokumen PDF.

public static ResultContainer Extract(ExtractImagesOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini menunjukkan cara Mengekstrak Gambar dari dokumen PDF.

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryData("path_to_results_directory"));
// Perform the process
var results = PdfExtractor.Extract(options);
// Get path to image result
var imageExtracted = results.ResultCollection[0].ToFile();

Contoh ini menunjukkan cara Mengekstrak Gambar dari dokumen PDF ke Stream tanpa folder.

// Create ExtractImagesOptions to set instructions
var options = new ExtractImagesOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Not set output - it will write results to streams
// Perform the process
var results = PdfExtractor.Extract(options);
// Get Stream
var ms = results.ResultCollection[0].ToStream();
// Copy data to file for demo
ms.Seek(0, SeekOrigin.Begin);
using (var fs = File.Create("test_file.png"))
{
    ms.CopyTo(fs);
}

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Extract(ExtractFormDataToDsvOptions)

Mengekstrak Data Formulir dari dokumen PDF.

public static ResultContainer Extract(ExtractFormDataToDsvOptions options)

Parameter

Mengembalikan

ResultContainer : Objek yang berisi hasil operasi.

Contoh

Contoh ini 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
PdfExtractor.Extract(options);

Contoh ini 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
PdfExtractor.Extract(options);

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Extract(ExtractPropertiesOptions)

Mengekstrak Properti dari dokumen PDF.

public static PdfProperties Extract(ExtractPropertiesOptions options)

Parameter

Mengembalikan

PdfProperties : Objek yang berisi hasil operasi.

Contoh

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

// Create ExtractPropertiesOptions object to set input file
var options = new ExtractPropertiesOptions("path_to_your_pdf_file.pdf");
// Perform the process and get Properties
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 ini menunjukkan cara Mengekstrak Properti (Title, Author, Subject, Keywords, Created, Modified, Application, PDF Producer, Number of Pages) dari aliran PDF.

// Create ExtractPropertiesOptions object to set input stream
var stream = File.OpenRead("path_to_your_pdf_file.pdf");
var options = new ExtractPropertiesOptions(stream);
// Perform the process and get Properties
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 ini menunjukkan cara Mengekstrak Properti dari file PDF dengan gaya paling singkat.

// Perform the process and get Properties
var pdfProperties = PdfExtractor.Extract(new ExtractPropertiesOptions("path_to_your_pdf_file.pdf"));

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize
Assembly: Documentize.dll

Class PdfForm

Info

Mewakili plugin Documentize.PdfForm. Digunakan untuk Flatten, Extract Forms Data. Juga memungkinkan Anda untuk Get Fields Names.

Mewakili plugin Documentize.PdfForm. Digunakan untuk Flatten, Extract Forms Data.
Juga memungkinkan Anda untuk Get Fields Names.

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 operasi.

Examples

The example demonstrates how to Export Form values to CSV file.

// 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);

The example demonstrates how to Export Form values to TSV file and set Properties.

// 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)

Meratakan bidang dalam dokumen PDF.

public static ResultContainer Flatten(FlattenFieldsOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

The example demonstrates how to Flatten fields in PDF file.

// 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);

The example demonstrates how to Flatten fields in PDF file and skip first field.

// 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

The example demonstrates how to Get field Names from PDF file.

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

Remove(RemoveFieldsOptions) : Menghapus Bidang dari dokumen PDF.

public static ResultContainer Remove(RemoveFieldsOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

The example demonstrates how to Remove fields from PDF file.

// 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

Represents Documentize.PdfManager plugin. Used to Merge, Split, Optimize, Rotate, Resize, Compress PDF documents and Add Table, Add TOC to PDF documents. Can Merge multiple PDF documents into a single PDF. Can Split PDF documents into separate pages. Can Optimize, Rotate, Resize, Compress PDF documents. Can Rotate, Resize Pages of PDF document. Can Add a Table to a PDF document. Can Add a Table of Contents to PDF document.

Represents Documentize.PdfManager plugin. Used to Merge, Split, Optimize, Rotate, Resize, Compress PDF documents and Add Table, Add TOC to PDF documents. Can Merge multiple PDF documents into a single PDF. Can Split PDF documents into separate pages. Can Optimize, Rotate, Resize, Compress PDF documents. Can Rotate, Resize Pages of PDF document. Can Add a Table to a PDF document. Can Add a Table of Contents to PDF document.

public static class PdfManager

Inheritance

objectPdfManager

Inherited Members

Methods

AddTable(TableOptions)

Add Table to PDF document.

public static ResultContainer AddTable(TableOptions options)

Parameters

  • options TableOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Add Table to PDF file.

// Configure table options
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");
// 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
PdfManager.AddTable(options);

The example demonstrates how to Add Table to PDF file before 2 page.

// Configure table options
var options = new TableOptions();
options.InsertPageBefore(2) // Add table before page 2
   .AddTable()
        .AddRow()
            .AddCell().AddParagraph("Name")
            .AddCell().AddParagraph("Age");
// 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
PdfManager.AddTable(options);

Exceptions

ArgumentException

If options not set.

AddTableOfContents(TocOptions)

Add Table of Contents (TOC) to PDF document.

public static ResultContainer AddTableOfContents(TocOptions options)

Parameters

  • options TocOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to add Table of Contents to PDF file.

// 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
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file with generating bookmarks.

// 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
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file and save as 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
PdfManager.AddTableOfContents(options);

The example demonstrates how to add Table of Contents to PDF file with Customizing the TOC Heading.

// Create TocOptions object to set instructions
var heading = new TocHeading();
heading.Text = "Intro";
heading.PageNumber = 5;
heading.GenerateNumbering = true;
heading.Level = 2;
var tocOptions = new TocOptions();
tocOptions.Headings.Add(heading);
// Add input and output files
tocOptions.AddInput(new FileData("path_to_your_pdf_file.pdf"));
tocOptions.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Generate the TOC with customized options
PdfManager.AddTableOfContents(tocOptions);

Exceptions

ArgumentException

If options not set.

Compress(CompressOptions)

Compress PDF document. Try to reduce size of the document.

public static ResultContainer Compress(CompressOptions options)

Parameters

  • options CompressOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Compress PDF document.

// Create CompressOptions object to set instructions
var options = new CompressOptions();
// 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
PdfManager.Compress(options);

Exceptions

ArgumentException

If options not set.

CreatePdfByChatGptRequestAsync(ChatGptRequestOptions)

Create PDF document by Reply of ChatGpt. Used to send requests to ChatGPT directly or by adding PDF file sources and save the reply to the output source.

public static Task<resultcontainer> CreatePdfByChatGptRequestAsync(ChatGptRequestOptions options)

Parameters

Returns

Task<ResultContainer>

An object containing the result of the operation.

Examples

The example demonstrates how to use ChatGpt by adding messages to the request.

var options = new ChatGptRequestOptions();
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); 
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request messages.
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
});

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

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

The example demonstrates how to use ChatGpt by adding one message to the request.

var options = new ChatGptRequestOptions();
options.AddOutput(new FileData("path_to_result_pdf_file.pdf")); // Add the output file path.
options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "What is the lowest temperature recorded on the Earth?";

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

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

The example demonstrates how to use Chat by adding file(s) as the message source(s).

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

// Add the PDF text source.
// In case of multiple sources, the text from each document will be added to the request message collection
// as a separate message with the role "user".
options.AddInput(new FileData("TextSource.pdf"));

options.ApiKey = "Your API key."; // You need to provide the key to access the API.
options.MaxTokens = 1000; // The maximum number of tokens to generate in the chat completion.

// Add the request message.
// In this case, the system message with Content = "You are a helpful assistant." is added by default.
// The role of the query message is "user" by default.
options.Query = "How many letters in the provided text?";

// Process the request.
var result = await PdfManager.CreatePdfByChatGptRequestAsync(options);

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

Exceptions

ArgumentException : If options not set.

Merge(MergeOptions)

Merge PDF documents.

public static ResultContainer Merge(MergeOptions options)

Parameters

  • options MergeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Merge two PDF documents.

// Create MergeOptions object to set instructions
var options = new MergeOptions();
// Add input file paths
options.AddInput(new FileData("path_to_your_pdf_file_1.pdf"));
options.AddInput(new FileData("path_to_your_pdf_file_2.pdf"));
// Set output file path
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfManager.Merge(options);

Exceptions

ArgumentException

If options not set.

Optimize(OptimizeOptions)

Optimize PDF document. Linearize the document in order to

  • open the first page as quickly as possible;
  • display next page or follow by link to the next page as quickly as possible;
  • display the page incrementally as it arrives when data for a page is delivered over a slow channel (display the most useful data first);
  • permit user interaction, such as following a link, to be performed even before the entire page has been received and displayed.
public static ResultContainer Optimize(OptimizeOptions options)

Parameters

  • options OptimizeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Optimize PDF document.

// Create OptimizeOptions object to set instructions
var options = new OptimizeOptions();
// 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
PdfManager.Optimize(options);

Exceptions

ArgumentException

If options not set.

Resize(ResizeOptions)

Resize Pages of PDF document.

public static ResultContainer Resize(ResizeOptions options)

Parameters

  • options ResizeOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Resize PDF document.

// Create ResizeOptions object to set instructions
var options = new ResizeOptions();
// Set new PageSize
options.PageSize = PageSize.A3;
// 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
PdfManager.Resize(options);

Exceptions

ArgumentException

If options not set.

Rotate(RotateOptions)

Rotate Pages of PDF document.

public static ResultContainer Rotate(RotateOptions options)

Parameters

  • options RotateOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Rotate PDF document.

// Create RotateOptions object to set instructions
var options = new RotateOptions();
// Set new Rotation
options.Rotation = Rotation.On90;
// 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
PdfManager.Rotate(options);

Exceptions

ArgumentException

If options not set.

Split(SplitOptions)

Split PDF document by pages.

public static ResultContainer Split(SplitOptions options)

Parameters

  • options SplitOptions: An options object containing instructions for the operation.

Returns

ResultContainer : An object containing the result of the operation.

Examples

The example demonstrates how to Split PDF document.

// Create SplitOptions object to set instructions
var options = new SplitOptions();
// Add input file path
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
// Set output file paths
options.AddOutput(new FileData("path_to_result_pdf_file_1.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file_2.pdf"));
// Perform the process
PdfManager.Split(options);

Exceptions

ArgumentException

If options not set.

Namespace: Documentize Assembly: Documentize.dll

Class PdfProperties

Info

Mewakili Properti dan informasi meta dokumen PDF.

public class PdfProperties

Pewarisan

objectPdfProperties

Anggota yang Diwarisi

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 plugin Documentize.PdfSecurity. Digunakan untuk Mengenkripsi, Mendekripsi, dan Menandatangani 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: Objek opsi yang berisi instruksi untuk operasi.

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh ini memperlihatkan cara Mendekripsi dokumen PDF.

// Create DecryptOptions object to set instructions
var options = new DecryptOptions("123456");
// 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
PdfSecurity.Decrypt(options);

Exceptions

ArgumentException

Jika opsi tidak disetel.

Encrypt(EncryptOptions)

Mengenkripsi dokumen PDF.

public static ResultContainer Encrypt(EncryptOptions options)

Parameters

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

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh ini memperlihatkan cara Mengenkripsi dokumen PDF.

// Create EncryptOptions object to set instructions
var options = new EncryptOptions("123456", "qwerty");
// 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
PdfSecurity.Encrypt(options);

Exceptions

ArgumentException

Jika opsi tidak disetel.

Sign(SignOptions)

Menandatangani dokumen PDF dengan tanda tangan digital.

public static ResultContainer Sign(SignOptions options)

Parameters

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

Returns

ResultContainer : Objek yang berisi hasil operasi.

Examples

Contoh ini memperlihatkan cara Menandatangani dokumen PDF.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 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
PdfSecurity.Sign(options);

Contoh ini memperlihatkan cara Menandatangani dokumen PDF dengan Stream berkas PFX.

using var pfxStream = File.OpenRead(@"path_to_your_pfx_file.pfx");
var options = new SignOptions(pfxStream, "password_of_your_pfx_file");
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Perform the process
PdfSecurity.Sign(options);

Contoh ini memperlihatkan cara Menandatangani dokumen PDF dengan tanda tangan tak terlihat.

var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
options.AddInput(new FileData("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileData("path_to_result_pdf_file.pdf"));
// Configure invisible signature
signOptions.Visible = false;
// Perform the process
PdfSecurity.Sign(options);

Contoh ini memperlihatkan cara Menandatangani dokumen PDF dengan opsi tambahan.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_of_your_pfx_file");
// 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"));
// Optional parameters
options.Reason = "my Reason";
options.Contact = "my Contact";
options.Location = "my Location";
options.PageNumber = 3;
// Perform the process
PdfSecurity.Sign(options);

Contoh ini memperlihatkan cara Menandatangani dokumen PDF dengan Timestamp.

// Create SignOptions object to set instructions
var options = new SignOptions("path_to_your_pfx_file.pfx", "password_for_your_pfx_file");
options.TimestampOptions = new TimestampOptions("server_url");
// 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
PdfSecurity.Sign(options);

Exceptions

ArgumentException

Jika opsi tidak disetel.

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

objectPluginBaseOptionsPdfToDocOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

PdfToDocOptions()

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

public PdfToDocOptions()

Properti

Mode

Memungkinkan mengontrol cara 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 lebih lanjut. Kotak teks mudah dimodifikasi ketika tidak banyak yang harus dilakukan.

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

Namespace: Documentize Assembly: Documentize.dll

Class PdfToHtmlOptions

Info

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

public sealed class PdfToHtmlOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsPdfToHtmlOptions

Mengimplementasikan

Anggota yang Diwarisi

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

Inheritance

objectPluginBaseOptionsPdfToJpegOptions

Implements

Inherited Members

Constructors

PdfToJpegOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToJpegOptions.

public PdfToJpegOptions()

Properties

OutputResolution

Mendapatkan atau mengatur nilai resolusi gambar hasil.

public int OutputResolution { get; set; }

Property Value

int

PageList

Mendapatkan atau mengatur daftar halaman untuk proses.

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

Property Value

List<int>

Quality

Mendapatkan dan mengatur 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 oleh karena itu kualitas gambar semakin rendah. Nol akan menghasilkan gambar dengan kualitas terendah dan 100 menghasilkan kualitas tertinggi.

public int Quality { get; set; }

Property Value

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 stream) 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 stream) 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 Ditarik

Konstruktor

PdfToPngOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToPngOptions.

public PdfToPngOptions()

Properti

OutputResolution

Mendapatkan atau mengatur nilai resolusi gambar yang dihasilkan.

public int OutputResolution { get; set; }

Nilai Properti

int

PageList

Mendapatkan atau mengatur 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

Inheritance

objectPluginBaseOptionsPdfToTiffOptions

Implements

Inherited Members

Constructors

PdfToTiffOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToTiffOptions.

public PdfToTiffOptions()

Properties

ColorDepth

Mendapatkan atau mengatur kedalaman warna.

public TiffColorDepth ColorDepth { get; set; }

Property Value

TiffColorDepth

Remarks

Nilai default adalah Documentize.TiffColorDepth.Format32bpp.

Compression

Mendapatkan atau mengatur jenis Kompresi.

public TiffCompression Compression { get; set; }

Property Value

TiffCompression

Remarks

Nilai default adalah Documentize.TiffCompression.LZW.

MultiPage

Mendapatkan dan mengatur flag yang memungkinkan menyimpan semua halaman dalam satu file tiff multi‑halaman. Nilai default adalah false.

public bool MultiPage { get; set; }

Property Value

bool

OutputResolution

Mendapatkan atau mengatur nilai resolusi gambar hasil.

public int OutputResolution { get; set; }

Property Value

int

PageList

Mendapatkan atau mengatur daftar halaman untuk proses.

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

Property Value

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

Inheritance

objectPluginBaseOptionsPdfToXlsOptions

Implements

Inherited Members

Constructors

PdfToXlsOptions()

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

public PdfToXlsOptions()

Properties

Format

Format output.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

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

Property Value

bool

MinimizeTheNumberOfWorksheets

Setel ke true jika Anda ingin meminimalkan jumlah lembar kerja dalam buku kerja yang dihasilkan. Nilai default adalah false; artinya setiap halaman PDF akan disimpan sebagai lembar kerja terpisah.

public bool MinimizeTheNumberOfWorksheets { get; set; }

Property Value

bool

Namespace: Documentize Assembly: Documentize.dll

Class PluginBaseOptions

Info

Mewakili opsi dasar untuk plugin.

public class PluginBaseOptions : IPluginOptions

Pewarisan

objectPluginBaseOptions

Turunan

Mengimplementasikan

Anggota yang Dipewarisi

Properti

CloseInputStreams

Tutup aliran masukan setelah operasi selesai.

public bool CloseInputStreams { get; set; }

Nilai Properti

bool

CloseOutputStreams

Tutup aliran keluaran 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

Warisan

objectPngConverter

Anggota yang Dwarisi

Metode

Process(PdfToPngOptions)

Mengonversi dokumen PDF ke format PNG.

public static ResultContainer Process(PdfToPngOptions options)

Parameter

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class Rectangle

Info

Class represents rectangle.

public class Rectangle

Inheritance

objectRectangle

Inherited Members

Constructors

Rectangle(double, double, double, double)

Konstruktor dari Rectangle.

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

Parameters

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

Namespace: Documentize Assembly: Documentize.dll

Class RemoveFieldsOptions

Info

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

public class RemoveFieldsOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsRemoveFieldsOptions

Mengimplementasikan

Anggota yang Diwariskan

Konstruktor

RemoveFieldsOptions()

Menginisialisasi 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 Diwarisi

Konstruktor

ResizeOptions()

Menginisialisasi sebuah 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 wadah yang berisi koleksi hasil dari pemrosesan plugin.

public class ResultContainer

Inheritance

objectResultContainer

Inherited Members

Properties

ResultCollection

Mengambil koleksi hasil dari operasi

public List<ioperationresult> ResultCollection { get; }

Property Value

List<IOperationResult>

Namespace: Documentize Assembly: Documentize.dll

Class RotateOptions

Info

Mewakili opsi putar untuk plugin Documentize.PdfManager.

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsRotateOptions

Mengimplementasikan

Anggota yang diwariskan

Konstruktor

RotateOptions()

Menginisialisasi sebuah 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 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: Sebuah objek opsi yang berisi instruksi untuk operasi.

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Eksepsi

ArgumentException

Jika opsi tidak diatur.

Process(DecryptOptions)

Mendekripsi Dokumen PDF.

public static ResultContainer Process(DecryptOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Eksepsi

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class Signature

Info

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

[Obsolete("Kelas ini akan dihapus segera. Silakan gunakan kelas PdfSecurity.")]
public static class Signature

Pewarisan

objectSignature

Anggota yang diwarisi

Metode

Process(SignOptions)

Menandatangani dokumen PDF.

public static ResultContainer Process(SignOptions options)

Parameter

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class SignOptions

Info

Mewakili Opsi Penandatanganan untuk plugin Documentize.PdfSecurity.

public sealed class SignOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsSignOptions

Implements

Inherited Members

Constructors

SignOptions(string, string)

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

public SignOptions(string pfx, string password)

Parameters

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

SignOptions(Stream, string)

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

public SignOptions(Stream pfx, string password)

Parameters

  • pfx Stream: Stream dengan file pfx.
  • password string: Kata sandi untuk file pfx.

Properties

Contact

Kontak tanda tangan.

public string Contact { get; set; }

Property Value

string

Location

Lokasi tanda tangan.

public string Location { get; set; }

Property Value

string

Name

Nama bidang tanda tangan yang ada. Null untuk membuat bidang baru.

public string Name { get; set; }

Property Value

string

PageNumber

Nomor halaman tempat tanda tangan dibuat.

public int PageNumber { get; set; }

Property Value

int

Reason

Alasan tanda tangan.

public string Reason { get; set; }

Property Value

string

Rectangle

Kotak tanda tangan.

public Rectangle Rectangle { get; set; }

Property Value

Rectangle

TimestampOptions

Opsi Timestamp.

public TimestampOptions TimestampOptions { get; set; }

Property Value

TimestampOptions

Visible

Visibilitas tanda tangan.

public bool Visible { get; set; }

Property Value

bool

Namespace: Documentize Assembly: Documentize.dll

Class SplitOptions

Info

Mewakili opsi Split untuk plugin Documentize.PdfManager.

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Inheritance

objectPluginBaseOptionsSplitOptions

Implements

Inherited Members

Constructors

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("Kelas ini akan dihapus segera. Silakan gunakan kelas PdfManager.")]
public static class Splitter

Pewarisan

objectSplitter

Anggota yang diwarisi

Metode

Process(SplitOptions)

Bagi dokumen PDF berdasarkan halaman.

public static ResultContainer Process(SplitOptions options)

Parameter

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

Mengembalikan

ResultContainer : Objek yang berisi hasil dari operasi.

Eksepsi

ArgumentException

Jika opsi tidak diatur.

Namespace: Documentize Assembly: Documentize.dll

Class StreamData

Info

Mewakili data aliran untuk operasi memuat dan menyimpan.

public sealed class StreamData : IData

Inheritance

objectStreamData

Implements

Inherited Members

Constructors

StreamData(Stream)

Menginisialisasi sumber data aliran baru dengan objek aliran yang ditentukan.

public StreamData(Stream data)

Parameters

Properties

Data

Mendapatkan objek aliran dari sumber data saat ini.

public Stream Data { get; }

Property Value

Stream

DataType

Tipe data (aliran).

public DataType DataType { get; }

Property Value

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

Warisan

objectStreamResult

Mengimplementasikan

Anggota yang Diwarisi

Properti

Data

Mendapatkan data mentah.

public object Data { get; }

Nilai Properti

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file keluaran.

public bool IsFile { get; }

Nilai Properti

bool

IsStream

Menunjukkan apakah hasilnya adalah jalur ke file keluaran.

public bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasilnya adalah string.

public bool IsString { get; }

Nilai Properti

bool

Metode

ToFile()

Mencoba mengonversi hasil ke file.

public string ToFile()

Mengembalikan

string : Sebuah string yang mewakili jalur ke file keluaran jika hasilnya adalah file; jika tidak null.

ToStream()

Mencoba mengonversi hasil ke objek stream.

public Stream ToStream()

Mengembalikan

Stream : Sebuah objek stream yang mewakili data keluaran jika hasilnya adalah stream; jika tidak null.

Namespace: Documentize Assembly: Documentize.dll

Class StringResult

Info

Mewakili hasil operasi dalam bentuk string.

public sealed class StringResult : IOperationResult

Warisan

objectStringResult

Mengimplementasikan

Anggota yang Dwarisi

Properti

Data

Mendapatkan data mentah.

public object Data { get; }

Nilai Properti

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file output.

public bool IsFile { get; }

Nilai Properti

bool

IsStream

Menunjukkan apakah hasilnya adalah jalur ke file output.

public bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasilnya adalah string.

public bool IsString { get; }

Nilai Properti

bool

Text

Mengembalikan representasi string dari hasil.

public string Text { get; }

Nilai Properti

string

Metode

ToFile()

Mencoba mengonversi hasil ke file.

public string ToFile()

Mengembalikan

string : Sebuah string yang mewakili jalur ke file output jika hasilnya adalah file; jika tidak null.

ToStream()

Mencoba mengonversi hasil ke objek stream.

public Stream ToStream()

Mengembalikan

Stream : Sebuah objek stream yang mewakili data output jika hasilnya adalah stream; jika tidak null.

ToString()

Mencoba mengonversi hasil ke string.

public override string ToString()

Mengembalikan

string : Sebuah string yang mewakili konten teks jika hasilnya adalah string; jika tidak mengembalikan base.ToString().

Namespace: Documentize Assembly: Documentize.dll

Class TableBuilder

Info

Kelas ini mewakili pembangun untuk tabel di halaman pdf.

public class TableBuilder

Pewarisan

objectTableBuilder

Turunan

Anggota yang diwarisi

Metode

AddRow()

Menambahkan baris baru ke tabel.

public virtual TableRowBuilder AddRow()

Mengembalikan

TableRowBuilder : Instance dari Documentize.TableRowBuilder saat ini.

AddTable()

Menambahkan tabel baru ke dokumen.

public TableBuilder AddTable()

Mengembalikan

TableBuilder : Instance dari Documentize.TableBuilder saat ini.

InsertPageAfter(int)

Menyisipkan 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)

Menyisipkan 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

implicit operator TableOptions(TableBuilder)

Mengonversi pembangun 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 ini merepresentasikan builder untuk sel tabel.

public class TableCellBuilder : TableRowBuilder

Pewarisan

objectTableBuilderTableRowBuilderTableCellBuilder

Anggota yang Dwarisi

Metode

AddCell()

Tambahkan sel ke tabel.

public override TableCellBuilder AddCell()

Mengembalikan

TableCellBuilder : Instance dari Documentize.TableCellBuilder saat ini.

AddParagraph(params string[])

Tambahkan paragraf ke sel tabel.

public TableCellBuilder AddParagraph(params string[] paragraphs)

Parameter

  • paragraphs string[]: Teks untuk Paragraf.

Mengembalikan

TableCellBuilder : Instance dari Documentize.TableCellBuilder saat ini.

Namespace: Documentize Assembly: Documentize.dll

Class TableGenerator

Info

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

Pewarisan

objectTableGenerator

Anggota yang Diwarisi

Contoh

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

Metode

Process(TableOptions)

Menambahkan tabel ke dokumen PDF.

public static ResultContainer Process(TableOptions options)

Parameter

  • options TableOptions: 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 TableOptions

Info

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

public sealed class TableOptions : PluginBaseOptions, IPluginOptions

Pewarisan

objectPluginBaseOptionsTableOptions

Mengimplementasikan

Anggota yang Diwarisi

Konstruktor

TableOptions()

Menginisialisasi instance baru dari objek Documentize.TableOptions dengan opsi standar.

public TableOptions()

Metode

AddTable()

Menambahkan tabel ke dokumen.

public TableBuilder AddTable()

Mengembalikan

TableBuilder : Instance baru dari Documentize.TableBuilder.

Create()

Membuat instance Documentize.TableOptions.

public static TableOptions Create()

Mengembalikan

TableOptions : Instance baru dari Documentize.TableOptions.

InsertPageAfter(int)

Menyisipkan halaman setelah halaman yang ditentukan.

public TableOptions InsertPageAfter(int page)

Parameter

  • page int: Nomor halaman tempat menyisipkan tabel setelahnya.

Mengembalikan

TableOptions : Instance dari Documentize.TableOptions yang sedang aktif.

InsertPageBefore(int)

Menyisipkan halaman sebelum halaman yang ditentukan.

public TableOptions InsertPageBefore(int page)

Parameter

  • page int: Nomor halaman tempat menyisipkan tabel sebelum nya.

Mengembalikan

TableOptions : Instance dari Documentize.TableOptions yang sedang aktif.

Namespace: Documentize Assembly: Documentize.dll

Class TableRowBuilder

Info

Class ini mewakili builder untuk baris tabel.

public class TableRowBuilder : TableBuilder

Pewarisan

objectTableBuilderTableRowBuilder

Turunan

Anggota yang Diwarisi

Metode

AddCell()

Menambahkan sel ke baris tabel.

public virtual TableCellBuilder AddCell()

Mengembalikan

TableCellBuilder : Instansi dari Documentize.TableCellBuilder yang dibuat.

AddRow()

Mengganti AddRow.

public override TableRowBuilder AddRow()

Mengembalikan

TableRowBuilder : Instansi dari Documentize.TableRowBuilder saat ini.

Namespace: Documentize Assembly: Documentize.dll

Class TextExtractor

Info

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

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

Pewarisan

objectTextExtractor

Anggota yang Dihwarisi

Metode

Process(ExtractTextOptions)

Mengekstrak teks dari dokumen PDF.

public static string Process(ExtractTextOptions options)

Parameter

Mengembalikan

string : Sebuah objek yang berisi hasil ekstraksi.

Pengecualian

ArgumentException

Jika opsi tidak diset.

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 TiffConverter

Info

Mewakili plugin Documentize.TiffConverter. Digunakan untuk mengonversi dokumen PDF ke format TIFF.

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

Inheritance

objectTiffConverter

Inherited Members

Methods

Process(PdfToTiffOptions)

Mengonversi dokumen PDF ke format TIFF.

public static ResultContainer Process(PdfToTiffOptions options)

Parameters

Returns

ResultContainer : Objek yang berisi hasil dari operasi.

Exceptions

ArgumentException

Jika opsi tidak diatur.

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

Warisan

objectTimestampOptions

Anggota yang Diwarisi

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

Mengambil/mengatur kredensial otentikasi dasar, Nama pengguna dan kata sandi digabungkan menjadi string “username:password”.

public string BasicAuthCredentials { get; set; }

Nilai Properti

string

ServerUrl

Mengambil/mengatur 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

Warisan

objectTocGenerator

Anggota yang Diwarisi

Contoh

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

Metode

Process(TocOptions)

Memulai pemrosesan Documentize.TocGenerator dengan parameter yang ditentukan.

public static ResultContainer Process(TocOptions options)

Parameter

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

Mengembalikan

ResultContainer : Objek Documentize.ResultContainer yang berisi hasil operasi.

Namespace: Documentize Assembly: Documentize.dll

Class TocHeading

Info

Mewakili opsi untuk Judul atau Title 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 Judul.
  • pageNumber int: Nomor Halaman untuk tautan.
  • generateNumbering bool: Menggunakan Pembuatan Nomor.
  • level int: Level.

Properties

GenerateNumbering

Menggunakan Pembuatan Nomor. Jika true, maka penomoran harus dilakukan secara otomatis; jika tidak, penomoran harus dilakukan secara manual.

public bool GenerateNumbering { get; set; }

Property Value

bool

Level

Level. 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 Title.

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

Pewarisan

objectPluginBaseOptionsTocOptions

Mengimplementasikan

Anggota yang Diteruskan

Konstruktor

TocOptions()

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

public TocOptions()

Properti

GenerateBookmarks

Menggunakan pembuatan Bookmark. Jika diset true maka Bookmark akan dibersihkan dan dibuat berdasarkan Heading; jika tidak, Bookmark tidak akan berubah.

public bool GenerateBookmarks { get; set; }

Nilai Properti

bool

Headings

Heading atau Judul untuk Daftar Isi.

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

Nilai Properti

List<TocHeading>

Title

Judul untuk Daftar Isi.

public string Title { get; set; }

Nilai Properti

string

Namespace: Documentize Assembly: Documentize.dll

Class Usage

Info

Statistik penggunaan untuk permintaan penyelesaian.

public class Usage

Pewarisan

objectUsage

Anggota Yang Diwarisi

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

Namespace: Documentize Assembly: Documentize.dll

Class XlsConverter

Info

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

[Obsolete("Kelas ini akan dihapus segera. Harap gunakan kelas PdfConverter.")]
public static class XlsConverter

Inheritance

objectXlsConverter

Inherited Members

Methods

Process(PdfToXlsOptions)

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

public static ResultContainer Process(PdfToXlsOptions options)

Parameters

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

Returns

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Exceptions

ArgumentException

Jika opsi tidak disetel.

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertErrorAction

Info

Kelas ini merepresentasikan tindakan untuk kesalahan konversi.

public enum ConvertErrorAction

Fields

  • Delete = 0
  • None = 1

Namespace: Documentize Assembly: Documentize.dll

Enum ConvertSoftMaskAction

Info

Aksi ini mewakili tindakan untuk konversi gambar dengan mask lembut.

public enum ConvertSoftMaskAction

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum DataType

Info

Mewakili kemungkinan jenis data untuk pemrosesan plugin.

public enum DataType

Fields

  • Directory = 2: Tipe data adalah direktori yang diwakili oleh jalur ke direktori tersebut.
  • File = 0: Tipe data adalah file yang diwakili oleh jalur ke file tersebut.
  • Stream = 1: Tipe data adalah stream.

Namespace: Documentize Assembly: Documentize.dll

Enum DocConversionMode

Info

Mendefinisikan mode konversi dari dokumen keluaran.

public enum DocConversionMode

Fields

  • Flow = 1: Mode pengenalan penuh, mesin melakukan pengelompokan dan analisis multi-level untuk mengembalikan niat asli penulis dokumen dan menghasilkan dokumen yang dapat diedit maksimal. Kekurangan dari mode ini adalah dokumen keluaran mungkin terlihat berbeda dari file PDF asli.
  • TextBox = 0: Mode ini cepat dan baik untuk memaksimalkan pelestarian tampilan asli file PDF, tetapi ketereditan dokumen yang dihasilkan bisa terbatas. Setiap blok teks yang dikelompokkan secara visual dalam file PDF asli diubah menjadi sebuah textbox dalam dokumen yang dihasilkan. Ini mencapai kesamaan maksimal dokumen keluaran dengan file PDF asli. Dokumen keluaran akan terlihat baik, tetapi akan sepenuhnya terdiri dari textbox dan dapat membuat pengeditan lebih lanjut dokumen 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

Fields

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

Namespace: Documentize Assembly: Documentize.dll

Enum HtmlPageLayoutOption

Info

Menetapkan bendera yang bersama 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 konten dokumen akan diskalakan untuk sesuai dengan halaman.

Namespace: Documentize Assembly: Documentize.dll

Enum PdfAStandardVersion

Info

Menentukan versi standar PDF/A untuk dokumen PDF.

public enum PdfAStandardVersion

Fields

  • 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

Menentukan jenis keluaran file HTML.

public enum PdfToHtmlOptions.SaveDataType

Fields

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

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 yang dipisahkan dengan koma (.csv).
  • ODS = 4: Open Document Spreadsheet.
  • XLSM = 3: Format File Office Open XML yang diaktifkan makro (.xlsm).
  • XLSX = 1: Format File Office Open XML (.xlsx).
  • XMLSpreadSheet2003 = 0: Format File XML Excel 2003 (.xls).

Namespace: Documentize Assembly: Documentize.dll

Enum Role

Info

Peran penulis pesan.

public enum Role

Fields

  • 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 pada 180 derajat.
  • On270 = 3: Diputar pada 270 derajat searah jarum jam.
  • On360 = 4: Diputar pada 360 derajat searah jarum jam.
  • On90 = 1: Diputar pada 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

Menentukan berbagai mode yang dapat digunakan saat mengonversi dokumen PDF menjadi teks. Lihat kelas Documentize.ExtractTextOptions.

public enum TextFormattingMode

Fields

  • Flatten = 2: Mewakili konten PDF dengan memposisikan fragmen teks menurut koordinat mereka. Ini pada dasarnya mirip dengan mode “Raw”. Tetapi sementara “Raw” berfokus pada mempertahankan struktur fragmen teks (operator) dalam dokumen, “Flatten” berfokus pada menjaga teks dalam urutan pembacaan.
  • Pure = 0: Mewakili konten teks PDF dengan beberapa rutinitas pemformatan. Ini termasuk 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 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 bersama yang harus diimplementasikan oleh data konkret.

public interface IData

Properties

DataType

Tipe 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 mendefinisikan Data Input yang harus diimplementasikan oleh Options.

public interface IHaveInput

Properti

Input

Mendapatkan atau menetapkan 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 plugin konkret.

public interface IOperationResult

Properties

Data

Mengambil data mentah.

object Data { get; }

Nilai Properti

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file output.

bool IsFile { get; }

Nilai Properti

bool

IsStream

Menunjukkan apakah hasilnya adalah aliran output.

bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasilnya adalah string teks.

bool IsString { get; }

Nilai Properti

bool

Methods

ToFile()

Mencoba mengonversi hasil ke file.

string ToFile()

Mengembalikan

string : Sebuah string yang mewakili jalur ke file output jika hasilnya adalah file; jika tidak null.

ToStream()

Mencoba mengonversi hasil ke objek aliran.

Stream ToStream()

Mengembalikan

Stream : Sebuah objek aliran yang mewakili data output jika hasilnya adalah aliran; jika tidak null.

Namespace: Documentize Assembly: Documentize.dll

Interface IPluginOptions

Info

Antarmuka opsi plugin umum yang mendefinisikan metode umum yang harus diimplementasikan oleh opsi plugin 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

Lisensi Kelas

Info

Menyediakan metode untuk mengatur Lisensi.

public static class License

Pewarisan

objectLicense

Anggota yang diwarisi

Contoh

Menunjukkan cara mengaktifkan lisensi.

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

Metode

Set(string)

Melisensikan komponen.

public static void Set(string licenseName)

Parameter

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

Namespace: Documentize Assembly: Documentize.dll

 Indonesia