Interaction.MsgBox(Object, MsgBoxStyle, Object) Метод

Определение

Пространство имен:

Microsoft.VisualBasic

Сборка:

Microsoft.VisualBasic.Core.dll

Исходный код:

Interaction.vb

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

public static Microsoft.VisualBasic.MsgBoxResult MsgBox (object Prompt, Microsoft.VisualBasic.MsgBoxStyle Buttons = Microsoft.VisualBasic.MsgBoxStyle.OkOnly, object? Title = default);

static member MsgBox : obj * Microsoft.VisualBasic.MsgBoxStyle * obj -> Microsoft.VisualBasic.MsgBoxResult

Public Function MsgBox (Prompt As Object, Optional Buttons As MsgBoxStyle = Microsoft.VisualBasic.MsgBoxStyle.OkOnly, Optional Title As Object = Nothing) As MsgBoxResult

Параметры

Prompt

Object

Обязательный. Выражение типа String, отображаемое в диалоговом окне в виде сообщения. Максимальная длина параметра Prompt составляет примерно 1024 знака и зависит от ширины используемых знаков. Если Prompt состоит из нескольких строк, можно разделить строки с помощью символа возврата каретки Chr((Chr(13)), символа перевода строки (Chr(10)) или сочетания символов возврата каретки и перевода строки (Chr(13) & 10)) между каждой строкой.

Buttons

MsgBoxStyle

Необязательный элемент. Числовое выражение, являющееся суммой значений, задающих номер и тип отображаемых кнопок, стиль используемого значка, тип кнопки по умолчанию и признак модальности окна сообщения. Если параметр Buttons опущен, по умолчанию используется нулевое значение.

Title

Object

Необязательный элемент. Выражение типа String, отображаемое в строке заголовка диалогового окна. Если параметр Title опущен, в строку заголовка помещается имя приложения.

Возвращаемое значение

MsgBoxResult

Одно из следующих значений:

Константа	Значение
OK	1
Cancel	2
Abort	3
Retry	4
Ignore	5
Yes	6
No	7

Исключения

ArgumentException

Либо Prompt — это не выражение типа String, либо параметр Title имеет недопустимое значение.

InvalidOperationException

Процесс не выполняется в режиме интерактивного взаимодействия с пользователем.

InvalidEnumArgumentException

Один или несколько параметров не являются членами перечислений MsgBoxResult или MsgBoxStyle.

Примеры

В этом примере функция используется MsgBox для отображения сообщения о критической ошибке в диалоговом окне с кнопками Да и Нет. Кнопка Нет указана в качестве ответа по умолчанию. Это делается путем объединения значений MsgBox констант в одно числовое выражение. В этом случае добавление 4 (сочетание кнопки "Да/Нет") и 16 (окно Критическое сообщение ) и 256 (вторая кнопка по умолчанию) дает в общей сложности 276. Значение, возвращаемое функцией, MsgBox зависит от кнопки, выбранной пользователем: да возвращает значение 6; Значение No возвращает значение 7.

' The following example requires that Option Infer be set to On.

' Define the message you want to see inside the message box.
Dim msg = "Do you want to continue?"

' Display a simple message box.
MsgBox(msg)

' Define a title for the message box.
Dim title = "MsgBox Demonstration"

' Add the title to the display.
MsgBox(msg, , title)

' Now define a style for the message box. In this example, the
' message box will have Yes and No buttons, the default will be
' the No button, and a Critical Message icon will be present.
Dim style = MsgBoxStyle.YesNo Or MsgBoxStyle.DefaultButton2 Or
            MsgBoxStyle.Critical

' Display the message box and save the response, Yes or No.
Dim response = MsgBox(msg, style, title)

' Take some action based on the response.
If response = MsgBoxResult.Yes Then
    MsgBox("YES, continue!!", , title)
Else
    MsgBox("NO, stop!!", , title)
End If

Комментарии

Если опустить позиционные аргументы, необходимо сохранить соответствующий разделитель запятых.

Если в диалоговом окне отображается кнопка Отмена , нажатие клавиши ESC имеет тот же эффект, что и нажатие кнопки Отмена.

Если диалоговое окно содержит кнопку Справка , для этого диалогового окна предоставляется контекстная справка. Однако значение не возвращается, пока не будет выбрана одна из других кнопок. В приложениях Windows Forms при нажатии кнопки Справка выполняется HelpRequested событие для формы.

Примечание

Функция MsgBox требуется UIPermission на SafeTopLevelWindows уровне , что может повлиять на ее выполнение в ситуациях с частичным доверием. Для получения дополнительной информации см. UIPermission.

Значения MsgBoxStyle перечисления перечислены в следующей таблице.

Член	Значение	Описание
Член	Значение	Описание
OKOnly	0	Отображает только кнопку ОК.
OKCancel	1	Отображает кнопки ОК и Отмена.
AbortRetryIgnore	2	Отображает кнопки "Прерывание", "Повторить" и "Пропустить".
YesNoCancel	3	Отображает кнопки Да, Нет и Отмена.
YesNo	4	Отображает кнопки Да и Нет.
RetryCancel	5	Отображает кнопки Повторить и Отмена.
Critical	16	Отображает значок критического сообщения.
Question	32	Отображает значок предупреждающего запроса.
Exclamation	48	Отображает значок предупреждающего сообщения.
Information	64	Отображает значок информационного сообщения.
DefaultButton1	0	По умолчанию используется первая кнопка.
DefaultButton2	256	По умолчанию используется вторая кнопка.
DefaultButton3	512	По умолчанию используется третья кнопка.
ApplicationModal	0	Приложение является модальным. Пользователь должен ответить на окно сообщения, прежде чем продолжить работу в текущем приложении.
SystemModal	4096	Система является модальной. Все приложения приостанавливаются до тех пор, пока пользователь не ответит на окно сообщения.
MsgBoxSetForeground	65536	Указывает окно окна сообщения в качестве окна переднего плана.
MsgBoxRight	524288	Текст выравнивается по правому краю.
MsgBoxRtlReading	1048576	Указывает, что текст должен отображаться как чтение справа налево в иврите и арабском языках.

Первая группа значений (0–5) описывает количество и тип кнопок, отображаемых в диалоговом окне. Вторая группа (16, 32, 48, 64) описывает стиль значка. Третья группа (0, 256, 512) определяет, какая кнопка используется по умолчанию. Четвертая группа (0, 4096) определяет модальность окна сообщения, а пятая группа указывает, является ли окно окна сообщения окном переднего плана, а также выравнивание и направление текста. При добавлении чисел для создания окончательного значения аргумента Buttons используйте только одно число из каждой группы.

См. также раздел

• InputBox(String, String, String, Int32, Int32)
• Show(String)