Class AddTimestampOptions

[Obsolete("Kelas ini akan dihapus segera. Harap gunakan kelas SignOptions.")]
public class AddTimestampOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← AddTimestampOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktor

AddTimestampOptions(Stream, string, string, string)

Menginisialisasi 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: Kata sandi untuk 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 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: Kata sandi untuk file pfx.
• serverUrl string: URL server timestamp.
• serverBasicAuthCredentials string: Kredensial otentikasi dasar, nama pengguna dan kata sandi digabungkan menjadi string “username:password”. (Opsional).

Class ChatCompletion

public class ChatCompletion  

Pewarisan

object ←
ChatCompletion

Anggota yang Warisan

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class ChatGptConsts

public static class ChatGptConsts

Pewarisan

object ← ChatGptConsts

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class ChatGptRequestOptions

public class ChatGptRequestOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← ChatGptRequestOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

• apiKey string: Kunci untuk mengakses API ChatGPT.
• model string: Nama model ChatGPT. Model default adalah: gpt-3.5-turbo-1106:
• apiUrl string: URL API ChatGPT. URL default adalah: https://api.openai.com/v1/chat/completions.
• query string: String permintaan untuk ChatGPT.

Properti

ApiKey

Mengambil atau mengatur kunci untuk mengakses API ChatGPT.

public string ApiKey { get; set; }

Nilai Properti

string

ApiUrl

Mengambil 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, berarti tidak terbatas.

public int? MaxTokens { get; set; }

Nilai Properti

int?

Messages

Mengambil 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, diikuti dengan pesan yang berisi: “Anda adalah asisten yang membantu.”, dan peran 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 diberikan, akan terjadi ArgumentException.

Model

Mengatur atau mengambil ID model yang akan digunakan.

public string Model { get; set; }

Nilai Properti

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Nilai Properti

int

Query

Mengambil atau mengatur string permintaan untuk 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 pengambilan sampel yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0.8 akan membuat keluaran 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; }

Nilai Properti

double

Class Choice

public class Choice

Pewarisan

object ← Choice

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← CompressOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

CompressOptions()

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

public CompressOptions()

Class DecryptionOptions

public class DecryptionOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← DecryptionOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class DecryptOptions

public class DecryptOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← DecryptOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

DecryptOptions(string)

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

public DecryptOptions(string ownerPassword)

Parameters

• ownerPassword string: Kata sandi pemilik.

Properties

OwnerPassword

Kata sandi pemilik.

public string OwnerPassword { get; set; }

Property Value

string

Class DirectoryDataSource

public sealed class DirectoryDataSource : IDataSource

Pewarisan

object ← DirectoryDataSource

Mengimplementasikan

• IDataSource

Anggota yang Dwarisi

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class DocConverter

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

Pewarisan

object ← DocConverter

Anggota yang diwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← EncryptionOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class EncryptOptions

public class EncryptOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← EncryptOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class ExtractFormDataToDsvOptions

public sealed class ExtractFormDataToDsvOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← ExtractFormDataToDsvOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktor

ExtractFormDataToDsvOptions(char, bool)

Menginisialisasi sebuah instance baru dari objek Documentize.ExtractFormDataToDsvOptions.

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

Parameter

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

Properti

AddFieldName

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

public bool AddFieldName { get; set; }

Nilai Properti

bool

Delimeter

Pemisah yang digunakan untuk nilai yang diekspor.

public char Delimeter { get; set; }

Nilai Properti

char

Class ExtractImagesOptions

public sealed class ExtractImagesOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← ExtractImagesOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktor

ExtractImagesOptions()

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

public ExtractImagesOptions()

Class ExtractTextOptions

public sealed class ExtractTextOptions

Inheritance

object ← ExtractTextOptions

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

ExtractTextOptions(TextFormattingMode)

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

public ExtractTextOptions(TextFormattingMode formattingMode = TextFormattingMode.Raw)

Parameters

• formattingMode TextFormattingMode: Nilai mode pemformatan teks.

Properties

FormattingMode

Mengambil mode pemformatan.

public TextFormattingMode FormattingMode { get; set; }

Property Value

TextFormattingMode

Inputs

Mengembalikan data Inputs untuk operasi.

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource>

Methods

AddInput(IDataSource)

Menambahkan Data baru ke Inputs.

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource: Sumber data yang akan ditambahkan. :

Class FileDataSource

public sealed class FileDataSource : IDataSource

Pewarisan

object ← FileDataSource

Mengimplementasikan

• IDataSource

Anggota yang Dwarisi

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class FileResult

public sealed class FileResult : IOperationResult

Pewarisan

object ← FileResult

Mengimplementasikan

• IOperationResult

Anggota yang Dwarisi

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class FormExporter

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

Warisan

object ← FormExporter

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Metode

Process(ExtractFormDataToDsvOptions)

Memulai pemrosesan Documentize.FormExporter dengan parameter yang ditentukan.

public static ResultContainer Process(ExtractFormDataToDsvOptions options)

Parameter

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

Mengembalikan

ResultContainer : Objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Class FormExportToDsvOptions

public sealed class FormExportToDsvOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← FormExportToDsvOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class FormFlattener

public static class FormFlattener

Inheritance

object ← FormFlattener

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

Contoh ini menunjukkan cara meratakan field dalam file PDF.

// Buat objek FormFlattenerOptions untuk mengatur instruksi
var options = new FormFlattenerOptions();
// Tambahkan jalur file input
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
// Atur jalur file output
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Lakukan proses
FormFlattener.Process(options);

Contoh ini menunjukkan cara meratakan field dalam file PDF dan melewatkan field pertama.

// Dapatkan Nama Field
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");
// Buat objek FormFlattenerOptions untuk mengatur instruksi
var options = new FormFlattenerOptions();
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf"));
options.AddOutput(new FileDataSource("path_to_result_pdf_file.pdf"));
// Lewati 1 field.
options.SkipFields.Add(fieldNames[0]);
// Lakukan proses
FormFlattener.Process(options);

Contoh ini menunjukkan cara mendapatkan Nama Field dari file PDF.

// Dapatkan Nama Field
var fieldNames = FormFlattener.GetFieldNames("path_to_your_pdf_file.pdf");

Methods

GetFieldNames(string)

Dapatkan Nama Field dalam Dokumen PDF.

public static List<string> GetFieldNames(string path)

Parameters

• path string: Jalur ke Dokumen PDF.

Returns

List<string>

Daftar nama dalam Dokumen PDF.

GetFieldNames(Stream) : Dapatkan Nama Field dalam Dokumen PDF.

public static List<string> GetFieldNames(Stream stream)

Parameters

• stream Stream: Stream dengan Dokumen PDF.

Returns

List<string>

Daftar nama dalam Dokumen PDF.

Process(FormFlattenerOptions) : Ratakan field Form dalam dokumen PDF.

public static ResultContainer Process(FormFlattenerOptions options)

Parameters

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

Returns

ResultContainer : Objek yang berisi hasil dari operasi.

Exceptions

ArgumentException

Jika opsi tidak diatur.

Class FormFlattenerOptions

public class FormFlattenerOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← FormFlattenerOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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>

Class HtmlConverter

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

Pewarisan

object ← HtmlConverter

Anggota Yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class HtmlToPdfOptions

public sealed class HtmlToPdfOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← HtmlToPdfOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

HtmlToPdfOptions()

Menginisialisasi instance baru dari objek Documentize.HtmlToPdfOptions.

public HtmlToPdfOptions()

Properties

BasePath

Jalur/url dasar untuk file html.

public string BasePath { get; set; }

Property Value

string

HtmlMediaType

Mendapatkan atau menetapkan jenis media yang mungkin digunakan selama rendering.

public HtmlMediaType HtmlMediaType { get; set; }

Property Value

HtmlMediaType

IsRenderToSinglePage

Mendapatkan atau menetapkan rendering seluruh dokumen ke halaman tunggal.

public bool IsRenderToSinglePage { get; set; }

Property Value

bool

PageInfo

Mendapatkan atau menetapkan info halaman dokumen.

public PageInfo PageInfo { get; set; }

Property Value

PageInfo

PageLayoutOption

Mendapatkan atau menetapkan opsi tata letak.

public HtmlPageLayoutOption PageLayoutOption { get; set; }

Property Value

HtmlPageLayoutOption

Class ImageExtractor

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

Inheritance

object ← ImageExtractor

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Methods

Process(ExtractImagesOptions)

Ekstrak gambar dari dokumen PDF.

public static ResultContainer Process(ExtractImagesOptions options)

Parameters

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

Returns

ResultContainer : Objek yang berisi hasil dari operasi tersebut.

Exceptions

ArgumentException

Jika opsi tidak diatur.

Class ImageExtractorOptions

public sealed class ImageExtractorOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← ImageExtractorOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktor

ImageExtractorOptions()

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

public ImageExtractorOptions()

Class Info

public static class Info

Inheritance

object ← Info

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Fields

• AssemblyVersion Versi Assembly.

public const string AssemblyVersion = “25.11.0”

#### Field Value

 [string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="Documentize_Info_Product"></a> Product

Nama Produk.

```csharp
public const string Product = "Documentize"

Field Value

string

Class JpegConverter

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

Pewarisan

object ← JpegConverter

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← MergeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

MergeOptions()

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

public MergeOptions()

Class Merger

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

Pewarisan

object ← Merger

Anggota yang diwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class Message

public class Message

Inheritance

object ← Message

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class ObjectResult

public sealed class ObjectResult : IOperationResult  

Inheritance

object ←
ObjectResult

Implements

• IOperationResult

Inherited Members

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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().

Class OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Inheritance

object ← PluginBaseOptions ← OptimizeOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

OptimizeOptions()

Menginisialisasi instance baru dari objek Documentize.OptimizeOptions dengan opsi bawaan. 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 untuk halaman dikirim melalui saluran yang lambat (menampilkan data yang paling berguna terlebih dahulu);
• mengizinkan interaksi pengguna, seperti mengikuti tautan, dilakukan bahkan sebelum seluruh halaman diterima dan ditampilkan.

public OptimizeOptions()

Class Optimizer

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

Pewarisan

object ← Optimizer

Anggota yang Diwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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.

Class PageInfo

public class PageInfo : PageSize  

Warisan

object ←
PageSize ←
PageInfo

Anggota yang Dwarisi

• PageSize.Width,
• PageSize.Height,
• PageSize.IsLandscape,
• PageSize.A0,
• PageSize.A1,
• PageSize.A2,
• PageSize.A3,
• PageSize.A4,
• PageSize.A5,
• PageSize.A6,
• PageSize.B5,
• PageSize.PageLetter,
• PageSize.PageLegal,
• PageSize.PageLedger,
• PageSize.P11x17,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructor

PageInfo()

Konstruktor dari Documentize.PageInfo.

public PageInfo()  

PageInfo(double, double)

Konstruktor dari Documentize.PageInfo.

public PageInfo(double width, double height)  

Parameter

• width double: Lebar halaman.
• height double: Tinggi halaman.

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

Class PageSize

public class PageSize

Pewarisan

object ← PageSize

Turunan

• PageInfo

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

• width double: Lebar halaman.
• height double: Tinggi halaman.

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

PageLegal

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

Class PdfAConverter

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

Pewarisan

object ← PdfAConverter

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

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

Mengembalikan

ResultContainer : Sebuah objek yang berisi hasil dari operasi.

Pengecualian

ArgumentException

Jika opsi tidak diatur.

Class PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Inheritance

object ← PdfAOptionsBase ← PdfAConvertOptions

Implements

• IPluginOptions

Inherited Members

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class PdfAOptionsBase

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

public abstract class PdfAOptionsBase : IPluginOptions

Inheritance

object ← PdfAOptionsBase

Derived

• PdfAValidateOptions,
• PdfToPdfAOptions

Implements

• IPluginOptions

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Constructors

PdfAOptionsBase()

protected PdfAOptionsBase()

Properties

AlignText

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

public bool AlignText { get; set; }

Property Value

bool

Remarks

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

CheckDifferentNamesInFontDictionaries

Mendapatkan bendera 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 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 sebagai pengganti yang default.

public string IccProfileFileName { get; set; }

Property Value

string

Inputs

Mendapatkan kumpulan sumber data

public List<idatasource> Inputs { get; }

Property Value

List<IDataSource>

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 IDataSource LogOutputSource { get; set; }

Property Value

IDataSource

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

Saat disetel ke true, proses konversi akan berusaha meminimalkan ukuran file yang dihasilkan. Ini mungkin mempengaruhi kinerja proses konversi.

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }

Property Value

PdfAStandardVersion

Remarks

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

SoftMaskAction

Mendapatkan atau mengatur tindakan yang diambil selama konversi gambar dengan masker lunak.

public ConvertSoftMaskAction SoftMaskAction { get; set; }

Property Value

ConvertSoftMaskAction

Methods

AddInput(IDataSource)

Menambahkan sumber data baru ke koleksi

public void AddInput(IDataSource dataSource)

Parameters

• dataSource IDataSource:

Class PdfAValidateOptions

public sealed class PdfAValidateOptions : PdfAOptionsBase, IPluginOptions

Warisan

object ← PdfAOptionsBase ← PdfAValidateOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• PdfAOptionsBase.AddInput(IDataSource),
• PdfAOptionsBase.Inputs,
• PdfAOptionsBase.PdfAVersion,
• PdfAOptionsBase.IsLowMemoryMode,
• PdfAOptionsBase.LogOutputSource,
• PdfAOptionsBase.ErrorAction,
• PdfAOptionsBase.SoftMaskAction,
• PdfAOptionsBase.CheckDifferentNamesInFontDictionaries,
• PdfAOptionsBase.AlignText,
• PdfAOptionsBase.OptimizeFileSize,
• PdfAOptionsBase.IccProfileFileName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Konstruktor

PdfAValidateOptions()

public PdfAValidateOptions()

Class PdfAValidationResult

public sealed class PdfAValidationResult

Warisan

object ← PdfAValidationResult

Anggota yang diwarisi

• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Fields

• DataSource Mendapatkan sumber data yang telah divalidasi.

Nilai Field

IDataSource

IsValid

Mendapatkan nilai yang menunjukkan apakah validasi berhasil.

public readonly bool IsValid

Nilai Field

bool

StandardVersion

Mendapatkan versi standar PDF/A yang digunakan untuk validasi.

public readonly PdfAStandardVersion StandardVersion

Nilai Field

PdfAStandardVersion

Class PdfChatGpt

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

Pewarisan

object ← PdfChatGpt

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Pewarisan

object ← PdfChatGptOptions

Turunan

• PdfChatGptRequestOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

Class PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Inheritance

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Implements

• IPluginOptions

Inherited Members

• PdfChatGptOptions.AddInput(IDataSource),
• PdfChatGptOptions.AddOutput(IDataSource),
• PdfChatGptOptions.Inputs,
• PdfChatGptOptions.Outputs,
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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

• apiKey string: Kunci untuk mengakses API ChatGPT.
• model string: Nama model ChatGPT. Model default adalah: gpt-3.5-turbo-1106:
• apiUrl string: URL API ChatGPT. URL default adalah: https://api.openai.com/v1/chat/completions.
• query string: String permintaan ke ChatGPT.

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

Class PdfConverter

Represents Documentize.PdfConverter plugin. Used to Convert PDF documents to another formats like DOCX/DOC, XLSX/XLS/CSV/XLSM/ODS, HTML, JPEG, PNG, TIFF, PDF/A. Also allows you to perform PDF/A Validation and Convert HTML to PDF.

public static class PdfConverter

Inheritance

object ← PdfConverter

Inherited Members

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Examples

The example demonstrates how to convert PDF document to Doc format.

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

The example demonstrates how to convert PDF document to Doc format with setting Mode.

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

The example demonstrates how to convert PDF to XLSX document.

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

The example demonstrates how to convert PDF to XLS document.

// Create PdfToXlsOptions object to set instructions
var options = new PdfToXlsOptions();
// Add input file path
options.AddInput(new FileDataSource("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 FileDataSource("path_to_result_xlsx_file.xls"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF to HTML document.

// 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 FileDataSource("path_to_input.pdf"));
// Set output file path
options.AddOutput(new FileDataSource("path_to_output.html"));
//Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert HTML to PDF document.

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

The example demonstrates how to convert PDF document into JPEG format.

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

The example demonstrates how to convert PDF document into JPEG format with settings for pages, resolution, quality.

// 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 FileDataSource("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into JPEG format to streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToJpegOptions();
// Add input File path
options.AddInput(new FileDataSource("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();
}

The example demonstrates how to convert PDF document into PNG format.

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

The example demonstrates how to convert 1 page of PDF document into PNG format.

// 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 FileDataSource("path_to_input.pdf"));
// Set output Directory path
options.AddOutput(new DirectoryDataSource("path_to_output_directory"));
// Perform the process
PdfConverter.Convert(options);

The example demonstrates how to convert PDF document into PNG format to streams.

// Create PdfToJpegOptions object to set instructions
var options = new PdfToPngOptions();
// Add input File path
options.AddInput(new FileDataSource("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();
}

The example demonstrates how to convert PDF document into TIFF format.

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

The example demonstrates how to convert PDF document into TIFF format with Customizing Pages and DPI.

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

The example demonstrates how to convert PDF document into TIFF as Multi-Page.

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

The example demonstrates how to convert PDF document into TIFF format with Customizing Compression and ColorDepth.

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

The example demonstrates how to convert PDF document into TIFF format to streams.

// Create PdfToTiffOptions object to set instructions
var options = new PdfToTiffOptions();
// Add input File path
options.AddInput(new FileDataSource("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();
}

The example demonstrates how to convert the PDF document in a PDF/A format (PDF/A-3b in this case):

// 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 FileDataSource("path_to_your_pdf_file.pdf")); // replace with your actual file path

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

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

The example demonstrates how to validate the PDF document conformance to PDF/A format (PDF/A-1a in this case):

// 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 FileDataSource("path_to_your_first_pdf_file.pdf")); // replace with your actual file path
options.AddInput(new FileDataSource("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:
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)
{
    var result = resultContainer.ResultCollection[i];
    var validationResult = (PdfAValidationResult) result.Data;
    var isValid = validationResult.IsValid; // Validation result for the i-th document
}

Methods

Convert(PdfToDocOptions)

Converts PDF document into DOC/DOCX formats.

public static ResultContainer Convert(PdfToDocOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(PdfToXlsOptions)

Converts PDF document into XLSX/XLS/CSV/XLSM/ODS formats.

public static ResultContainer Convert(PdfToXlsOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(PdfToHtmlOptions)

Converts PDF document into HTML format.

public static ResultContainer Convert(PdfToHtmlOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(HtmlToPdfOptions)

Converts HTML document into PDF format.

public static ResultContainer Convert(HtmlToPdfOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(PdfToJpegOptions)

Converts PDF document into JPEG format.

public static ResultContainer Convert(PdfToJpegOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(PdfToPngOptions)

Converts PDF document into PNG format.

public static ResultContainer Convert(PdfToPngOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(PdfToTiffOptions)

Converts PDF document into TIFF format.

public static ResultContainer Convert(PdfToTiffOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Convert(PdfToPdfAOptions)

Converts PDF document into PDF/A format.

public static ResultContainer Convert(PdfToPdfAOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Validate(PdfAValidateOptions)

Check PDF document for compliance with specified format PDF/A.

public static ResultContainer Validate(PdfAValidateOptions options)

Parameters

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

Returns

ResultContainer : An object containing the result of the operation.

Exceptions

ArgumentException

If options not set.

Class PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions

Pewarisan

object ← PdfConverterOptions

Turunan

• PdfToXlsOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

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