RichTextBoxField
Обзор
RichTextBoxField — это класс в Aspose.PDF FOSS для .NET. Наследуется от: TextBoxField.
Поле формы Tx, которое содержит флаг rich-text (бит 26 в /Ff).
Этот класс предоставляет 34 метода для работы с объектами RichTextBoxField в программах .NET. Доступные методы включают: Accept, AddBarcode, AddImage, ChangeAfterResize, Clone, CopyTo, ExecuteFieldJavaScript, ExportToJson, ExportValueToJson, Field, Flatten, GetCheckedStateName и ещё 11 методов. Все публичные члены доступны любому приложению .NET после установки пакета Aspose.PDF FOSS для .NET. Свойства: Action, Actions, ActiveState, Alignment, AlternateName, AnnotationFlags и ещё 86.
Свойства
| Имя: | Тип: | Доступ | Описание: |
|---|---|---|---|
RichTextValue | string? | Чтение/запись | Rich-text представление значения поля (запись PDF /RV). |
FormattedValue | string? | Чтение/запись | Отформатированное (rich-text) представление; синоним для RichTextValue. |
Value | string? | Чтение/запись | Текстовое значение, отображаемое этим полем (/V entry). |
Style | string | Чтение/запись | CSS-style строка стиля, применяемая к фрагментам форматированного текста — например, |
Justify | Aspose.Pdf.Annotations.Justification | Чтение/запись | Выравнивание текста. |
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 | Чтение | Получает значение is password. |
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). |
Type | FieldType | Чтение | Тип поля. |
FullName | string? | Чтение | Полностью квалифицированное имя поля. |
TextHorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Переопределение горизонтального выравнивания, специфичного для текста, применённое к отображению виджета поля. |
PageIndex | int | Чтение | Индекс страницы, начинающийся с 1, которой принадлежит виджет этого поля. |
PartialName | string? | Чтение/запись | Частичное имя поля (/T). |
NormalAppearance | XForm? | Чтение | Обычное отображение поля (запись /AP /N). |
Appearance | Aspose.Pdf.Annotations.AppearanceDictionary | Чтение | Потоки отображения виджета поля (запись /AP), ключированные по имени отображения. |
OnActivated | Annotations.PdfAction? | Чтение/запись | Действие, вызываемое при активации этого поля (/A entry). |
Count | int | Чтение | Количество элементов в массиве /Kids этого поля — либо дочерних полей (узлы иерархии), либо аннотаций-виджетов (конечное поле с несколькими визуальными виджетами, например, сгруппированными checkbox/radio). |
Fields | Field[] | Чтение | Дочерние элементы типа Field этого поля в виде массива-снимка — удобный аксессор, отражающий Fields в форме. |
DefaultValue | string? | Чтение | Значение по умолчанию (/DV). |
AlternateName | string? | Чтение/запись | Альтернативное имя поля / подсказка (запись /TU). |
Flags | Aspose.Pdf.Annotations.AnnotationFlags | Чтение/запись | Флаги аннотации виджета (запись /F), например, |
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 default appearance как RGB). |
AnnotationIndex | int | Чтение/запись | Позиция вкладки, начинающаяся с 1, виджета этого поля в массиве /Annots страницы — порядок элементов массива соответствует порядку вкладок на странице. |
IsGroup | bool | Чтение | Является ли это поле контейнером/группой дочерних полей. |
IsSharedField | bool | Чтение/запись | Является ли это поле частью группы общих полей. |
IsSynchronized | bool | Чтение | Указывает, является ли коллекция потокобезопасной. |
SyncRoot | object | Чтение | Корень синхронизации; возвращает этот экземпляр. |
MappingName | string? | Чтение/запись | Имя сопоставления, используемое внешними скриптами для идентификации поля. |
AnnotationType | AnnotationType | Чтение | Всегда Widget. |
Border | Border? | Чтение/запись | Ширина границы, стиль и шаблон пунктирной линии берутся из словаря BS виджета (поля формы сохраняют свою границу там, а не в /Border). |
Actions | AnnotationActionCollection | Чтение | Слоты действий для дерева /AA виджета. |
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). |
FieldType | string? | Чтение | Тип поля (запись /FT). |
InnerRect | Rectangle? | Чтение | Прямоугольник аннотации, смещённый записью /RD (различия прямоугольников) — область, фактически отрисовываемая внутри Rect. |
ActiveState | string? | Чтение/запись | Текущее активное состояние внешнего вида (/AS entry). |
Alignment | TextAlignment | Чтение/запись | Выравнивание текста (для аннотаций свободного текста / виджетов, содержащих форматированный текст). |
HorizontalAlignment | Aspose.Pdf.HorizontalAlignment | Чтение/запись | Горизонтальное выравнивание (доступно дополнительно к Alignment; оба могут устанавливаться независимо). |
States | AppearanceDictionary | Чтение | Словарь состояний отображения (подсловарь per-state объекта AP/N, например.). |
UpdateAppearanceOnConvert | bool | Чтение/запись | Нужно ли регенерировать поток отображения при сохранении аннотации в преобразованном документе. |
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). |
Author | string? | Чтение | Автор аннотации (запись /T). |
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-order, используемый рендерером DOM. |
Методы
| Подпись | Описание: |
|---|---|
RichTextBoxField(page: Page, rect: Rectangle) | Создать поле с форматированным текстом в указанном прямоугольнике страницы. |
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) у этого экземпляра RichTextBoxField. |
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() | Поверхностное клонирование — копирует скалярное/по-ссылке-общее состояние. |
