RichText.SetSelectionFormat

RichText.SetSelectionFormat ( string ObjectName,
table CharacterFormat,
boolean ApplyToWord = false )
Примеры

Описание

Устанавливает символьное форматирование выделенного в настоящий момент текста в объекте RTF (richtext).

Параметры

ObjectName

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

CharacterFormat

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

Примечание: Некоторые из следующих пунктов таблицы включены только для совместимости с интерфейсами 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 WindowsText Object Model (TOM).)
BackColorчислоУстанавливаемый цвет фона. Это значение игнорируется, если пункт AutoBackColor установлен как истина (true).
LCIDчислоИдентификатор языка выделенного текста. (Это значение не влияет на отображаемый текст в объекте.) Для более подробной информации смотрите MSDN: CHARFORMAT2 Structure.
KerningчислоЗначение размера шрифта, выше которого находятся выносные элементы символа (Height). (Это значение не влияет на отображаемый текст в объекте. Включено для совместимости с интерфейсами Microsoft WindowsText Object Model (TOM).)
Styleчисло Дескриптор стиля символа. (Это значение не влияет на отображаемый текст в объекте. Включено для совместимости с интерфейсами Microsoft WindowsText 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 использует различные цвета текста для индекса любого отдельного автора.

ApplyToWord

(логический) Применять ли форматирование для любых слов, охваченных выделением (или места вставки в нем), или применять форматирование только для выделенных символов (или, если нет выделения, для новых символов введенных в месте вставки).

ЗНАЧЕНИЕ
VALUE
ОПИСАНИЕ
DESCRIPTION
trueФорматирование применяется для всех слов, охваченных выделением.
falseПрименяется только для форматирования выделенных символов. (По умолчанию)

Возврат

Ничего. Можно использовать действие Application.GetLastError для определения случился ли отказ в работе этого действия и почему.
Смотрите также: Связанные действия

Примеры

Пример 1

-- Create a table for the formatting.
-- Создаем таблицу форматирования.
tbFormat = {Bold = true};

-- Set the selected text to bold.
-- Устанавливаем для выделенного текста "жирный" шрифт.
RichText.SetSelectionFormat("RichText1", tbFormat, false);
В объекте RTF (richtext) "RichText1" для выделенного текста устанавливаем "жирный" шрифт (Bold).
Смотрите также: Связанные действия