Field
Przegląd
Field jest klasą w Aspose.PDF FOSS dla .NET. Dziedziczy po: Aspose.Pdf.Annotations.WidgetAnnotation, IEnumerable<Aspose.Pdf.Annotations.WidgetAnnotation>.
Reprezentuje pole formularza.
Ta klasa udostępnia 26 metod do pracy z obiektami Field w programach .NET. Dostępne metody obejmują: Accept, ChangeAfterResize, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName, GetEnumerator, GetRectangle oraz 7 dodatkowych metod. Wszystkie publiczne elementy są dostępne dla dowolnej aplikacji .NET po zainstalowaniu pakietu Aspose.PDF FOSS dla .NET. Właściwości: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags oraz 72 dodatkowe.
Właściwości
| Nazwa | Typ | Dostęp | Opis |
|---|---|---|---|
Type | FieldType | Odczyt | Typ pola. |
FullName | string? | Odczyt | W pełni kwalifikowana nazwa pola. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Odczyt/zapis | Nadpisanie poziomego wyrównania specyficznego dla tekstu zastosowane do wyglądu widżetu pola. |
PageIndex | int | Odczyt | Indeks (liczony od 1) strony, której widżet tego pola jest własnością. |
PartialName | string? | Odczyt/zapis | Częściowa nazwa pola (/T). |
NormalAppearance | XForm? | Odczyt | Wygląd pola “Normal” (wpis /AP /N). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | Odczyt | Strumienie wyglądu widżetu pola (wpis /AP), kluczowane nazwą wyglądu. |
OnActivated | Annotations.PdfAction? | Odczyt/zapis | Akcja wywoływana, gdy to pole jest aktywowane (wpis /A). |
Value | string? | Odczyt/zapis | Wartość pola (/V). |
Count | int | Odczyt | Liczba elementów w tablicy /Kids tego pola — albo pola podrzędne (węzły hierarchii), albo adnotacje widgetów (pole końcowe z wieloma wizualnymi widgetami, takimi jak grupowany checkbox/radio). |
Fields | Field[] | Odczyt | Dzieci pola typu Field jako tablica migawkowa — wygodny dostępnik odzwierciedlający pola w formularzu. |
DefaultValue | string? | Odczyt | Domyślna wartość (/DV). |
AlternateName | string? | Odczyt/zapis | Alternatywna nazwa pola / podpowiedź (/TU entry). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | Odczyt/zapis | Flagi adnotacji widgetu (/F entry), np. |
TabOrder | int | Odczyt/zapis | Indeks kolejności tabulacji dla tego pola. |
IsReadOnly | bool | Odczyt | Czy pole jest tylko do odczytu. |
ReadOnly | bool | Odczyt/zapis | Czy pole jest tylko do odczytu (ustawialny alias dla API parity). |
IsRequired | bool | Odczyt | Czy pole jest wymagane. |
Characteristics | Aspose.Pdf.Annotations.Characteristics | Odczyt | Cechy wyglądu (kolory obramowania / tła, obrót widżetu). |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Odczyt/zapis | Domyślny wygląd (czcionka, rozmiar, kolor) pola — odpowiednik na poziomie pola dla WidgetAnnotation. |
Rect | Rectangle? | Odczyt/zapis | Prostokąt pola. |
Color | Color | Odczyt/zapis | Kolor pola (przechowywany w ciągu domyślnego wyglądu /DA jako RGB). |
AnnotationIndex | int | Odczyt/zapis | Pozycja zakładki w tabulacji, liczona od 1, tego widżetu pola w tablicy /Annots strony — kolejność w tablicy jest kolejnością zakładek na stronie. |
FitIntoRectangle | bool | Odczyt/zapis | Flaga globalna: gdy jest ustawiona na true, wartość pola jest automatycznie skalowana, aby pasowała do prostokąta jego widżetu. |
IsGroup | bool | Odczyt | Czy to pole jest kontenerem/grupą pól podrzędnych. |
IsSharedField | bool | Odczyt/zapis | Czy to pole należy do grupy shared-fields. |
IsSynchronized | bool | Odczyt | Czy kolekcja jest thread-safe. |
SyncRoot | object | Odczyt | Korzeń synchronizacji; zwraca tę instancję. |
MaxFontSize | double | Odczyt/zapis | Maksymalny rozmiar czcionki używany przy automatycznym dopasowaniu wyglądu pola. |
MinFontSize | double | Odczyt/zapis | Minimalny rozmiar czczcionki używany przy automatycznym dopasowaniu wyglądu pola. |
MappingName | string? | Odczyt/zapis | Nazwa mapowania używana przez zewnętrzne skrypty do identyfikacji pola. |
AnnotationType | AnnotationType | Odczyt | Zawsze Widget. |
Border | Border? | Odczyt/zapis | Szerokość obramowania, styl i wzór kreski są określane na podstawie słownika BS widgetu (pola formularza przechowują swoje obramowanie tam, a nie w /Border). |
Actions | AnnotationActionCollection | Odczyt | Sloty akcji dla drzewa /AA widżetu. |
Exportable | bool | Odczyt/zapis | Czy wartość widżetu powinna być eksportowana przy wysyłaniu formularza. |
Highlighting | HighlightingMode | Odczyt/zapis | Tryb wizualnego podświetlenia używany, gdy użytkownik kliknie widżet (/H entry). |
Parent | Forms.Field? | Odczyt | Pole nadrzędne, gdy ten widżet jest wizualnym dzieckiem pola AcroForm. |
Required | bool | Odczyt/zapis | Czy widżet musi być wypełniony przed wysłaniem (/Ff bit 2). |
HighlightMode | string | Odczyt | Tryb podświetlenia (/H entry). |
DefaultAppearanceString | string? | Odczyt | Domyślny ciąg wyglądu (/DA entry). |
FieldValue | string? | Odczyt | Wartość pola (/V entry). |
DefaultFieldValue | string? | Odczyt | Domyślna wartość pola (/DV entry). |
FieldType | string? | Odczyt | Typ pola (/FT entry). |
InnerRect | Rectangle? | Odczyt | Prostokąt adnotacji wcięty przez wpis /RD (różnice prostokątów) — region faktycznie rysowany wewnątrz Rect. |
Width | double | Odczyt/zapis | Szerokość prostokąta adnotacji. |
Height | double | Odczyt/zapis | Wysokość prostokąta adnotacji. |
ActiveState | string? | Odczyt/zapis | Obecnie aktywny stan wyglądu (wpis /AS). |
Alignment | TextAlignment | Odczyt/zapis | Wyrównanie tekstu (dla adnotacji typu wolny tekst / widżet zawierających tekst sformatowany). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Odczyt/zapis | Wyrównanie poziome (udostępniane dodatkowo oprócz Alignment; oba można ustawiać niezależnie). |
States | AppearanceDictionary | Odczyt | Słownik stanu wyglądu (pod-słownik per-stanu AP/N, np.). |
UpdateAppearanceOnConvert | bool | Odczyt/zapis | Czy odtworzyć strumień wyglądu, gdy adnotacja jest zapisywana w przekształconym dokumencie. |
UseFontSubset | bool | Odczyt/zapis | Czy osadzona czcionka (jeśli istnieje) powinna być podzestawiona. |
Contents | string? | Odczyt/zapis | Zawartość adnotacji (tekst). |
Opacity | double | Odczyt/zapis | Przezroczystość adnotacji (0,0 = przezroczysta, 1,0 = nieprzezroczysta). |
InteriorColor | Color? | Odczyt/zapis | Kolor wnętrza adnotacji (/IC entry, dla adnotacji okrąg/kwadrat/linia). |
Title | string? | Odczyt/zapis | Tytuł adnotacji (autor dla adnotacji znacznikowych). |
Name | string? | Odczyt/zapis | Nazwa adnotacji (unikalny identyfikator — wpis /NM). |
Subject | string? | Odczyt/zapis | Temat adnotacji (wpis /Subj). |
ModifiedDate | string? | Odczyt | Data modyfikacji. |
Modified | DateTime | Odczyt/zapis | Data /M (zmodyfikowana) jako wpisany DateTime. |
AnnotationFlags | AnnotationFlags | Odczyt/zapis | Typowany alias Flags pasujący do publicznego interfejsu, który udostępnia AnnotationFlags jako właściwość. |
Action | PdfAction? | Odczyt/zapis | Akcja powiązana z tą adnotacją (/A entry). |
Author | string? | Odczyt | Autor adnotacji (/T entry). |
AnnotationState | string? | Odczyt | Stan adnotacji (/State entry), np. |
AnnotationStateModel | string? | Odczyt | Model stanu adnotacji (/StateModel entry), np. |
ReplyType | string? | Odczyt | Typ odpowiedzi (/RT entry), np. |
InReplyTo | Annotation? | Odczyt/zapis | Adnotacja, na którą ta odpowiada (/IRT entry). |
QuadPoints | Point[] | Odczyt/zapis | QuadPoints jako tablica wartości Point. |
Page | Page? | Odczyt | Strona, do której należy ta adnotacja, lub null, gdy nie można jej rozwiązać (np. |
VerticalAlignment | VerticalAlignment | Odczyt/zapis | Wyrównanie pionowe zastosowane do tego akapitu. |
Margin | MarginInfo | Odczyt/zapis | Informacja o zewnętrznym marginesie zastosowana do tego akapitu. |
IsFirstParagraphInColumn | bool | Odczyt/zapis | Wymuś rozpoczęcie akapitu w nowej kolumnie. |
IsKeptWithNext | bool | Odczyt/zapis | Zachowaj ten akapit na tej samej stronie co kolejny. |
IsInNewPage | bool | Odczyt/zapis | Wymuś, aby akapit zaczynał się na nowej stronie. |
IsInLineParagraph | bool | Odczyt/zapis | Flaga wiersza inline (nie rozpoczyna nowej linii). |
HyperlinkText | string? | Odczyt/zapis | Dziedziczny cel hiperłącza typu string. |
Hyperlink | Hyperlink? | Odczyt/zapis | Dekoracja typowanego hiperłącza zastosowana do akapitu. |
ZIndex | int | Odczyt/zapis | Indeks Z-order używany przez renderer DOM. |
Metody
| Sygnatura | Opis |
|---|---|
Field(doc: Document) | Utwórz pole powiązane z dokumentem. |
GetEnumerator() | Iteruje adnotacje widgetów dla dzieci tego pola w tablicy /Kids. |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | Skopiuj adnotacje widgetów do tablicy zaczynając od indeksu. |
CopyTo(array: Field[], index: int) | Skopiuj dzieci tego pola (jako instancje Field) do tablicy zaczynając od indeksu. |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | Wykonaj dostarczoną akcję JavaScript na tym polu. |
ExportToJson(stream: Stream) | Serializuj to pole do JSON (pojedynczego obiektu FieldExportingData) za pomocą dostarczonego strumienia. |
ExportToJson(fileName: string) | Serializuj to pole do pliku JSON. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Serializuj to pole do JSON za pomocą dostarczonego strumienia. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Zserializuj to pole do pliku JSON. |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | Zapisz nazwę pola, flagi oraz wartość do strumienia JSON. |
Flatten() | Spłaszcz to pole — przekształć jego wartość w statyczną treść strony. |
GetWidgetEnumerator() | Enumerator typowany na WidgetAnnotation. |
ImportValueFromJson(inputJsonStream: Stream) | Odczytaj wartość tego pola ze strumienia JSON. |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | Odczytaj wartość nazwanego pola ze strumienia JSON — pojedynczego obiektu pola (ewentualnie zagnieżdżonego przy użyciu ChildFields) lub ich tablicy — i zastosuj wartość wpisu, którego kropkowa ścieżka pasuje do fieldFullNameInJSON. |
Recalculate() | Przelicz ponownie wartość pola z jego skryptu obliczeniowego. |
SetPosition(point: Aspose.Pdf.Point) | Przesuń prostokąt pierwszego widżetu pola do podanego punktu (lewy górny róg). |
WidgetAnnotation(doc: Document) | Programowy ctor — tworzy pustą adnotację widgetu powiązaną z czytnikiem dokumentu. |
ExportToJson(stream: System.IO.Stream) | Serializuj pole tego widgetu jako JSON do strumienia. |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | Serializuj pole tego widgetu jako pojedynczy obiekt FieldExportingData JSON do strumienia. |
GetCheckedStateName() | Zwraca nazwę stanu wyglądu, który reprezentuje stan „on” / „zaznaczony” tego widgetu (zwykle „Yes”), odczytywaną z kluczy słownika /AP/N (wszystko, co nie jest „Off”). |
Accept(visitor: AnnotationSelector) | Wywołuje Accept(visitor) na tej instancji Field. |
GetRectangle(considerRotation: bool) | Prostokąt ograniczający dostosowany przez considerRotation. |
ChangeAfterResize(transform: Matrix) | Dostosuj geometrię adnotacji po tym, jak użytkownik zmienił rozmiar strony lub prostokąta nadrzędnego. |
UpdateAppearances() | Wygeneruj ponownie normalny strumień wyglądu (/AP /N) na podstawie bieżącej geometrii i kolorów adnotacji. |
WriteXfdf(writer: System.Xml.XmlWriter) | Serializuj tę adnotację jako element XFDF do writer (PDF 32000 §12.7.8 / XFDF 3.0). |
Clone() | Płytka kopia — kopiuje skalarne/udostępnione referencyjnie stany. |