Antarmuka IDataSource

public interface IDataSource

Properti

DataType

Jenis sumber data.

DataType DataType { get; }

Nilai Properti

DataType

Antarmuka IOperationResult

public interface IOperationResult  

Properties

Data

Mendapatkan data mentah.

object Data { get; }  

Property Value

object

IsFile

Menunjukkan apakah hasilnya adalah jalur ke file output.

bool IsFile { get; }  

Property Value

bool

IsStream

Menunjukkan apakah hasilnya adalah aliran output.

bool IsStream { get; }  

Property Value

bool

IsString

Menunjukkan apakah hasilnya adalah string teks.

bool IsString { get; }  

Property Value

bool

Methods

ToFile()

Mencoba mengonversi hasil ke file.

string ToFile()  

Returns

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

Returns

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

Antarmuka IPluginOptions

public interface IPluginOptions

Builder Baris Tabel Kelas

public class TableRowBuilder : TableBuilder  

Pewarisan

object ←
TableBuilder ←
TableRowBuilder

Turunan

• TableCellBuilder

Anggota yang Digunakan

• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Metode

AddCell()

Menambahkan sel ke baris tabel.

public virtual TableCellBuilder AddCell()  

Mengembalikan

TableCellBuilder : Instansi dari Documentize.TableCellBuilder yang dibuat.

AddRow()

Mengubah AddRow.

public override TableRowBuilder AddRow()  

Mengembalikan

TableRowBuilder : Instansi dari Documentize.TableRowBuilder saat ini.

Class TableBuilder

public class TableBuilder

Warisan

object ← TableBuilder

Turunan

• TableRowBuilder

Anggota yang Dwarisi

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

Metode

AddRow()

Menambahkan baris baru ke tabel.

public virtual TableRowBuilder AddRow()

Mengembalikan

TableRowBuilder : Instans dari Documentize.TableRowBuilder yang sedang digunakan.

AddTable()

Menambahkan tabel baru ke dokumen.

public TableBuilder AddTable()

Mengembalikan

TableBuilder : Instans dari Documentize.TableBuilder yang sedang digunakan.

InsertPageAfter(int)

Menyisipkan halaman setelah halaman yang ditentukan.

public TableOptions InsertPageAfter(int page)

Parameter

• page int: Nomor halaman untuk menyisipkan tabel setelahnya.

Mengembalikan

TableOptions : Instans dari Documentize.TableOptions yang sedang digunakan.

InsertPageBefore(int)

Menyisipkan halaman sebelum halaman yang ditentukan.

public TableOptions InsertPageBefore(int page)

Parameter

• page int: Nomor halaman untuk menyisipkan tabel setelahnya.

Mengembalikan

TableOptions : Instans dari Documentize.TableOptions yang sedang digunakan.

Operator

implicit operator TableOptions(TableBuilder)

Mengonversi builder Documentize.TableBuilder ke opsi Documentize.TableOptions

public static implicit operator TableOptions(TableBuilder builder)

Parameter

• builder TableBuilder: Instans dari Documentize.TableBuilder yang sedang digunakan.

Mengembalikan

TableOptions : Hasil konversi ke PdfGeneratorTableOptions.

Class TableCellBuilder

public class TableCellBuilder : TableRowBuilder

Pewarisan

object ← TableBuilder ← TableRowBuilder ← TableCellBuilder

Anggota yang Dwarisi

• TableRowBuilder.AddCell(),
• TableRowBuilder.AddRow(),
• TableBuilder.AddRow(),
• TableBuilder.AddTable(),
• TableBuilder.InsertPageAfter(int),
• TableBuilder.InsertPageBefore(int),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Metode

AddCell()

Tambahkan sel ke tabel.

public override TableCellBuilder AddCell()

Mengembalikan

TableCellBuilder : Instansi 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 : Instansi dari Documentize.TableCellBuilder saat ini.

Enum ConvertErrorAction

public enum ConvertErrorAction

Fields

• Delete = 0
• None = 1

Enum ConvertSoftMaskAction

public enum ConvertSoftMaskAction

Fields

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

Enum HtmlMediaType

public enum HtmlMediaType

Fields

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

Enum HtmlPageLayoutOption

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 mempengaruhi ukuran dan tata letak halaman.
• ScaleToPageWidth = 256: Menunjukkan bahwa konten dokumen akan diskalakan agar sesuai dengan halaman.

Enum PdfAStandardVersion

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.

Enum PdfToHtmlOptions.SaveDataType

public enum PdfToHtmlOptions.SaveDataType  

Fields

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

Enum PdfToXlsOptions.ExcelFormat

Allows to specify .xlsx, .xls/xml or csv file format.
Default value is XLSX.

public enum PdfToXlsOptions.ExcelFormat  

Fields

• CSV = 2: Format File nilai terpisah koma (CSV).
• ODS = 4: Spreadsheet Dokumen Terbuka.
• XLSM = 3: Format File Office Open XML (.xlsm) yang diaktifkan makro.
• XLSX = 1: Format File Office Open XML (.xlsx).
• XMLSpreadSheet2003 = 0: Format File Excel 2003 XML (.xls).

Enum Peran

public enum Role

Fields

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

Enum TextExtractorOptions.TextFormattingMode

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.

Halaman Kelas

public class PageInfo : PageSize  

Pewarisan

object ←
PageSize ←
PageInfo

Anggota yang diwarisi

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

Konstruktor

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

Mengambil atau menetapkan nilai yang menunjukkan margin bawah.

public double MarginBottom { get; set; }  

Nilai Properti

double

MarginLeft

Mengambil atau menetapkan nilai yang menunjukkan margin kiri.

public double MarginLeft { get; set; }  

Nilai Properti

double

MarginRight

Mengambil atau menetapkan nilai yang menunjukkan margin kanan.

public double MarginRight { get; set; }  

Nilai Properti

double

MarginTop

Mengambil atau menetapkan nilai yang menunjukkan margin atas.

public double MarginTop { get; set; }  

Nilai Properti

double

Halaman UkuranKelas

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

Tinggi

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 orientasi 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 surat (279x216 mm).

public static PageSize PageLetter { get; }

Nilai Properti

PageSize

Lebar

Mengambil atau mengatur lebar halaman.

public double Width { get; set; }

Nilai Properti

double

HasilKelasContainer

public class ResultContainer

Pewarisan

object ← ResultContainer

Anggota Yang Dipewarisi

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

Properti

ResultCollection

Mendapatkan koleksi hasil operasi

public List<ioperationresult> ResultCollection { get; }

Nilai Properti

List<IOperationResult>

Info Kelas

public static class Info

Pewarisan

object ← Info

Anggota yang Dwarisi

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

Field

• AssemblyVersion Versi Assembly.

public const string AssemblyVersion = “24.12.0”

#### Nilai Field

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

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

Nama Produk.

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

Nilai Field

string

Keamanan Kelas

public sealed class Security  

Warisan

object ←
Security

Anggota yang Dwarisi

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

Contoh

Contoh ini menunjukkan cara mengenkripsi dokumen PDF.

// buat Keamanan  
var plugin = new Security();  
// buat objek EncryptionOptions untuk menetapkan instruksi  
var opt = new EncryptionOptions("123456", "qwerty");  
// tambahkan jalur file input  
opt.AddInput(new FileDataSource(inputPath));  
// atur jalur file output  
opt.AddOutput(new FileDataSource(outputPath));  
// lakukan proses  
plugin.Process(opt);  

Contoh ini menunjukkan cara mendekripsi dokumen PDF.

// buat Keamanan  
var plugin = new Security();  
// buat objek DecryptionOptions untuk menetapkan instruksi  
var opt = new DecryptionOptions("123456"));  
// tambahkan jalur file input  
opt.AddInput(new FileDataSource(inputPath));  
// atur jalur file output  
opt.AddOutput(new FileDataSource(outputPath));  
// lakukan proses  
plugin.Process(opt);  

Konstruktor

Security()

public Security()  

Metode

Process(IPluginOptions)

Memulai proses Documentize.Security dengan parameter yang ditentukan.

public ResultContainer Process(IPluginOptions options)  

Parameter

• options IPluginOptions: Objek opsi yang berisi instruksi untuk Documentize.Security.

Mengembalikan

ResultContainer : Objek ResultContainer yang berisi hasil operasi.

Pengecualian

InvalidOperationException

Kelas AddTimestampOptions

public class AddTimestampOptions : PluginBaseOptions, IPluginOptions  

Pewarisan

object ←
PluginBaseOptions ←
AddTimestampOptions

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

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 sebuah 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 sebuah string “username:password”. (Opsional).

Kelas CompressOptions

public sealed class CompressOptions : PluginBaseOptions, IPluginOptions  

Pewarisan

object ←
PluginBaseOptions ←
CompressOptions

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

CompressOptions()

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

public CompressOptions()  

Kelas DocConverter

public sealed class DocConverter  

Inheritance

object ←
DocConverter

Inherited Members

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

Examples

Contoh ini menunjukkan cara mengonversi dokumen PDF ke format Doc.

// buat DocConverter  
var plugin = new DocConverter();  
// buat objek PdfToDocOptions untuk mengatur instruksi  
var opt = new PdfToDocOptions();  
// tambahkan jalur file input  
opt.AddInput(new FileDataSource(inputPath));  
// atur jalur file output  
opt.AddOutput(new FileDataSource(outputPath));  
// lakukan proses  
plugin.Process(opt);  

Constructors

DocConverter()

public DocConverter()  

Methods

Dispose()

Implementasi dari IDisposable.

public void Dispose()  

Process(PdfToDocOptions)

Memulai pemrosesan Documentize.DocConverter dengan parameter yang ditentukan.

public ResultContainer Process(PdfToDocOptions options)  

Parameters

• options PdfToDocOptions: Sebuah objek opsi yang berisi instruksi untuk Documentize.DocConverter.

Returns

ResultContainer: Sebuah objek Documentize.ResultContainer yang berisi hasil dari operasi.

Kelas EncryptionOptions

public class EncryptionOptions : PluginBaseOptions, IPluginOptions  

Warisan

object ←
PluginBaseOptions ←
EncryptionOptions

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

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

Kelas FileDataSource

public sealed class FileDataSource : IDataSource  

Pewarisan

object ←
FileDataSource

Menerapkan

• 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 path yang ditentukan.

public FileDataSource(string path)  

Parameter

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

Properti

DataType

Tipe sumber data.

public DataType DataType { get; }  

Nilai Properti

DataType

Path

Mendapatkan path ke file dari data saat ini.

public string Path { get; }  

Nilai Properti

string

Kelas FileResult

public sealed class FileResult : IOperationResult  

Pewarisan

object ←
FileResult

Mengimplementasikan

• IOperationResult

Anggota yang diwarisi

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

Properti

Data

Mengambil 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 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 mengonversi hasil menjadi objek aliran.

public Stream ToStream()  

Mengembalikan

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

Kelas HtmlConverter

public sealed class HtmlConverter : IDisposable

Inheritance

object ← HtmlConverter

Implements

• IDisposable

Inherited Members

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

Examples

Contoh ini menjelaskan cara mengonversi PDF menjadi dokumen HTML.

// membuat HtmlConverter
var plugin = new HtmlConverter();
// membuat objek PdfToHtmlOptions untuk mengatur tipe data keluaran sebagai file dengan sumber daya terbenam
var opt = new PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType.FileWithEmbeddedResources);
// menambahkan path file input
opt.AddInput(new FileDataSource(inputPath));
// mengatur path file keluaran
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Contoh ini menjelaskan cara mengonversi HTML menjadi dokumen PDF.

// membuat HtmlConverter
var plugin = new HtmlConverter();
// membuat HtmlToPdfOptions
var opt = new HtmlToPdfOptions();
// menambahkan path file input
opt.AddInput(new FileDataSource(inputPath));
// mengatur path file keluaran
opt.AddOutput(new FileDataSource(outputPath));
plugin.Process(opt);

Constructors

HtmlConverter()

public HtmlConverter()

Methods

Dispose()

Implementasi dari IDisposable.

public void Dispose()

Process(IPluginOptions)

Memulai pemrosesan Documentize.HtmlConverter dengan parameter yang ditentukan.

public ResultContainer Process(IPluginOptions options)

Parameters

• options IPluginOptions: Objek opsi yang berisi instruksi untuk Documentize.HtmlConverter.

Returns

ResultContainer : Sebuah objek Documentize.ResultContainer yang berisi hasil dari operasi tersebut.

Kelas 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

Mengambil atau menetapkan jenis media yang mungkin digunakan saat rendering.

public HtmlMediaType HtmlMediaType { get; set; }  

Property Value

HtmlMediaType

IsRenderToSinglePage

Mengambil atau menetapkan rendering semua dokumen ke satu halaman.

public bool IsRenderToSinglePage { get; set; }  

Property Value

bool

PageInfo

Mengambil atau menetapkan info halaman dokumen.

public PageInfo PageInfo { get; set; }  

Property Value

PageInfo

PageLayoutOption

Mengambil atau menetapkan opsi tata letak.

public HtmlPageLayoutOption PageLayoutOption { get; set; }  

Property Value

HtmlPageLayoutOption

Kelas ImageExtractor

public class ImageExtractor : PdfExtractor, IDisposable

Pewarisan

object ← PdfExtractor ← ImageExtractor

Mengimplementasikan

• IDisposable

Anggota yang diwarisi

• PdfExtractor.Process(IPluginOptions),
• PdfExtractor.Dispose(),
• object.GetType(),
• object.MemberwiseClone(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Contoh

Contoh ini menunjukkan cara mengekstrak gambar dari dokumen PDF.

// buat objek ImageExtractor untuk mengekstrak gambar
using (var plugin = new ImageExtractor())
{
    // buat ImageExtractorOptions
    var opt = new ImageExtractorOptions();

    // tambahkan jalur file input
    opt.AddInput(new FileDataSource(inputPath));
    // setel direktori output
    opt.AddInput(new FileDataSource("D:\\"));

    // lakukan proses ekstraksi
    var resultContainer = plugin.Process(opt);

    // ambil gambar dari objek ResultContainer
    var imageExtracted = resultContainer.ResultCollection[0].ToFile();
}

Konstruktor

ImageExtractor()

public ImageExtractor()

Kelas ImageExtractorOptions

public sealed class ImageExtractorOptions : PdfExtractorOptions, IPluginOptions

Pewarisan

object ← PdfExtractorOptions ← ImageExtractorOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• PdfExtractorOptions.AddInput(IDataSource),
• PdfExtractorOptions.Inputs,
• PdfExtractorOptions.OperationName,
• object.GetType(),
• object.ToString(),
• object.Equals(object?),
• object.Equals(object?, object?),
• object.ReferenceEquals(object?, object?),
• object.GetHashCode()

Catatan

Ini mewarisi fungsi untuk menambahkan data (berkas, aliran) yang mewakili dokumen PDF masukan.

Konstruktor

ImageExtractorOptions()

Menginisialisasi instance baru dari objek Documentize.ImageExtractorOptions.

public ImageExtractorOptions()

Properti

OperationName

Mengembalikan nama operasi.

public override string OperationName { get; }

Nilai Properti

string

Kelas JpegConverter

public sealed class JpegConverter  

Inheritance

object ←
JpegConverter

Inherited Members

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

Contoh

Contoh ini menunjukkan bagaimana cara mengonversi dokumen PDF ke dalam format JPEG.

// buat JpegConverter  
var plugin = new JpegConverter();  
// buat objek PdfToJpegOptions untuk mengatur instruksi  
var opt = new PdfToJpegOptions();  
// tambahkan jalur file masukan  
opt.AddInput(new FileDataSource(inputPath));  
// atur jalur file keluaran  
opt.AddOutput(new DirectoryDataSource(outputPath));  
// lakukan proses  
plugin.Process(opt);  

Konstruktor

JpegConverter()

public JpegConverter()  

Metode

Process(PdfToJpegOptions)

Memulai pemrosesan Documentize.JpegConverter dengan parameter yang ditentukan.

public ResultContainer Process(PdfToJpegOptions options)  

Parameter

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

Mengembalikan

ResultContainer: Sebuah objek ResultContainer yang berisi hasil dari operasi.

Kelas MergeOptions

public sealed class MergeOptions : PluginBaseOptions, IPluginOptions  

Pewarisan

object ←
PluginBaseOptions ←
MergeOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwariskan

• 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

MergeOptions()

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

public MergeOptions()  

Kelas ObjectResult

public sealed class ObjectResult : IOperationResult

Pewarisan

object ← ObjectResult

Mengimplementasikan

• IOperationResult

Anggota yang diwarisi

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

Properti

Data

Mengambil data mentah.

public object Data { get; }

Nilai Properti

object

IsFile

Mengindikasikan apakah hasilnya adalah jalur ke file output.

public bool IsFile { get; }

Nilai Properti

bool

IsObject

Mengindikasikan apakah hasilnya adalah objek.

public bool IsObject { get; }

Nilai Properti

bool

IsStream

Mengindikasikan apakah hasilnya adalah jalur ke file output.

public bool IsStream { get; }

Nilai Properti

bool

IsString

Mengindikasikan 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 untuk mengonversi hasil menjadi 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 stream.

public Stream ToStream()

Mengembalikan

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

ToString()

Mencoba untuk mengonversi hasil menjadi string.

public override string ToString()

Mengembalikan

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

Kelas OptimizeOptions

public sealed class OptimizeOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← OptimizeOptions

Menerapkan

• IPluginOptions

Anggota yang Dwarisi

• 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

OptimizeOptions()

Menginisialisasi instance baru dari objek Documentize.OptimizeOptions dengan opsi default. Melinierkan 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 sebuah halaman diterima 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()

Kelas PdfAConverter

public sealed class PdfAConverter  

Inheritance

object ←
PdfAConverter

Inherited Members

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

Contoh

Contoh ini menunjukkan cara memvalidasi kesesuaian dokumen PDF dengan format PDF/A (PDF/A-1a dalam hal ini):

// Buat kelas opsi untuk mengatur proses validasi  
var options = new PdfAValidateOptions  
{  
    PdfAVersion = PdfAStandardVersion.PDF_A_1A  
};  

// Tambahkan satu atau lebih file untuk divalidasi  
options.AddInput(new FileDataSource("path_to_your_first_pdf_file.pdf")); // ganti dengan jalur file Anda yang sebenarnya  
options.AddInput(new FileDataSource("path_to_your_second_pdf_file.pdf"));  
// tambahkan lebih banyak file jika perlu  

// Buat instance plugin  
var plugin = new PdfAConverter();  

// Jalankan validasi dan dapatkan hasilnya  
var resultContainer = plugin.Process(options);  

// Periksa properti resultContainer.ResultCollection untuk hasil validasi setiap file:  
for (var i = 0; i < resultContainer.ResultCollection.Count; i++)  
{  
    var result = resultContainer.ResultCollection[i];  
    var validationResult = (PdfAValidationResult) result.Data;  
    var isValid = validationResult.IsValid; // Hasil validasi untuk dokumen ke-i  
}  

Contoh ini menunjukkan cara mengonversi dokumen PDF dalam format PDF/A (PDF/A-3b dalam hal ini):

// Buat kelas opsi untuk mengatur proses konversi  
var options = new PdfAConvertOptions  
{  
    PdfAVersion = PdfAStandardVersion.PDF_A_3B  
};  

// Tambahkan file sumber  
options.AddInput(new FileDataSource("path_to_your_pdf_file.pdf")); // ganti dengan jalur file Anda yang sebenarnya  

// Tambahkan jalur untuk menyimpan file yang sudah dikonversi  
options.AddOutput(new FileDataSource("path_to_the_converted_file.pdf"));  

// Buat instance plugin  
var plugin = new PdfAConverter();  

// Jalankan konversi  
plugin.Process(options);  

Konstruktor

PdfAConverter()

public PdfAConverter()  

Metode

Process(IPluginOptions)

Memulai proses konversi atau validasi PDF/A dengan opsi yang diberikan.

public ResultContainer Process(IPluginOptions options)  

Parameter

• options IPluginOptions: Objek opsi yang berisi instruksi untuk plugin. Harus merupakan instansi dari kelas Documentize.PdfAConvertOptions: atau Documentize.PdfAValidateOptions.

Mengembalikan

ResultContainer : Objek Documentize.ResultContainer yang berisi hasil pemrosesan.

Kelas PdfAConvertOptions

public sealed class PdfAConvertOptions : PdfAOptionsBase, IPluginOptions

Pewarisan

object ← PdfAOptionsBase ← PdfAConvertOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

• 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

PdfAConvertOptions()

public PdfAConvertOptions()

Properti

Outputs

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

public List<idatasource> Outputs { get; }

Nilai Properti

List<IDataSource>

Metode

AddOutput(IDataSource)

Menambahkan target hasil penyimpanan baru.

public void AddOutput(IDataSource dataSource)

Parameter

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

Kelas 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  

Pewarisan

object ←
PdfAOptionsBase

Turunan

• PdfAConvertOptions,
• PdfAValidateOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

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

Konstruktor

PdfAOptionsBase()

protected PdfAOptionsBase()  

Properti

AlignText

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

public bool AlignText { get; set; }  

Nilai Properti

bool

Catatan

Ketika diatur ke true, proses konversi akan mencoba memulihkan batas segmen teks asli.
Untuk sebagian besar dokumen, tidak perlu mengubah properti ini dari nilai default false,
karena sejajar teks tidak berubah selama proses konversi default.

CheckDifferentNamesInFontDictionaries

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

public bool CheckDifferentNamesInFontDictionaries { get; set; }  

Nilai Properti

bool

ErrorAction

Mengambil atau menetapkan tindakan yang akan diambil untuk objek yang tidak dapat dikonversi.

public ConvertErrorAction ErrorAction { get; set; }  

Nilai Properti

ConvertErrorAction

IccProfileFileName

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

public string IccProfileFileName { get; set; }  

Nilai Properti

string

Inputs

Mengambil koleksi sumber data

public List<idatasource> Inputs { get; }  

Nilai Properti

List<IDataSource>

IsLowMemoryMode

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

public bool IsLowMemoryMode { get; set; }  

Nilai Properti

bool

LogOutputSource

Mengambil atau menetapkan sumber data untuk keluaran log.

public IDataSource LogOutputSource { get; set; }  

Nilai Properti

IDataSource

OptimizeFileSize

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

public bool OptimizeFileSize { get; set; }  

Nilai Properti

bool

Catatan

Ketika diatur ke true, proses konversi akan mencoba meminimalkan ukuran file hasil.
Ini mungkin mempengaruhi kinerja proses konversi.

PdfAVersion

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

public PdfAStandardVersion PdfAVersion { get; set; }  

Nilai Properti

PdfAStandardVersion

Catatan

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

SoftMaskAction

Mengambil atau menetapkan tindakan yang akan diambil selama konversi gambar dengan masker lembut.

public ConvertSoftMaskAction SoftMaskAction { get; set; }  

Nilai Properti

ConvertSoftMaskAction

Metode

AddInput(IDataSource)

Menambahkan sumber data baru ke koleksi

public void AddInput(IDataSource dataSource)  

Parameter

• dataSource IDataSource:

Kelas PdfAValidationResult

public sealed class PdfAValidationResult  

Pewarisan

object ←
PdfAValidationResult

Anggota yang diwarisi

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

Field

• 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

Kelas PdfChatGpt

public sealed class PdfChatGpt : IDisposable

Pewarisan

object ← PdfChatGpt

Mengimplementasikan

• IDisposable

Anggota yang diwarisi

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

Contoh

Contoh ini menunjukkan cara menggunakan plugin PdfChatGpt dengan menambahkan pesan ke permintaan.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Tambahkan jalur file output.
    options.ApiKey = "Kunci API Anda."; // Anda perlu memberikan kunci untuk mengakses API.
    options.MaxTokens = 1000; // Jumlah maksimum token yang akan dihasilkan dalam penyelesaian obrolan.

    // Tambahkan pesan permintaan.
    options.Messages.Add(new Message
    {
        Content = "Anda adalah asisten yang membantu.",
        Role = Role.System
    });
    options.Messages.Add(new Message
    {
        Content = "Apa diameter pizza terbesar yang pernah dibuat?",
        Role = Role.User
    });

    // Proses permintaan.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Objek penyelesaian obrolan API ChatGPT.
}

Contoh ini menunjukkan cara menggunakan plugin PdfChatGpt dengan menambahkan satu pesan ke permintaan.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Tambahkan jalur file output.
    options.ApiKey = "Kunci API Anda."; // Anda perlu memberikan kunci untuk mengakses API.
    options.MaxTokens = 1000; // Jumlah maksimum token yang akan dihasilkan dalam penyelesaian obrolan.

    // Tambahkan pesan permintaan.
    // Dalam hal ini, pesan sistem dengan Konten = "Anda adalah asisten yang membantu." ditambahkan secara default.
    // Peran pesan kueri adalah "user" secara default.
    options.Query = "Apa suhu terendah yang tercatat di Bumi?";

    // Proses permintaan.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Objek penyelesaian obrolan API ChatGPT.
}

Contoh ini menunjukkan cara menggunakan plugin PdfChatGpt dengan menambahkan file sebagai sumber pesan.

using (var plugin = new PdfChatGpt())
{
    var options = new PdfChatGptRequestOptions();
    options.AddOutput(new FileDataSource("PdfChatGPT_output.pdf")); // Tambahkan jalur file output.

    // Tambahkan sumber teks PDF.
    // Dalam kasus beberapa sumber, teks dari setiap dokumen akan ditambahkan ke koleksi pesan permintaan
    // sebagai pesan terpisah dengan peran "user".
    options.AddInput(new FileDataSource("TextSource.pdf"));

    options.ApiKey = "Kunci API Anda."; // Anda perlu memberikan kunci untuk mengakses API.
    options.MaxTokens = 1000; // Jumlah maksimum token yang akan dihasilkan dalam penyelesaian obrolan.

    // Tambahkan pesan permintaan.
    // Dalam hal ini, pesan sistem dengan Konten = "Anda adalah asisten yang membantu." ditambahkan secara default.
    // Peran pesan kueri adalah "user" secara default.
    options.Query = "Berapa banyak huruf dalam teks yang diberikan?";

    // Proses permintaan.
    var result = await plugin.ProcessAsync(options);

    var fileResultPath = result.ResultCollection[0].Data;
    var chatCompletionObject = result.ResultCollection[1].Data as ChatCompletion; // Objek penyelesaian obrolan API ChatGPT.
}

Catatan

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

Konstruktor

PdfChatGpt()

Menginisialisasi instance baru dari objek Documentize.PdfChatGpt.

public PdfChatGpt()

Metode

Dispose()

Implementasi dari IDisposable. Sebenarnya, ini tidak diperlukan untuk PdfChatGpt.

public void Dispose()

Process(IPluginOptions)

Metode ini tidak memiliki versi sinkron. Gunakan metode ProcessAsync sebaliknya.

public ResultContainer Process(IPluginOptions options)

Parameter

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

Mengembalikan

ResultContainer : #### Eksepsi

NotImplementedException

ProcessAsync(IPluginOptions)

Mulai pemrosesan PdfChatGpt dengan parameter yang ditentukan.

public Task<resultcontainer> ProcessAsync(IPluginOptions options)

Parameter

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

Mengembalikan

Task<ResultContainer>

Obyek tugas yang mewakili operasi asinkron.

Eksepsi

ArgumentException : InvalidOperationException

SetCancellationToken(CancellationToken)

Mengatur token pembatalan.

public void SetCancellationToken(CancellationToken cancellationToken)

Parameter

• cancellationToken CancellationToken: Token pembatalan. :

Kelas PdfChatGptOptions

public class PdfChatGptOptions : IPluginOptions

Pewarisan

object ← PdfChatGptOptions

Turunan

• PdfChatGptRequestOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Diperoleh

• 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) untuk ditambahkan.

AddOutput(IDataSource)

Menambahkan sumber data simpan baru ke koleksi data plugin PdfChatGpt.

public void AddOutput(IDataSource saveDataSource)

Parameter

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

Kelas PdfChatGptRequestOptions

public class PdfChatGptRequestOptions : PdfChatGptOptions, IPluginOptions

Pewarisan

object ← PdfChatGptOptions ← PdfChatGptRequestOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Diwariskan

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

Konstruktor

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)

Parameter

• apiKey string: Kunci untuk akses ke 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 kepada ChatGPT.

Properti

ApiKey

Mengambil atau mengatur kunci untuk akses ke 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

MaxTokens

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

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>

Model

Mengatur atau mengambil ID model yang akan digunakan.

public string Model { get; set; }

Nilai Properti

string

NumberOfChoices

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

public int NumberOfChoices { get; set; }

Nilai Properti

int

Query

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

public string Query { get; set; }

Nilai Properti

string

Temperature

Temperatur pengambilan sampel 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 terfokus dan deterministik. Nilai default adalah 1.

public double Temperature { get; set; }

Nilai Properti

double

Kelas PdfConverterOptions

public abstract class PdfConverterOptions : IPluginOptions  

Pewarisan

object ←
PdfConverterOptions

Turunan

• PdfToDocOptions,
• PdfToHtmlOptions,
• PdfToXlsOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwariskan

• 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 hasil operasi penyimpanan.

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 stream) untuk hasil operasi penyimpanan.

Pengecualian

NotImplementedException

Kelas PdfExtractor

public abstract class PdfExtractor : IDisposable  

Pewarisan

object ←
PdfExtractor

Turunan

• ImageExtractor,
• TextExtractor

Menerapkan

• IDisposable

Anggota yang diwarisi

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

Contoh

Contoh ini menunjukkan cara mengekstrak konten teks dari dokumen PDF.

// buat objek TextExtractor untuk mengekstrak konten PDF  
using (TextExtractor extractor = new TextExtractor())  
{  
    // buat objek TextExtractorOptions untuk mengatur instruksi  
    textExtractorOptions = new TextExtractorOptions();  

    // tambahkan jalur file input  
    textExtractorOptions.AddInput(new FileDataSource(inputPath));  

    // lakukan proses ekstraksi  
    ResultContainer resultContainer = extractor.Process(textExtractorOptions);  

    // ambil teks yang diekstrak dari objek ResultContainer  
    string textExtracted = resultContainer.ResultCollection[0].ToString();  
}  

Catatan

Objek Documentize.TextExtractor digunakan untuk mengekstrak teks, atau Documentize.ImageExtractor untuk mengekstrak gambar.

Konstruktor

PdfExtractor()

protected PdfExtractor()  

Metode

Dispose()

Implementasi dari IDisposable. Sebenarnya, itu tidak diperlukan untuk PdfExtractor.

public void Dispose()  

Process(IPluginOptions)

Memulai pemrosesan PdfExtractor dengan parameter yang ditentukan.

public ResultContainer Process(IPluginOptions pdfExtractorOptions)  

Parameter

• pdfExtractorOptions IPluginOptions: Sebuah objek opsi yang berisi instruksi untuk PdfExtractor.

Mengembalikan

ResultContainer : Sebuah objek ResultContainer yang berisi hasil dari ekstraksi.

Kelas PdfExtractorOptions

public abstract class PdfExtractorOptions : IPluginOptions  

Pewarisan

object ←
PdfExtractorOptions

Turunan

• ImageExtractorOptions,
• TextExtractorOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwariskan

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

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

Kelas PdfToDocOptions

public sealed class PdfToDocOptions : PdfConverterOptions, IPluginOptions  

Pewarisan

object ←
PdfConverterOptions ←
PdfToDocOptions

Mengimplementasikan

• IPluginOptions

Anggota yang diwarisi

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

Konstruktor

PdfToDocOptions()

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

public PdfToDocOptions()  

Kelas PdfToHtmlOptions

public sealed class PdfToHtmlOptions : PdfConverterOptions, IPluginOptions  

Warisan

object ←
PdfConverterOptions ←
PdfToHtmlOptions

Mengimplementasikan

• IPluginOptions

Anggota yang Dwarisi

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

Konstruktor

PdfToHtmlOptions()

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

public PdfToHtmlOptions()  

PdfToHtmlOptions(SaveDataType)

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

public PdfToHtmlOptions(PdfToHtmlOptions.SaveDataType outputDataType)  

Parameter

• outputDataType PdfToHtmlOptions.SaveDataType: Tipe data keluaran.

Properti

OutputDataType

Mendapatkan tipe data keluaran.

public PdfToHtmlOptions.SaveDataType OutputDataType { get; }  

Nilai Properti

PdfToHtmlOptions.SaveDataType

Kelas PdfToJpegOptions

public sealed class PdfToJpegOptions : PluginBaseOptions, IPluginOptions  

Inheritance

object ←
PluginBaseOptions ←
PdfToJpegOptions

Implements

• IPluginOptions

Inherited Members

• PluginBaseOptions.AddInput(IDataSource),
• PluginBaseOptions.AddOutput(IDataSource),
• PluginBaseOptions.Inputs,
• PluginBaseOptions.Outputs,
• PluginBaseOptions.CloseInputStreams,
• PluginBaseOptions.CloseOutputStreams,
• object.GetType(),
• [object.ToString

Kelas PdfToPngOptions

public sealed class PdfToPngOptions : PluginBaseOptions, IPluginOptions  

Inheritance

object ←
PluginBaseOptions ←
PdfToPngOptions

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

PdfToPngOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToPngOptions.

public PdfToPngOptions()  

Properties

OutputResolution

Mengambil atau mengatur nilai resolusi dari gambar yang dihasilkan.

public int OutputResolution { get; set; }  

Property Value

int

PageList

Mengambil atau mengatur daftar halaman untuk proses.

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

Property Value

List<int>

Kelas PdfToTiffOptions

public sealed class PdfToTiffOptions : PluginBaseOptions, IPluginOptions  

Inheritance

object ←
PluginBaseOptions ←
PdfToTiffOptions

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

PdfToTiffOptions()

Menginisialisasi instance baru dari objek Documentize.PdfToTiffOptions.

public PdfToTiffOptions()  

Properties

MultiPage

Mendapatkan dan mengatur flag yang memungkinkan untuk menyimpan semua halaman dalam satu tiff multi-halaman.

public bool MultiPage { get; set; }  

Property Value

bool

OutputResolution

Mendapatkan atau mengatur nilai resolusi dari gambar yang dihasilkan.

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>

Kelas PdfToXlsOptions

public sealed class PdfToXlsOptions : PdfConverterOptions, IPluginOptions

Inheritance

object ← PdfConverterOptions ← PdfToXlsOptions

Implements

• IPluginOptions

Inherited Members

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

Constructors

PdfToXlsOptions()

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

public PdfToXlsOptions()

Properties

Format

Format keluaran.

public PdfToXlsOptions.ExcelFormat Format { get; set; }

Property Value

PdfToXlsOptions.ExcelFormat

InsertBlankColumnAtFirst

Set true jika Anda perlu menyisipkan 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

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

public bool MinimizeTheNumberOfWorksheets { get; set; }

Property Value

bool

Kelas Persegi Panjang

public class Rectangle  

Pewarisan

object ←
Rectangle

Anggota yang Dihasilkan

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

Konstruktor

Rectangle(double, double, double, double)

Konstruktor dari Rectangle.

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

Parameter

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

Kelas PluginBaseOptions

public class PluginBaseOptions : IPluginOptions

Warisan

object ← PluginBaseOptions

Turunan

• AddTimestampOptions,
• CompressOptions,
• DecryptionOptions,
• EncryptionOptions,
• HtmlToPdfOptions,
• MergeOptions,
• OptimizeOptions,
• PdfToJpegOptions,
• PdfToPngOptions,
• PdfToTiffOptions,
• ResizeOptions,
• RotateOptions,
• SignOptions,
• SplitOptions,
• TableOptions

Mengimplementasikan

• IPluginOptions

Anggota Yang Diperoleh

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

Properti

CloseInputStreams

Tutup aliran input setelah operasi selesai.

public bool CloseInputStreams { get; set; }

Nilai Properti

bool

CloseOutputStreams

Tutup aliran output setelah operasi selesai.

public bool CloseOutputStreams { get; set; }

Nilai Properti

bool

Inputs

Mengembalikan data Inputs untuk operasi.

public List<idatasource> Inputs { get; }

Nilai Properti

List<IDataSource>

Outputs

Mengembalikan data Outputs untuk operasi.

public List<idatasource> Outputs { get; }

Nilai Properti

List<IDataSource>

Metode

AddInput(IDataSource)

Menambahkan Data baru ke Inputs.

public void AddInput(IDataSource dataSource)

Parameter

• dataSource IDataSource: Data yang akan ditambahkan.

AddOutput(IDataSource)

Menambahkan Data baru ke Outputs.

public void AddOutput(IDataSource saveDataSource)

Parameter

• saveDataSource IDataSource: Data yang akan ditambahkan. :

Kelas PngConverter

public sealed class PngConverter  

Pewarisan

object ←
PngConverter

Anggota yang Dwarisi

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

Contoh

Contoh ini menunjukkan bagaimana mengonversi dokumen PDF menjadi format PNG.

// buat PngConverter  
var plugin = new PngConverter();  
// buat objek PdfToPngOptions untuk mengatur instruksi  
var opt = new PdfToPngOptions();  
// tambahkan jalur file input  
opt.AddInput(new FileDataSource(inputPath));  
// setel jalur file output  
opt.AddOutput(new DirectoryDataSource(outputPath));  
// lakukan proses  
plugin.Process(opt);  

Konstruktor

PngConverter()

public PngConverter()  

Metode

Process(PdfToPngOptions)

Memulai pemrosesan Documentize.PngConverter dengan parameter yang ditentukan.

public ResultContainer Process(PdfToPngOptions options)  

Parameter

• options PdfToPngOptions: Objek opsi yang berisi instruksi untuk Documentize.PngConverter.

Mengembalikan

ResultContainer: Objek ResultContainer yang berisi hasil dari operasi.

Kelas ResizeOptions

public sealed class ResizeOptions : PluginBaseOptions, IPluginOptions  

Inheritance

object ←
PluginBaseOptions ←
ResizeOptions

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

ResizeOptions()

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

public ResizeOptions()  

Properties

PageSize

Mendapatkan atau menetapkan ukuran halaman baru.

public PageSize PageSize { get; set; }  

Property Value

PageSize

Kelas RotateOptions

public sealed class RotateOptions : PluginBaseOptions, IPluginOptions  

Pewarisan

object ←
PluginBaseOptions ←
RotateOptions

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

RotateOptions()

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

public RotateOptions()  

Properti

Rotation

Mengambil atau menetapkan rotasi halaman baru.

public Rotation Rotation { get; set; }  

Nilai Properti

Rotation

Kelas SplitOptions

public sealed class SplitOptions : PluginBaseOptions, IPluginOptions

Pewarisan

object ← PluginBaseOptions ← SplitOptions

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

SplitOptions()

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

public SplitOptions()

Kelas StreamDataSource

public sealed class StreamDataSource : IDataSource  

Warisan

object ←
StreamDataSource

Mengimplementasikan

• IDataSource

Anggota yang diwarisi

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

Konstruktor

StreamDataSource(Stream)

Menginisialisasi sumber data stream baru dengan objek stream yang ditentukan.

public StreamDataSource(Stream data)  

Parameter

• data Stream: Objek Stream

Properti

Data

Mendapatkan objek stream dari sumber data saat ini.

public Stream Data { get; }  

Nilai Properti

Stream

DataType

Jenis sumber data (stream).

public DataType DataType { get; }  

Nilai Properti

DataType

Kelas StreamResult

public sealed class StreamResult : IOperationResult

Pewarisan

object ← StreamResult

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 jalur ke file output.

public bool IsStream { get; }

Nilai Properti

bool

IsString

Menunjukkan apakah hasilnya adalah string.

public bool IsString { get; }

Nilai Properti

bool

Metode

ToFile()

Mencoba mengonversi hasilnya menjadi file.

public string ToFile()

Mengembalikan

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

ToStream()

Mencoba mengonversi hasilnya menjadi objek stream.

public Stream ToStream()

Mengembalikan

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

Kelas StringResult

public sealed class StringResult : IOperationResult

Pewarisan

object ← StringResult

Mengimplementasikan

• IOperationResult

Anggota Yang Dwarisi

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

Properti

Data

Mengambil 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 menjadi file.

public string ToFile()

Mengembalikan