CheckboxField
Gambaran Umum
CheckboxField adalah kelas dalam Aspose.PDF FOSS untuk .NET. Mewarisi dari: Field.
Kelas ini menyediakan 33 metode untuk bekerja dengan objek CheckboxField dalam program .NET. Metode yang tersedia meliputi: Accept, AddOption, ChangeAfterResize, CheckboxField, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName, dan 9 metode tambahan. Semua anggota publik dapat diakses oleh aplikasi .NET mana pun setelah menginstal paket Aspose.PDF FOSS untuk .NET. Properti: Action, Actions, ActiveState, Alignment, AllowedStates, AlternateName, dan 78 lainnya.
Properti
| Nama | Jenis | Akses | Deskripsi |
|---|---|---|---|
Style | BoxStyle | Baca/Tulis | Gaya visual dari glyph kotak centang yang dirender (/MK /CA): Cross menggambar sebuah X, Check sebuah tanda centang; gaya lain kembali ke X. |
ExportValue | string | Baca/Tulis | Nilai ekspor yang dihasilkan ke FDF/XFDF saat formulir dikirim. |
ActiveState | string | Baca/Tulis | Keadaan penampilan yang dipilih saat ini. |
AllowedStates | System.Collections.Generic.List<string> | Baca | Semua kunci keadaan-penampilan yang dideklarasikan di bawah /AP/N. |
Value | string | Baca/Tulis | Nilai kotak centang (/V entry, name-typed). |
OnValue | string | Baca | Mendapatkan nama status “On” untuk kotak centang ini (kunci status tampilan yang bukan “Off”). |
IsChecked | bool | Baca/Tulis | Mendapatkan atau mengatur apakah dicentang. |
Checked | bool | Baca/Tulis | Mendapatkan atau mengatur nilai tercentang. |
Type | FieldType | Baca | Tipe bidang. |
FullName | string? | Baca | Nama bidang yang sepenuhnya memenuhi syarat. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Baca/Tulis | Penimpaan perataan horizontal yang spesifik untuk teks diterapkan pada tampilan widget bidang. |
PageIndex | int | Baca | Indeks berbasis-1 dari halaman yang memiliki widget bidang ini. |
PartialName | string? | Baca/Tulis | Nama bidang parsial (/T). |
NormalAppearance | XForm? | Baca | Penampilan “Normal” bidang (entri /AP /N). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | Baca | Aliran tampilan widget bidang (entri /AP), diindeks berdasarkan nama tampilan. |
OnActivated | Annotations.PdfAction? | Baca/Tulis | Aksi yang dipicu ketika bidang ini diaktifkan (entri /A). |
Count | int | Baca | Jumlah anak dalam array /Kids bidang ini — baik field anak (hierarchy nodes) atau widget annotations (field terminal dengan beberapa visual widgets, seperti grouped checkbox/radio). |
Fields | Field[] | Baca | Field-typed child kids dari field ini sebagai snapshot array — convenience accessor yang mencerminkan Fields pada form. |
DefaultValue | string? | Baca | Nilai default (/DV). |
AlternateName | string? | Baca/Tulis | Nama bidang alternatif / tooltip (/TU entry). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | Baca/Tulis | Bendera anotasi widget (/F entry), misalnya. |
TabOrder | int | Baca/Tulis | Indeks urutan tab untuk bidang ini. |
IsReadOnly | bool | Baca | Apakah bidang tersebut hanya-baca. |
ReadOnly | bool | Baca/Tulis | Apakah bidang bersifat hanya-baca (alias yang dapat diatur untuk parity API). |
IsRequired | bool | Baca | Apakah bidang wajib. |
Characteristics | Aspose.Pdf.Annotations.Characteristics | Baca | Karakteristik tampilan (warna border / latar belakang, rotasi widget). |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Baca/Tulis | Penampilan default (font, ukuran, warna) dari bidang — padanan tingkat bidang dari WidgetAnnotation. |
Rect | Rectangle? | Baca/Tulis | Persegi bidang. |
Color | Color | Baca/Tulis | Warna bidang (disimpan dalam string penampilan default /DA sebagai RGB). |
AnnotationIndex | int | Baca/Tulis | Posisi tab berbasis 1 dari widget bidang ini dalam array /Annots halaman tersebut — urutan array adalah urutan tab halaman. |
FitIntoRectangle | bool | Baca/Tulis | Bendera global: ketika true, nilai sebuah field otomatis diubah ukurannya agar sesuai dengan persegi panjang widget-nya. |
IsGroup | bool | Baca | Apakah field ini merupakan wadah/kelompok dari field anak. |
IsSharedField | bool | Baca/Tulis | Apakah field ini termasuk dalam grup shared-fields. |
IsSynchronized | bool | Baca | Apakah koleksi ini thread-safe. |
SyncRoot | object | Baca | Akar sinkronisasi; mengembalikan instance ini. |
MaxFontSize | double | Baca/Tulis | Ukuran font maksimum yang digunakan oleh penyesuaian otomatis tampilan bidang. |
MinFontSize | double | Baca/Tulis | Ukuran font minimum yang digunakan oleh penyesuaian otomatis tampilan bidang. |
MappingName | string? | Baca/Tulis | Nama pemetaan yang digunakan oleh skrip eksternal untuk mengidentifikasi bidang. |
AnnotationType | AnnotationType | Baca | Selalu Widget. |
Border | Border? | Baca/Tulis | Lebar border, gaya, dan pola dash diambil dari kamus BS widget (field formulir membawa border mereka di sana, bukan di /Border). |
Actions | AnnotationActionCollection | Baca | Slot aksi untuk /AA tree widget. |
Exportable | bool | Baca/Tulis | Apakah nilai widget harus diekspor pada pengiriman formulir. |
Highlighting | HighlightingMode | Baca/Tulis | Mode penyorotan visual yang digunakan saat pengguna mengklik widget (/H entry). |
Parent | Forms.Field? | Baca | Field Induk ketika widget ini merupakan anak visual dari field AcroForm. |
Required | bool | Baca/Tulis | Apakah widget harus diisi sebelum mengirim (/Ff bit 2). |
HighlightMode | string | Baca | Mode sorotan (/H entry). |
DefaultAppearanceString | string? | Baca | String tampilan default (/DA entry). |
FieldValue | string? | Baca | Nilai field (/V entry). |
DefaultFieldValue | string? | Baca | Nilai field default (/DV entry). |
FieldType | string? | Baca | Jenis field (/FT entry). |
InnerRect | Rectangle? | Baca | Persegi anotasi yang disisihkan oleh entri /RD (rectangle differences) — wilayah yang sebenarnya digambar di dalam Rect. |
Width | double | Baca/Tulis | Lebar persegi anotasi. |
Height | double | Baca/Tulis | Tinggi persegi panjang anotasi. |
Alignment | TextAlignment | Baca/Tulis | Perataan teks (untuk anotasi teks bebas / widget yang membawa teks kaya). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Baca/Tulis | Perataan horizontal (ditampilkan selain Alignment; keduanya dapat diatur secara independen). |
States | AppearanceDictionary | Baca | Kamus keadaan penampilan (sub-dikt per-keadaan dari AP/N, misalnya. |
UpdateAppearanceOnConvert | bool | Baca/Tulis | Apakah harus menghasilkan ulang appearance stream ketika anotasi disimpan ke dalam dokumen yang dikonversi. |
UseFontSubset | bool | Baca/Tulis | Apakah font yang disematkan (jika ada) harus disubset. |
Contents | string? | Baca/Tulis | Isi anotasi (teks). |
Opacity | double | Baca/Tulis | Opasitas anotasi (0.0 = transparan, 1.0 = buram). |
InteriorColor | Color? | Baca/Tulis | Warna interior anotasi (/IC entry, untuk anotasi lingkaran/persegi/garis). |
Title | string? | Baca/Tulis | Judul anotasi (penulis untuk anotasi markup). |
Name | string? | Baca/Tulis | Nama anotasi (pengidentifikasi unik — entri /NM). |
Subject | string? | Baca/Tulis | Subjek anotasi (/Subj entry). |
ModifiedDate | string? | Baca | Tanggal modifikasi. |
Modified | DateTime | Baca/Tulis | Tanggal /M (dimodifikasi) sebagai DateTime yang diketik. |
AnnotationFlags | AnnotationFlags | Baca/Tulis | Alias bertipe Flags yang sesuai dengan permukaan publik yang mengekspos AnnotationFlags sebagai properti. |
Action | PdfAction? | Baca/Tulis | Aksi yang terkait dengan anotasi ini (/A entry). |
Author | string? | Baca | Penulis anotasi (/T entry). |
AnnotationState | string? | Baca | Status anotasi (/State entry), misalnya. |
AnnotationStateModel | string? | Baca | Model status anotasi (entri /StateModel), mis. |
ReplyType | string? | Baca | Jenis balasan (entri /RT), mis. |
InReplyTo | Annotation? | Baca/Tulis | Anotasi yang dibalas oleh ini (/IRT entry). |
QuadPoints | Point[] | Baca/Tulis | QuadPoints sebagai array nilai Point. |
Page | Page? | Baca | Halaman yang memiliki anotasi ini, atau null ketika tidak dapat diselesaikan (misalnya. |
VerticalAlignment | VerticalAlignment | Baca/Tulis | Perataan vertikal yang diterapkan pada paragraf ini. |
Margin | MarginInfo | Baca/Tulis | Informasi margin luar diterapkan pada paragraf ini. |
IsFirstParagraphInColumn | bool | Baca/Tulis | Paksa paragraf untuk memulai kolom baru. |
IsKeptWithNext | bool | Baca/Tulis | Jaga paragraf ini tetap pada halaman yang sama dengan paragraf berikutnya. |
IsInNewPage | bool | Baca/Tulis | Paksa paragraf untuk mulai pada halaman baru. |
IsInLineParagraph | bool | Baca/Tulis | Bendera paragraf inline (tidak memulai baris baru). |
HyperlinkText | string? | Baca/Tulis | Target hyperlink bertipe string legacy. |
Hyperlink | Hyperlink? | Baca/Tulis | Dekorasi hyperlink bertipe diterapkan pada paragraf. |
ZIndex | int | Baca/Tulis | Indeks Z-order yang digunakan oleh perender DOM. |
Metode
| Tanda tangan | Deskripsi |
|---|---|
CheckboxField() | Bangun secara default bidang kotak centang yang tidak terikat. |
CheckboxField(doc: Document) | Bangun kotak centang yang terikat pada dokumen. |
CheckboxField(doc: Document, rect: Rectangle) | Bangun sebuah checkbox yang terikat pada doc dengan widget rect yang diberikan. |
CheckboxField(page: Page, rect: Rectangle) | Bangun sebuah checkbox pada page di rect yang diberikan. |
AddOption(optionName: string) | Tambahkan optionName sebagai status baru yang dapat dipilih pada kotak centang ini (digunakan untuk kotak centang berkelompok yang berperilaku seperti tombol radio). |
AddOption(optionName: string, rect: Rectangle) | Tambahkan opsi dengan widget rectangle yang eksplisit. |
AddOption(optionName: string, page: int, rect: Rectangle) | Tambahkan opsi yang menargetkan nomor halaman yang diberikan plus widget rectangle. |
Clone() | Kloning dangkal dari bidang. |
Field(doc: Document) | Buat sebuah bidang yang terikat pada dokumen. |
GetEnumerator() | Mengiterasi anotasi widget untuk anak-anak bidang ini dalam array /Kids. |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | Salin anotasi widget ke dalam array mulai dari indeks. |
CopyTo(array: Field[], index: int) | Salin anak-anak bidang ini (sebagai instance Field) ke dalam array mulai dari indeks. |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | Jalankan aksi JavaScript yang disediakan terhadap bidang ini. |
ExportToJson(stream: Stream) | Serialisasikan bidang ini ke JSON (sebuah objek FieldExportingData tunggal) melalui aliran yang disediakan. |
ExportToJson(fileName: string) | Serialisasikan bidang ini ke file JSON. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Serialisasikan bidang ini ke JSON melalui aliran yang disediakan. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Serialisasikan bidang ini ke file JSON. |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | Tuliskan nama, flag, dan nilai bidang ke aliran JSON. |
Flatten() | Ratakan bidang ini — ubah nilainya menjadi konten halaman statis. |
GetWidgetEnumerator() | Enumerator bertipe WidgetAnnotation. |
ImportValueFromJson(inputJsonStream: Stream) | Baca nilai bidang ini dari aliran JSON. |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | Baca nilai bidang yang bernama dari aliran JSON — sebuah objek bidang tunggal (mungkin bersarang melalui ChildFields) atau sebuah array darinya — dan terapkan nilai entri yang jalur bertitiknya cocok dengan fieldFullNameInJSON. |
Recalculate() | Hitung ulang nilai field dari skrip perhitungannya. |
SetPosition(point: Aspose.Pdf.Point) | Pindahkan persegi panjang widget pertama field ke titik yang diberikan (pojok kiri atas). |
WidgetAnnotation(doc: Document) | Ctor programatik — membuat anotasi widget kosong yang terkait dengan pembaca dokumen. |
ExportToJson(stream: System.IO.Stream) | Serialisasikan bidang widget ini sebagai JSON ke aliran. |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | Serialisasikan bidang widget ini sebagai satu objek FieldExportingData JSON ke aliran. |
GetCheckedStateName() | Mengembalikan nama status tampilan yang mewakili keadaan “on” / “checked” dari widget ini (biasanya “Yes”), yang diambil dari kunci kamus /AP/N (apapun yang bukan “Off”). |
Accept(visitor: AnnotationSelector) | Memanggil Accept(visitor) pada instance CheckboxField ini. |
GetRectangle(considerRotation: bool) | Persegi panjang pembatas disesuaikan oleh considerRotation. |
ChangeAfterResize(transform: Matrix) | Sesuaikan geometri anotasi setelah pengguna mengubah ukuran halaman atau persegi panjang host. |
UpdateAppearances() | Hasilkan kembali aliran tampilan normal (/AP /N) dari geometri dan warna anotasi saat ini. |
WriteXfdf(writer: System.Xml.XmlWriter) | Serialisasikan anotasi ini sebagai elemen XFDF ke penulis (PDF 32000 §12.7.8 / XFDF 3.0). |
