RichText.GetParagraphFormat

table RichText.GetParagraphFormat ( string ObjectName,
boolean OnlyConsistentAttributes = true )
Примеры

Описание

Возвращает таблицу, описывающую формат абзаца выделенного в настоящий момент в объекте RTF (richtext).

Параметры

ObjectName

(строка) Имя объекта RTF (richtext).

OnlyConsistentAttributes

(логический) Будет ли таблица содержать только атрибуты, которые не изменяются на протяжении всего выбранного текста. (Если значение установлено как истина (true), любые изменяемые атрибуты будут равны nil. Если значение установлено как ложь (false), таблица будет содержать все атрибуты первого выделенного абзаца.)

ЗНАЧЕНИЕ
VALUE
ОПИСАНИЕ
DESCRIPTION
trueСодержать только атрибуты, который не изменяются на протяжении всего выбранного текста (изменяемые атрибуты будут иметь значение nil). (По умолчанию)
falseОтобразить все атрибуты первого выделенного абзаца.

Возврат

ResultVariable

(таблица) Таблица описывающая формат абзаца выделенного в настоящий момент в объекте RTF (richtext), индексированная следующими значениями. Если ничего не выбрано или происходит ошибка, возвращается значение nil. Можно использовать действие Application.GetLastError для определения случился ли отказ в работе этого действия и почему.

Примечание: Функциональность некоторых пунктов может зависеть от версии управления RTF редактированием, имеющейся в системе пользователя.

КЛЮЧ
KEY
ТИП
TYPE
ОПИСАНИЕ
DESCRIPTION
BulletedлогическийЗначение истина (true) если выбранный текст маркирован, значение ложь (false), если не маркирован.
StartIndentчислоОтступ первой строки слева в твипах. (и всех последующих строк, если параметр Offset установлен как 0).
RightIndentчислоОтступ текста справа, относительно правого края, в твипах.
OffsetчислоОтступ второй и последующих строк, относительно отступа первой строки, в твипах.
AlignmentчислоВыравнивание абзаца:
PFA_LEFT (1) - Абзацы выравнены по левому краю.
PFA_RIGHT (2) - Абзацы выравнены по правому краю.
PFA_CENTER (3) - Абзацы выравнены по центру.
PFA_JUSTIFY (4) - Абзацы выравнены по обоим краям (выравнивание по ширине) (Rich Edit 2.0). Это значение включено для совместимости с интерфейсами TOM (Text Object Model); управление RTF редактированием ранее чем Rich Edit 3.0 отобразит текст выравненный по левому краю.
TabsтаблицаЧисленно индексированная таблица позиций табуляции.
SpaceBeforeчислоРазмер интервала перед абзацем, в твипах.
SpaceAfterчислоРазмер интервала после абзаца, в твипах.
LineSpacingчислоМежстрочный интервал основанный на параметре LineSpacingRule определяемом ниже.
LineSpacingRuleчислоТип межстрочного интервала, основанный на одном из следующих значений:
0 - Одинарный интервал. Пункт LineSpacing игнорируется.
1 - Полуторный интервал. Пункт LineSpacing игнорируется.
2 - Двойной интервал. Пункт LineSpacing игнорируется.
3 - Пункт LineSpacing определяет интервал между строками в твипах. Тем не менее, если пункт LineSpacing указывает значение меньше, чем одинарный интервал, элемент управления (контрол) RTF отобразит текст с одинарным интервалом.
4 - Пункт LineSpacing определяет интервал между строками в твипах. Элемент управления (контрол) RTF использует точное значение указанного интервала, даже если LineSpacing указывает значение меньше, чем одинарный интервал.
5 - Значение LineSpacing / 20 является размером интервала, в линиях, от одной строки до другой. Таким образом, установка пункта LineSpacing равной 20 делает одинарный интервал, 40 является двойным интервалом, 60 - тройным, и так далее.
BorderSpaceчислоРасстояние между границей и текстом абзаца, в твипах. Этот пункт включен только для совместимости с Word; управление RTF редактированием сохраняет значения, но не использует их при отображении текста.
BorderWidthчислоШирина границы, в твипах.
BordersчислоЭтот пункт включен только для совместимости и может не иметь никаких видимых эффектов. Для описания этой опции смотрите MSDN: PARAFORMAT2 Structure.

При добавлении действия из редактора скрипта, можно использовать это поле для определения переменной, которая возвращает значение, сохраняющееся в ней.
Смотрите также: Связанные действия

Примеры

Пример 1

tbFormat = RichText.GetParagraphFormat("RichText1", true);

if (tbFormat) then
    if (tbFormat.Bulleted) then
        Dialog.Message("Format", "The text is bulleted.");
    else
        Dialog.Message("Format", "The text is not bulleted.");
    end
end
Определяем является ли выделенный текст в объекте RTF (richtext) по имени "RichText1" маркированным и возвращаем результат в диалоговом окне сообщения.
Смотрите также: Связанные действия