TextBoxField
Обзор
TextBoxField — это класс в Aspose.PDF FOSS для .NET. Наследуется от: Field.
Этот класс предоставляет 33 метода для работы с объектами TextBoxField в программах .NET. Доступные методы включают: Accept, AddBarcode, AddImage, ChangeAfterResize, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName и 10 дополнительных методов. Все публичные члены доступны любому приложению .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags и ещё 82.
Свойства
| Имя: | Тип: | Доступ | Описание: |
|---|---|---|---|
MaxFontSize | double | Чтение/запись | Статический параметр по умолчанию, применяемый ко всем недавно созданным TextBoxFields с автоматической подгонкой внешнего вида. |
MinFontSize | double | Чтение/запись | Статический параметр по умолчанию, применяемый ко всем недавно созданным TextBoxFields с автоматической подгонкой внешнего вида — нижний предел для автоматически масштабируемого шрифта. |
FitIntoRectangle | bool | Чтение/запись | Статическое значение по умолчанию, применяемое ко всем вновь созданным TextBoxFields’ FitIntoRectangle флагам. |
Width | double | Чтение/запись | Ширина макета, когда поле размещено внутри контейнера макета (ячейка таблицы, абзац). |
Height | double | Чтение/запись | Высота макета, когда поле размещено внутри контейнера макета. |
Multiline | bool | Чтение/запись | Флаг многострочности (бит 13 в /Ff). |
MaxLen | int | Чтение/запись | Получает или задает максимальную длину. |
IsMultiline | bool | Чтение | Получает значение IsMultiline. |
IsPassword | bool | Чтение | Получает значение свойства IsPassword. |
TextVerticalAlignment | VerticalAlignment | Чтение/запись | Вертикальное выравнивание текста внутри внешнего вида поля. |
IsRichText | bool | Чтение | Истина, если у поля Tx установлен флаг rich-text (бит 26 в /Ff). |
Justification | int | Чтение | Выравнивание текста: 0 = слева, 1 = по центру, 2 = справа. |
ForceCombs | bool | Чтение/запись | Бит 25 в /Ff (Comb): когда установлен, поле делится на MaxLen равноширинных гребёнок. |
Scrollable | bool | Чтение/запись | Обратное значение бита 24 в /Ff (DoNotScroll). |
SpellCheck | bool | Чтение/запись | Обратное значение бита 23 в /Ff (DoNotSpellCheck). |
Value | string? | Чтение/запись | Текстовое значение, хранящееся в /V. |
Type | FieldType | Чтение | Тип поля. |
FullName | string? | Чтение | Полностью квалифицированное имя поля. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Переопределение горизонтального выравнивания, специфичного для текста, применённое к внешнему виду виджета поля. |
PageIndex | int | Чтение | Индекс страницы, начинающийся с 1, которой принадлежит виджет этого поля. |
PartialName | string? | Чтение/запись | Частичное имя поля (/T). |
NormalAppearance | XForm? | Чтение | Внешний вид поля “Normal” (запись /AP /N). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | Чтение | Потоки отображения виджета поля (запись /AP), индексированные по имени отображения. |
OnActivated | Annotations.PdfAction? | Чтение/запись | Действие, которое вызывается при активировании этого поля (/A entry). |
Count | int | Чтение | Количество дочерних элементов в массиве /Kids этого поля — либо дочерние поля (узлы иерархии), либо аннотации виджетов (терминальное поле с несколькими визуальными виджетами, например, сгруппированный флажок/радиокнопка). |
Fields | Field[] | Чтение | Дочерние элементы типа Field этого поля в виде массива-снимка — удобный аксессор, отражающий Fields в форме. |
DefaultValue | string? | Чтение | Значение по умолчанию (/DV). |
AlternateName | string? | Чтение/запись | Альтернативное имя поля / всплывающая подсказка (/TU entry). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | Чтение/запись | Флаги аннотации виджета (/F entry), например, |
TabOrder | int | Чтение/запись | Индекс порядка табуляции для этого поля. |
IsReadOnly | bool | Чтение | Определяет, является ли поле только для чтения. |
ReadOnly | bool | Чтение/запись | Определяет, является ли поле только для чтения (настраиваемый псевдоним для API parity). |
IsRequired | bool | Чтение | Требуется ли поле. |
Characteristics | Aspose.Pdf.Annotations.Characteristics | Чтение | Характеристики внешнего вида (цвета границы / фона, поворот виджета). |
DefaultAppearance | Aspose.Pdf.Annotations.DefaultAppearance | Чтение/запись | Внешний вид по умолчанию (шрифт, размер, цвет) поля — аналог на уровне поля для WidgetAnnotation. |
Rect | Rectangle? | Чтение/запись | Прямоугольник поля. |
Color | Color | Чтение/запись | Цвет поля (хранится в строке /DA по умолчанию как RGB). |
AnnotationIndex | int | Чтение/запись | 1-базовая позиция табуляции виджета этого поля в массиве /Annots его страницы — порядок массива соответствует порядку табуляции страницы. |
IsGroup | bool | Чтение | Является ли это поле контейнером/группой дочерних полей. |
IsSharedField | bool | Чтение/запись | Является ли это поле частью группы общих полей. |
IsSynchronized | bool | Чтение | Указывает, потокобезопасна ли коллекция. |
SyncRoot | object | Чтение | Корень синхронизации; возвращает этот экземпляр. |
MappingName | string? | Чтение/запись | Имя сопоставления, используемое внешними скриптами для идентификации поля. |
AnnotationType | AnnotationType | Чтение | Всегда Widget. |
Border | Border? | Чтение/запись | Ширина, стиль и шаблон штриховки границы берутся из BS-словаря widget (поля формы содержат свою границу там, а не в /Border). |
Actions | AnnotationActionCollection | Чтение | Слоты действий для /AA-дерева widget. |
Exportable | bool | Чтение/запись | Должно ли значение виджета экспортироваться при отправке формы. |
Highlighting | HighlightingMode | Чтение/запись | Режим визуального выделения, используемый, когда пользователь нажимает на виджет (/H entry). |
Parent | Forms.Field? | Чтение | Родительское поле, когда этот виджет является визуальным дочерним элементом поля AcroForm. |
Required | bool | Чтение/запись | Должен ли виджет быть заполнен перед отправкой (/Ff бит 2). |
HighlightMode | string | Чтение | Режим подсветки (/H entry). |
DefaultAppearanceString | string? | Чтение | Строка внешнего вида по умолчанию (/DA entry). |
FieldValue | string? | Чтение | Значение поля (/V entry). |
DefaultFieldValue | string? | Чтение | Значение поля по умолчанию (/DV entry). |
FieldType | string? | Чтение | Тип поля (/FT entry). |
InnerRect | Rectangle? | Чтение | Прямоугольник аннотации, уменьшенный записью /RD (различия прямоугольников) — область, фактически отрисованная внутри Rect. |
ActiveState | string? | Чтение/запись | Текущее активное состояние внешнего вида (/AS entry). |
Alignment | TextAlignment | Чтение/запись | Выравнивание текста (для аннотаций свободного текста / виджетов, содержащих форматированный текст). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Горизонтальное выравнивание (доступно дополнительно к Alignment; оба параметра можно задавать независимо). |
States | AppearanceDictionary | Чтение | Словарь состояний отображения (подсловарь для каждого состояния объекта AP/N, например, |
UpdateAppearanceOnConvert | bool | Чтение/запись | Следует ли заново генерировать поток отображения (appearance stream), когда аннотация сохраняется в преобразованном документе. |
UseFontSubset | bool | Чтение/запись | Должен ли встроенный шрифт (если он есть) быть субсетирован. |
Contents | string? | Чтение/запись | Содержимое аннотации (текст). |
Opacity | double | Чтение/запись | Непрозрачность аннотации (0.0 = прозрачный, 1.0 = непрозрачный). |
InteriorColor | Color? | Чтение/запись | Внутренний цвет аннотации (/IC entry, для аннотаций круга/квадрата/линии). |
Title | string? | Чтение/запись | Заголовок аннотации (автор для разметочных аннотаций). |
Name | string? | Чтение/запись | Имя аннотации (уникальный идентификатор — запись /NM). |
Subject | string? | Чтение/запись | Тема аннотации (запись /Subj). |
ModifiedDate | string? | Чтение | Дата изменения. |
Modified | DateTime | Чтение/запись | Дата /M (modified) как типизированный DateTime. |
AnnotationFlags | AnnotationFlags | Чтение/запись | Типизированный псевдоним Flags, соответствующий публичному интерфейсу, который раскрывает AnnotationFlags как свойство. |
Action | PdfAction? | Чтение/запись | Действие, связанное с этой аннотацией (/A entry). |
Author | string? | Чтение | Автор аннотации (/T entry). |
AnnotationState | string? | Чтение | Состояние аннотации (/State entry), например. |
AnnotationStateModel | string? | Чтение | Модель состояния аннотации (/StateModel entry), например. |
ReplyType | string? | Чтение | Тип ответа (/RT entry), например. |
InReplyTo | Annotation? | Чтение/запись | Аннотация, на которую отвечает эта (/IRT entry). |
QuadPoints | Point[] | Чтение/запись | QuadPoints как массив значений Point. |
Page | Page? | Чтение | Страница, которой принадлежит эта аннотация, или null, когда её нельзя определить (например, |
VerticalAlignment | VerticalAlignment | Чтение/запись | Вертикальное выравнивание, применённое к этому абзацу. |
Margin | MarginInfo | Чтение/запись | Информация внешних отступов применена к этому абзацу. |
IsFirstParagraphInColumn | bool | Чтение/запись | Заставить абзац начать новую колонку. |
IsKeptWithNext | bool | Чтение/запись | Оставить этот абзац на той же странице, что и следующий. |
IsInNewPage | bool | Чтение/запись | Принудить абзац начинаться на новой странице. |
IsInLineParagraph | bool | Чтение/запись | Флаг встроенного абзаца (не начинается с новой строки). |
HyperlinkText | string? | Чтение/запись | Унаследованная строковая цель гиперссылки. |
Hyperlink | Hyperlink? | Чтение/запись | Оформление гиперссылки определённого типа, применённое к абзацу. |
ZIndex | int | Чтение/запись | Индекс Z-порядка, используемый рендерером DOM. |
Методы
| Подпись | Описание: |
|---|---|
TextBoxField(page: Page, rect: Rectangle) | Создаёт новое поле текстового блока на указанной странице с заданным прямоугольником. |
TextBoxField(doc: Document, rect: Rectangle) | Создаёт новое поле текстового блока, связанное с документом (страница назначается через Form.Add). |
TextBoxField(doc: Document) | Текстовый блок, привязанный к документу, без прямоугольника. |
TextBoxField(page: Page, rects: Rectangle[]) | Многовиджетное текстовое поле — первый прямоугольник используется для словаря виджета; дополнительные прямоугольники сохраняются в /Kids в соответствии с контрактом многовиджетности. |
TextBoxField() | Конструктор без параметров — создает несвязанное поле текстового ввода. |
AddBarcode(code: string) | Закодировать код как заполнительный штрих-код в значении поля. |
AddImage(image: System.Drawing.Image) | Заглушка поддержки наложения изображения. |
Field(doc: Document) | Создать поле, привязанное к документу. |
GetEnumerator() | Итерирует аннотации виджетов для дочерних элементов этого поля в массиве /Kids. |
CopyTo(array: Aspose.Pdf.Annotations.WidgetAnnotation[], index: int) | Скопировать аннотации виджета в массив, начиная с индекса. |
CopyTo(array: Field[], index: int) | Скопировать дочерние элементы этого поля (в виде экземпляров Field) в массив, начиная с индекса. |
ExecuteFieldJavaScript(javaScriptAction: Aspose.Pdf.Annotations.JavascriptAction) | Выполнить предоставленное действие JavaScript над этим полем. |
ExportToJson(stream: Stream) | Сериализовать это поле в JSON (единственный объект FieldExportingData) через предоставленный поток. |
ExportToJson(fileName: string) | Сериализуйте это поле в файл JSON. |
ExportToJson(stream: Stream, options: ExportFieldsToJsonOptions?) | Сериализуйте это поле в JSON через предоставленный поток. |
ExportToJson(fileName: string, options: ExportFieldsToJsonOptions?) | Сериализуйте это поле в файл JSON. |
ExportValueToJson(outputJsonStream: Stream, indented: bool) | Запишите имя поля, флаги и значение в поток JSON. |
Flatten() | Сведите это поле к плоскому виду — преобразуйте его значение в статический контент страницы. |
GetWidgetEnumerator() | Перечислитель типизирован как WidgetAnnotation. |
ImportValueFromJson(inputJsonStream: Stream) | Прочитайте значение этого поля из потока JSON. |
ImportValueFromJson(inputJsonStream: Stream, fieldFullNameInJSON: string) | Прочитайте значение именованного поля из потока JSON — отдельный объект поля (возможно вложенный через ChildFields) или массив таких объектов — и примените значение записи, чей точечный путь соответствует fieldFullNameInJSON. |
Recalculate() | Пересчитайте значение поля из его скрипта расчёта. |
SetPosition(point: Aspose.Pdf.Point) | Переместите прямоугольник первого виджета поля к указанной точке (верхний левый угол). |
WidgetAnnotation(doc: Document) | Программный ctor — создает чистую аннотацию виджета, связанную с читателем документа. |
ExportToJson(stream: System.IO.Stream) | Сериализуйте поле этого виджета как JSON в поток. |
ExportToJson(stream: System.IO.Stream, options: ExportFieldsToJsonOptions?) | Сериализуйте поле этого виджета как один объект FieldExportingData JSON в поток. |
GetCheckedStateName() | Возвращает имя состояния отображения, которое представляет состояние “on” / “checked” данного виджета (обычно “Yes”), полученное из ключей словаря /AP/N (любое, которое не является “Off”). |
Accept(visitor: AnnotationSelector) | Вызывает Accept(visitor) у этого экземпляра TextBoxField. |
GetRectangle(considerRotation: bool) | Ограничивающий прямоугольник, скорректированный с учётом considerRotation. |
ChangeAfterResize(transform: Matrix) | Отрегулируйте геометрию аннотации после того, как пользователь изменил размер страницы или хост-прямоугольника. |
UpdateAppearances() | Перегенерировать обычный поток отображения (/AP /N) из текущей геометрии и цветов аннотации. |
WriteXfdf(writer: System.Xml.XmlWriter) | Сериализовать эту аннотацию как элемент XFDF в writer (PDF 32000 §12.7.8 / XFDF 3.0). |
Clone() | Поверхностное клонирование — копирует скалярное/по ссылке совместно используемое состояние. |
