Платформа WT
Синтаксис
База знаний

MessageBoxCommand

Команда; открывает диалоговое окно сообщения.

Шаблон MessageBoxCommand

<Command Name="" Type="MessageBoxCommand" Assembly="Commands">
  <!--Тэги, общие для всех команд-->
  <Condition Name="" />
  <Lock Value="" />
  <!--Тэги, специфичные для MessageBoxCommand-->
  <Caption></Caption>
  <Text></Text>
  <Custom Value="" />
  <BackColor></BackColor>
  <ForeColor></ForeColor>
  <FontStyle></FontStyle>
  <MessageBoxStyle></MessageBoxStyle>
  <Link></Link>
  <LinkText></LinkText>
  <Icon Type="" />
  <Buttons Type="" />
</Command>

Описание MessageBoxCommand

<Command Name="MessageBoxCommandName" Type="MessageBoxCommand" Assembly="Commands">
  <!--Тэги, общие для всех команд-->
  <!--Тэги, специфичные для MessageBoxCommand-->
</Command>

Результат выполнения

Результатом выполнения команды будет словарь, содержащий пары ключ-значение:

Value

Значение нажатой кнопки - одно из списка

OK

True, если была ли нажата кнопка OK

Cancel

True, если была ли нажата кнопка Cancel ("Отмена")

Abort

True, если была ли нажата кнопка Abort ("Прервать")

Retry

True, если была ли нажата кнопка Retry ("Повторить")

Ignore

True, если была ли нажата кнопка Ignore ("Пропустить")

Yes

True, если была ли нажата кнопка Yes ("Да")

No

True, если была ли нажата кнопка No ("Нет")

Так же в этом словаре будут ключи, соответствующие произвольным кнопкам, где в качестве ключа будет значение атрибута Result.

Получить значение из словаря можно через атрибут Parameter, указав имя ключа:

<Command Name="MessageBoxCommandName" Parameter="Yes"/>

Для получения значения Value можно использовать сокращенную форму:

<Command Name="MessageBoxCommandName"/>

Значения параметра Value

OK

Значение отправляется с кнопкой с надписью "OK"

Cancel

Значение отправляется кнопкой с надписью "Отмена" ("Cancel")

Abort

Значение отправляется кнопкой с надписью "Прервать" ("Abort")

Retry

Значение отправляется кнопкой с надписью "Повторить" ("Retry")

Ignore

Значение отправляется кнопкой "Пропустить" ("Ignore")

Yes

Значение отправляется с кнопкой с надписью "Да" ("Yes")

No

Значение отправляется с кнопкой с надписью "Нет" ("No")

Для произвольных кнопок параметр Value будет иметь значение, указанное в атрибуте Result.

Тэги, специфичные для MessageBoxCommand

Caption

Заголовок диалогового окна.

Необязательный тэг. Любое значение будет переведено в текстовое.

<Caption>Caption</Caption>

Text

Текст внутри диалогового окна.

Необязательный тэг. Любое значение будет переведено в текстовое.

<Text>Text</Text>

Custom

Признак, отключающий возможность настраивать стиль диалогового окна. Если признак имеет значение False, то для внешнего вида диалогового окна используются настройки операционной системы.

Необязательный тэг. Значение тэга не ожидается.

Необязательный атрибут Value ожидает логическое значение. По умолчанию используется значение True.

<Custom Value="False" />

BackColor

Цвет фона заголовка и тела диалогового окна. Игнорируется, если тэг <Custom> имеет значение False.

Необязательный тэг. Ожидается имя одного из цветов, описанных в тэге <Appearance> формы или в файле стилей. Так же принимается описание цвета в формате HTML (#rrggbb).

По умолчанию используется белый цвет.

<BackColor>BackColor</BackColor>

ForeColor

Цвет текста в теле и на кнопках диалогового окна. Игнорируется, если тэг <Custom> имеет значение False.

Необязательный тэг. Ожидается имя одного из цветов, описанных в тэге <Appearance> формы или в файле стилей. Так же принимается описание цвета в формате HTML (#rrggbb).

По умолчанию используется черный цвет.

<ForeColor>ForeColor</ForeColor>

FontStyle

Стиль шрифта в теле и на кастомных кнопках диалогового окна. Игнорируется, если тэг <Custom> имеет значение False.

Необязательный тэг. Ожидается имя одного из стилей шрифтов, описанных в тэге <Appearance> формы или в файле стилей.

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

<FontStyle>FontStyle</FontStyle>

MessageBoxStyle

Стиль для MessageBox. Игнорируется, если тэг <Custom> имеет значение False.

Необязательный тэг. Ожидается имя одного из стилей, описанных в тэге <Appearance> формы или в файле стилей.

<MessageBoxStyle>MessageBoxStyleName</MessageBoxStyle>

Link

Определяет URL документа, на которую ведет ссылка. Результат перехода по ссылке зависит от конечного файла. Игнорируется, если тэг <Custom> имеет значение False.

Необязательный тэг. Любое значение будет переведено в текстовое.

<Link>URL</Link>

LinkText

Задает видимый текст ссылки. Игнорируется, если тэг <Custom> имеет значение False.

Необязательный тэг. Любое значение будет переведено в текстовое.

<LinkText>LinkText</LinkText>

Icon

Иконка диалогового окна.

Необязательный тэг. Значение тэга не ожидается.

<Icon Type="None" />

Для обязательного атрибута Type ожидается одно из допустимых значений:

None

Окно сообщения не содержит символов

Hand

Окно сообщения содержит символ, состоящий из белого значка Х, заключенного в красный кружок

Question

Окно сообщения содержит символ, состоящий из вопросительного знака, заключенного в кружок

Exclamation

Окно сообщения содержит символ, состоящий из восклицательного знака в желтом треугольнике

Asterisk

Окно сообщения содержит символ, состоящий из буквы i в нижнем регистре, помещенной в кружок

Stop

Окно сообщения содержит символ, состоящий из белого значка Х, заключенного в красный кружок

Error

Окно сообщения содержит символ, состоящий из белого значка Х, заключенного в красный кружок

Warning

Окно сообщения содержит символ, состоящий из восклицательного знака в желтом треугольнике

Information

Окно сообщения содержит символ, состоящий из буквы i в нижнем регистре, помещенной в кружок

По умолчанию для атрибута Type используется значение Information.

Buttons

Набор кнопок диалогового окна. Можно выбрать предустановленный набор кнопок, используя атрибут Type, или описать произвольный набор кнопок, используя вложенный тэг <Button>.

Необязательный тэг.

Вариант предустановленного списка кнопок:

<Buttons Type="Ok" />

Для обязательного атрибута Type ожидается одно из допустимых значений:

OK

Окно сообщения содержит кнопку "ОК"

OKCancel

Окно сообщения содержит кнопки "ОК" и "Отмена"

AbortRetryIgnore

Окно сообщения содержит кнопки "Прервать", "Повторить" и "Пропустить"

YesNoCancel

Окно сообщения содержит кнопки "Да", "Нет" и "Отмена"

YesNo

Окно сообщения содержит кнопки "Да" и "Нет"

RetryCancel

Окно сообщения содержит кнопки "Повторить" и "Отмена"

По умолчанию для атрибута Type используется значение OK.

Вариант произвольного набора кнопок:

<Buttons>
  <Button Result="">
    <Width></Width>
    <Height></Height>
    <BackColor></BackColor>
    <Align></Align>
    <Index></Index>
    <FlatStyle></FlatStyle>
    <FlatBorderSize></FlatBorderSize>
    <FlatBorderColor></FlatBorderColor>
    <FlatMouseDownBackColor></FlatMouseDownBackColor>
    <FlatMouseOverBackColor></FlatMouseOverBackColor>
    <ForeColor></ForeColor>
    <FontStyle></FontStyle>
    <Image></Image>
    <ImageAlign></ImageAlign>
    <Text></Text>
    <TextAlign></TextAlign>
  </Button>
</Buttons>

Описание Button

<Button Result="">
  <Width></Width>
  <Height></Height>
  <BackColor></BackColor>
  <Align></Align>
  <Index></Index>
  <FlatStyle></FlatStyle>
  <FlatBorderSize></FlatBorderSize>
  <FlatBorderColor></FlatBorderColor>
  <FlatMouseDownBackColor></FlatMouseDownBackColor>
  <FlatMouseOverBackColor></FlatMouseOverBackColor>
  <ForeColor></ForeColor>
  <FontStyle></FontStyle>
  <Image></Image>
  <ImageAlign></ImageAlign>
  <Text></Text>
  <TextAlign></TextAlign>
</Button>

Атрибуты Button

Result

Значение, которое будет записываться в результат выполнения команды.

Обязательный атрибут. Любое значение будет переведено в текст.

Height

Высота кнопки.

Необязательный тэг. Ожидается целочисленное значение.

По умолчанию используется значение 23.

<Height>25</Height>

Width

Ширина кнопки.

Необязательный тэг. Ожидается целочисленное значение.

По умолчанию используется значение 90.

<Width>100</Width>

BackColor

Цвет фона кнопки.

Необязательный тэг. Ожидается имя одного из цветов, описанных в тэге <Appearance> формы или в файле стилей. Так же принимается описание цвета в формате HTML (#rrggbb).

По умолчанию используется белый цвет.

<BackColor>BackColor</BackColor>

FlatStyle

Задает тип границ кнопки.

Необязательный тэг. Ожидается название одного из стилей отображения кнопки:

Flat

Плоская

Popup

Плоская, пока не наведена мышь

Standard

Обычная

System

Определяется операционной системой

По умолчанию используется значение Standard.

<FlatStyle>Standard</FlatStyle>

FlatBorderSize

Задает размер границы плоской кнопки (кнопки, свойство <FlatStyle> которой равно Flat).

Необязательный тэг. Ожидается целочисленное значение.

По умолчанию используется значение 1.

<FlatBorderSize>1</FlatBorderSize>

FlatBorderColor

Задает цвет границы плоской кнопки (кнопки, свойство <FlatStyle> которой равно Flat).

Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb).

По умолчанию используется стандартное значение .NET.

<FlatBorderColor>FlatBorderColor</FlatBorderColor>

FlatMouseDownBackColor

Задает цвет нажатой плоской кнопки (кнопки, свойство <FlatStyle> которой равно Flat).

Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb).

Если тэг <FlatMouseDownBackColor> отсутствует, то цвет рассчитывается автоматически.

<FlatMouseDownBackColor>FlatMouseDownBackColor</FlatMouseDownBackColor>

FlatMouseOverBackColor

Задает цвет плоской кнопки при наведении курсора мыши (кнопки, свойство <FlatStyle> которой равно Flat).

Необязательный тэг. Ожидается имя одного из цветов, описанных в форме или описание цвета в формате HTML (#rrggbb).

Если тэг <FlatMouseOverBackColor> отсутствует, то цвет рассчитывается автоматически.

<FlatMouseOverBackColor>FlatMouseOverBackColor</FlatMouseOverBackColor>

Image

Путь до файла с графическим содержанием, которое будет расположено на кнопке.

Необязательный тэг. Любое значение будет переведено в текстовое.

<Image>Image</Image>

ImageAlign

Определяет тип положения картинки.

Необязательный тэг. Ожидается название одного из типов положения картинки:

TopLeft

Слева сверху

TopCenter

По центру сверху

TopRight

Справа сверху

MiddleLeft

Слева посередине

MiddleCenter

По центру посередине

MiddleRight

Справа посередине

BottomLeft

Слева снизу

BottomCenter

По центру снизу

BottomRight

Справа снизу

По умолчанию используется значение MiddleCenter.

<ImageAlign>MiddleCenter</ImageAlign>

ForeColor

Цвет текста на кнопке.

Необязательный тэг. Ожидается имя одного из цветов, описанных в тэге <Appearance> формы или в файле стилей. Так же принимается описание цвета в формате HTML (#rrggbb).

По умолчанию используется значение ForeColor, которое указано для диалогового окна.

<ForeColor>ForeColor</ForeColor>

FontStyle

Стиль шрифта текста на кнопке.

Необязательный тэг. Ожидается имя одного из стилей шрифтов, описанных в тэге <Appearance> формы или в файле стилей.

По умолчанию используется значение FontStyle, которое указано для диалогового окна.

<FontStyle>FontStyle</FontStyle>

Text

Текст на кнопке.

Необязательный тэг. Любое значение будет переведено в текстовое.

<Text>Текст</Text>

TextAlign

Определяет тип положения текста.

Необязательный тэг. Ожидается название одного из типов положения текста:

TopLeft

Слева сверху

TopCenter

По центру сверху

TopRight

Справа сверху

MiddleLeft

Слева посередине

MiddleCenter

По центру посередине

MiddleRight

Справа посередине

BottomLeft

Слева снизу

BottomCenter

По центру снизу

BottomRight

Справа снизу

По умолчанию используется значение MiddleLeft.

<TextAlign>MiddleLeft</TextAlign>

Align

Определяет тип положения кнопки.

Необязательный тэг. Ожидается название одного из типов положения кнопки:

Left

Слева снизу

Center

По центру снизу

Right

Справа снизу

По умолчанию используется значение Right.

<Align>Left</Align>

Index

Задает порядок отображения кнопки в диалоговом окне. Если несколько кнопок имеет одинаковое значение тэга, или тэг отсутствует, то кнопки отображаются в порядке описания в xml-коде.

Необязательный тэг. Ожидается целочисленное значение.

По умолчанию используется значение 0.

<Index>3</Index>

Last updated