RichText.GetSelectionFormat

table RichText.GetSelectionFormat ( 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 для определения случился ли отказ в работе этого действия и почему.

Примечание: Некоторые из следующих пунктов таблицы включены только для совместимости с интерфейсами Microsoft Text Object Model (TOM); элемент управления (конторол) сохраняет значение, но не использует его для отображения текста. Функциональность некоторых пунктов также может зависеть от версии управления RTF редактированием, имеющейся в системе пользователя.

КЛЮЧ
KEY
ТИП
TYPE
ОПИСАНИЕ
DESCRIPTION
AllCapsлогическийЗначение истина (true), если все выделенные символы являются заглавными (прописными) и значение ложь (false), если они не являются ими. Это значение применяется только в версиях более ранних, чем Rich Edit 3.0.
AutoBackColorлогический Значение истина (true), если цвет фона является цветом фона объекта для выделенного текста (пункт BackColor проигнорирован), значение ложь (false), если пункт BackColor используется.
AutoColorлогический Значение истина (true), если цвет текста является цветом текста для выделенного текста (пункт TextColor игнорируется), значение ложь (false) если TextColor используется.
BoldлогическийЗначение истина (true), если выделенный текст набран жирным шрифтом, значение ложь (false), если это не так.
DisabledлогическийЗначение истина (true), если символы показаны как отключенные, значение ложь (false), если это не так.
EmbossлогическийЗначение истина (true) если символы рельефные (выдавленые), значение ложь (false), если это не так. (Это значение не влияет на отображаемый текст в объекте.)
HiddenлогическийЗначение истина (true) если символы отображаются, значение ложь (false), если это не так. Этот пункт поддерживается только Rich Edit 3.0 и более поздними версиями.
ImprintлогическийЗначение истина (true) если символы показаны как тисненые, значение ложь (false), если это не так. (Это значение не влияет на отображаемый текст в объекте.)
ItalicлогическийЗначение истина (true), если выделенный текст набран курсивом, значение ложь (false), если это не так.
LinkлогическийЗначение истина (true), если выделенный текст содержит ссылки, значение ложь (false), если это не так.
OutlineлогическийЗначение истина (true) если символы показаны как очерченные, значение ложь (false), если это не так. (Это значение не влияет на отображаемый текст в объекте.)
ProtectedлогическийЗначение истина (true) если символы являются защищенными, значение ложь (false), если это не так.
RevisedлогическийЗначение истина (true) если символы отмечены как исправленные, значение ложь (false), если это не так.
ShadowлогическийЗначение истина (true) если символы показаны как затененные, значение ложь (false), если это не так. (Это значение не влияет на отображаемый текст в объекте.)
SmallCapsлогическийЗначение истина (true) если символы показаны как малые прописные (заглавные) буквы, значение ложь (false), если это не так. (Это значение не влияет на отображаемый текст в объекте.)
StrikeOutлогическийЗначение истина (true) если символы зачеркнуты, значение ложь (false), если это не так.
SubScriptлогическийЗначение истина (true) если символы подстрочные, значение ложь (false), если это не так.
SuperScriptлогическийЗначение истина (true) если символы надстрочные, значение ложь (false), если это не так.
UnderlineлогическийЗначение истина (true) если символы подчеркнуты, значение ложь (false), если это не так.
HeightчислоВысота символов в твипах.
YOffsetчислоСмещение символа относительно базовой линии, в твипах. Если это значение положительно, символ надстрочный; если это значение отрицательно, символ подстрочный.
TextColorчислоЦвет текста. Этот пункт игнорируется, если параметр AutoColor установлен как истина (true).
CharacterSetчислоНабор символов, установленный в тексте:

КОНСТАНТА
CONSTANT
ЗНАЧЕНИЕ
VALUE
ОПИСАНИЕ
DESCRIPTION
ANSI_CHARSET0Набор символов ANSI.
BALTIC_CHARSET186Балтийский набор символов.
CHINESEBIG5_CHARSET136Китайский набор символов.
DEFAULT_CHARSET1Набор символов по умолчанию.
EASTEUROPE_CHARSET238Восточно европейский набор символов.
GB2312_CHARSET134Набор символов GB2312.
GREEK_CHARSET161Греческий набор символов.
HANGUL_CHARSET129Корейский (хангул) набор символов.
MAC_CHARSET77Набор символов MAC.
OEM_CHARSET255Набор символов OEM.
RUSSIAN_CHARSET204Русский набор символов.
SHIFTJIS_CHARSET128Набор символов Shiftjis.
SYMBOL_CHARSET2Символьный набор символов.
TURKISH_CHARSET162Турецкий набор символов.
PitchAndFamilyчислоСемейство шрифтов и плотность записи (количество знаков на дюйм, питч). Для более подробной информации посмотрите MSDN: CHARFORMAT2 Structure.
FaceNameстрокаНазвание шрифта, используемого в выделенном тексте.
WeightчислоПлотность шрифта (какой степени "черноты" будет показан текст):

КОНСТАНТА
CONSTANT
ЗНАЧЕНИЕ
VALUE
ОПИСАНИЕ
DESCRIPTION
FW_DONTCARE0Плотность шрифта не указана.
FW_THIN100Плотность шрифта 'тонкий - thin'.
FW_EXTRALIGHT200Плотность шрифта 'экстрасветлый - extra-light'.
FW_LIGHT300Плотность шрифта 'светлый - light'.
FW_NORMAL400Плотность шрифта 'стандартный - normal'.
FW_MEDIUM500Плотность шрифта 'средний - medium'.
FW_SEMIBOLD600Плотность шрифта 'полужирный - semi-bold'.
FW_BOLD700Плотность шрифта 'жирный - bold'.
FW_EXTRABOLD800Плотность шрифта 'экстражирный - extra bold'.
FW_HEAVY900Плотность шрифта 'тяжелый - heavy'.
SpacingчислоГоризонтальное расстояние между буквами, в твипах. (Это значение не влияет на отображаемый текст в объекте. Включено для совместимости с интерфейсами Microsoft Windows Text Object Model (TOM).)
BackColorчислоЦвет фона. Это значение игнорируется, если пункт AutoBackColor установлен как истина (true).
LCIDчислоИдентификатор языка выделенного текста. (Это значение не влияет на отображаемый текст в объекте.) Для более подробной информации смотрите MSDN: CHARFORMAT2 Structure.
KerningчислоЗначение размера шрифта, выше которого находятся выносные элементы символа (Height). (Это значение не влияет на отображаемый текст в объекте. Включено для совместимости с интерфейсами Microsoft Windows Text Object Model (TOM).)
StyleчислоДескриптор стиля символа. (Это значение не влияет на отображаемый текст в объекте. Включено для совместимости с интерфейсами Microsoft Windows Text Object Model (TOM).)
UnderlineTypeчислоТип подчеркивания определяемый одним из следующих значений:
CFU_CF1UNDERLINE (255) - Содержит тип подчеркивания CHARFORMAT.
CFU_UNDERLINENONE (0) - Без подчеркивания. Это значение по умолчанию.
CFU_UNDERLINE (1) - Текст подчеркнут сплошной, непрерывной линией.
CFU_UNDERLINEWORD (2) - Подчеркнуты только слова. Объект покажет текст подчеркнутым сплошной линией. CFU_UNDERLINEDOUBLE (3) - Текст подчеркнут двойной линией. Объект покажет текст подчеркнутым сплошной линией.
CFU_UNDERLINEDOTTED (4) - Пунктирно подчеркнутый текст. Для версий более ранних, чем Rich Edit 3.0, текст будет показан как подчеркнутый сплошной линией.
AnimationчислоТип анимации текста. (Это значение не оказывает влияния на отображение текста в объекте. Он включен для совместимости с интерфейсами TOM.)
RevAuthorчислоИндекс идентифицирующий автора, делавшего изменения. Элемент управления (контрол) редактированием RTF использует различные цвета текста для индекса любого отдельного автора.

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

Примеры

Пример 1

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

if (tbFormat) then
    if (tbFormat.Bold) then
        Dialog.Message("Format", "The selected characters are all bold.");
    else
        Dialog.Message("Format", "The selected characters are not all bold.");
    end
end
Определяем набраны ли полужирным шрифтом все выделенные символы в объекте RTF (richtext) "RichText1" и показываем результат в диалоговом окне сообщения. Это делается с помощью действия RichText.GetSelectionFormat и проверяется пункт "Bold" таблицы.
Смотрите также: Связанные действия