blob: a694dfbea9ca4a4910cab4d5bffe96be95cbbe5d [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8"?>
<!--***********************************************************
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
***********************************************************-->
<helpdocument version="1.0">
<meta>
<topic id="textsbasicshared03010101xml" indexer="include" status="PUBLISH">
<title id="tit" xml-lang="en-US">MsgBox Statement [Runtime]</title>
<filename>/text/sbasic/shared/03010101.xhp</filename>
</topic>
<history>
<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
<lastedited date="2005-09-13T11:32:41">converted from old format - fpe
dedr: fixed #i30425#</lastedited>
</history>
</meta>
<body>
<section id="msgbox">
<bookmark xml-lang="en-US" branch="index" id="bm_id1807916"><bookmark_value>MsgBox statement</bookmark_value>
</bookmark>
<paragraph role="heading" id="hd_id3154927" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03010101.xhp">MsgBox Statement [Runtime]</link></paragraph>
<paragraph role="paragraph" id="par_id3148947" xml-lang="en-US" l10n="U" oldref="2">Displays a dialog box containing a message.</paragraph>
</section>
<paragraph role="heading" id="hd_id3153897" xml-lang="en-US" level="2" l10n="U" oldref="3">Syntax:</paragraph>
<paragraph role="code" id="par_id3148664" xml-lang="en-US" l10n="U" oldref="4">MsgBox Text As String [,Type As Integer [,Dialogtitle As String]] (As Statement) or MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]]) (As Function)</paragraph>
<paragraph role="heading" id="hd_id3153361" xml-lang="en-US" level="2" l10n="U" oldref="5">Parameter:</paragraph>
<paragraph role="paragraph" id="par_id3148798" xml-lang="en-US" l10n="U" oldref="6">
<emph>Text</emph>: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph>
<paragraph role="paragraph" id="par_id3150769" xml-lang="en-US" l10n="U" oldref="7">
<emph>DialogTitle</emph>: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application.</paragraph>
<paragraph role="paragraph" id="par_id3147228" xml-lang="en-US" l10n="U" oldref="8">
<emph>Type</emph>: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. <emph>Type</emph> represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values:</paragraph>
<paragraph role="paragraph" id="par_id3161832" xml-lang="en-US" l10n="U" oldref="9">0 : Display OK button only.</paragraph>
<paragraph role="paragraph" id="par_id3153726" xml-lang="en-US" l10n="U" oldref="10">1 : Display OK and Cancel buttons.</paragraph>
<paragraph role="paragraph" id="par_id3149665" xml-lang="en-US" l10n="CHG" oldref="11">2 : Display Abort, Retry, and Ignore buttons.</paragraph>
<paragraph role="paragraph" id="par_id3147318" xml-lang="en-US" l10n="U" oldref="12">3 : Display Yes, No and Cancel buttons.</paragraph>
<paragraph role="paragraph" id="par_id3155412" xml-lang="en-US" l10n="U" oldref="13">4 : Display Yes and No buttons.</paragraph>
<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U" oldref="14">5 : Display Retry and Cancel buttons.</paragraph>
<paragraph role="paragraph" id="par_id3159155" xml-lang="en-US" l10n="U" oldref="15">16 : Add the Stop icon to the dialog.</paragraph>
<paragraph role="paragraph" id="par_id3145366" xml-lang="en-US" l10n="U" oldref="16">32 : Add the Question icon to the dialog.</paragraph>
<paragraph role="paragraph" id="par_id3147350" xml-lang="en-US" l10n="U" oldref="17">48 : Add the Exclamation icon to the dialog.</paragraph>
<paragraph role="paragraph" id="par_id3149960" xml-lang="en-US" l10n="U" oldref="18">64 : Add the Information icon to the dialog.</paragraph>
<paragraph role="paragraph" id="par_id3154944" xml-lang="en-US" l10n="U" oldref="19">128 : First button in the dialog as default button.</paragraph>
<paragraph role="paragraph" id="par_id3155417" xml-lang="en-US" l10n="U" oldref="20">256 : Second button in the dialog as default button.</paragraph>
<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U" oldref="21">512 : Third button in the dialog as default button.</paragraph>
<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
<embed href="text/sbasic/shared/00000003.xhp#err5"/>
<paragraph role="heading" id="hd_id3150715" xml-lang="en-US" level="2" l10n="U" oldref="22">Example:</paragraph>
<paragraph role="code" id="par_id3154511" xml-lang="en-US" l10n="U" oldref="23">Sub ExampleMsgBox</paragraph>
<paragraph role="code" id="par_id3150327" xml-lang="en-US" l10n="U" oldref="24">Const sText1 = "An unexpected error occurred."</paragraph>
<paragraph role="code" id="par_id3146912" xml-lang="en-US" l10n="U" oldref="25">Const sText2 = "The program execution will continue, however."</paragraph>
<paragraph role="code" id="par_id3154757" xml-lang="en-US" l10n="U" oldref="26">Const sText3 = "Error"</paragraph>
<paragraph role="code" id="par_id3155445" xml-lang="en-US" l10n="U" oldref="27">MsgBox(sText1 + Chr(13) + sText2,16,sText3)</paragraph>
<paragraph role="code" id="par_id3155768" xml-lang="en-US" l10n="U" oldref="28">End sub</paragraph>
</body>
</helpdocument>