xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03010101.xhp (revision e74af31e6e9b92c45d9a4ff18c02d1e3d701b701)
1cdf0e10cSrcweir<?xml version="1.0" encoding="UTF-8"?>
2cdf0e10cSrcweir
3226a8927SAndrew Rist<!--***********************************************************
4cdf0e10cSrcweir *
5226a8927SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
6226a8927SAndrew Rist * or more contributor license agreements.  See the NOTICE file
7226a8927SAndrew Rist * distributed with this work for additional information
8226a8927SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
9226a8927SAndrew Rist * to you under the Apache License, Version 2.0 (the
10226a8927SAndrew Rist * "License"); you may not use this file except in compliance
11226a8927SAndrew Rist * with the License.  You may obtain a copy of the License at
12cdf0e10cSrcweir *
13226a8927SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
14cdf0e10cSrcweir *
15226a8927SAndrew Rist * Unless required by applicable law or agreed to in writing,
16226a8927SAndrew Rist * software distributed under the License is distributed on an
17226a8927SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
18226a8927SAndrew Rist * KIND, either express or implied.  See the License for the
19226a8927SAndrew Rist * specific language governing permissions and limitations
20226a8927SAndrew Rist * under the License.
21cdf0e10cSrcweir *
22226a8927SAndrew Rist ***********************************************************-->
23226a8927SAndrew Rist
24cdf0e10cSrcweir<helpdocument version="1.0">
25cdf0e10cSrcweir<meta>
26cdf0e10cSrcweir<topic id="textsbasicshared03010101xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">MsgBox Statement [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03010101.xhp</filename>
29cdf0e10cSrcweir</topic>
301c8e30e9Smseidel<comment>fixed #i30425#</comment>
31cdf0e10cSrcweir</meta>
32cdf0e10cSrcweir<body>
33cdf0e10cSrcweir<section id="msgbox">
345b00253eSmseidel<bookmark xml-lang="en-US" branch="index" id="bm_id1807916">
355b00253eSmseidel<bookmark_value>MsgBox statement</bookmark_value>
36cdf0e10cSrcweir</bookmark>
37*e74af31eSmseidel<paragraph role="heading" id="hd_id3154927" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03010101.xhp">MsgBox Statement [Runtime]</link></paragraph>
38*e74af31eSmseidel<paragraph role="paragraph" id="par_id3148947" xml-lang="en-US" l10n="U">Displays a dialog box containing a message.</paragraph>
39cdf0e10cSrcweir</section>
40*e74af31eSmseidel<paragraph role="heading" id="hd_id3153897" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
41*e74af31eSmseidel<paragraph role="code" id="par_id3148664" xml-lang="en-US" l10n="U">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>
42*e74af31eSmseidel<paragraph role="heading" id="hd_id3153361" xml-lang="en-US" level="2" l10n="U">Parameter:</paragraph>
43*e74af31eSmseidel<paragraph role="paragraph" id="par_id3148798" xml-lang="en-US" l10n="U"><emph>Text:</emph> String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13).</paragraph>
44*e74af31eSmseidel<paragraph role="paragraph" id="par_id3150769" xml-lang="en-US" l10n="U"><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>
45*e74af31eSmseidel<paragraph role="paragraph" id="par_id3147228" xml-lang="en-US" l10n="U"><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>
46*e74af31eSmseidel<paragraph role="paragraph" id="par_id3161832" xml-lang="en-US" l10n="U">0 : Display OK button only.</paragraph>
47*e74af31eSmseidel<paragraph role="paragraph" id="par_id3153726" xml-lang="en-US" l10n="U">1 : Display OK and Cancel buttons.</paragraph>
48*e74af31eSmseidel<paragraph role="paragraph" id="par_id3149665" xml-lang="en-US" l10n="CHG">2 : Display Abort, Retry, and Ignore buttons.</paragraph>
49*e74af31eSmseidel<paragraph role="paragraph" id="par_id3147318" xml-lang="en-US" l10n="U">3 : Display Yes, No and Cancel buttons.</paragraph>
50*e74af31eSmseidel<paragraph role="paragraph" id="par_id3155412" xml-lang="en-US" l10n="U">4 : Display Yes and No buttons.</paragraph>
51*e74af31eSmseidel<paragraph role="paragraph" id="par_id3146119" xml-lang="en-US" l10n="U">5 : Display Retry and Cancel buttons.</paragraph>
52*e74af31eSmseidel<paragraph role="paragraph" id="par_id3159155" xml-lang="en-US" l10n="U">16 : Add the Stop icon to the dialog.</paragraph>
53*e74af31eSmseidel<paragraph role="paragraph" id="par_id3145366" xml-lang="en-US" l10n="U">32 : Add the Question icon to the dialog.</paragraph>
54*e74af31eSmseidel<paragraph role="paragraph" id="par_id3147350" xml-lang="en-US" l10n="U">48 : Add the Exclamation icon to the dialog.</paragraph>
55*e74af31eSmseidel<paragraph role="paragraph" id="par_id3149960" xml-lang="en-US" l10n="U">64 : Add the Information icon to the dialog.</paragraph>
56*e74af31eSmseidel<paragraph role="paragraph" id="par_id3154944" xml-lang="en-US" l10n="U">128 : First button in the dialog as default button.</paragraph>
57*e74af31eSmseidel<paragraph role="paragraph" id="par_id3155417" xml-lang="en-US" l10n="U">256 : Second button in the dialog as default button.</paragraph>
58*e74af31eSmseidel<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U">512 : Third button in the dialog as default button.</paragraph>
59cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
60cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
61*e74af31eSmseidel<paragraph role="heading" id="hd_id3150715" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
62*e74af31eSmseidel<paragraph role="code" id="par_id3154511" xml-lang="en-US" l10n="U">Sub ExampleMsgBox</paragraph>
63*e74af31eSmseidel<paragraph role="code" id="par_id3150327" xml-lang="en-US" l10n="U">Const sText1 = "An unexpected error occurred."</paragraph>
64*e74af31eSmseidel<paragraph role="code" id="par_id3146912" xml-lang="en-US" l10n="U">Const sText2 = "The program execution will continue, however."</paragraph>
65*e74af31eSmseidel<paragraph role="code" id="par_id3154757" xml-lang="en-US" l10n="U">Const sText3 = "Error"</paragraph>
66*e74af31eSmseidel<paragraph role="code" id="par_id3155445" xml-lang="en-US" l10n="U">MsgBox(sText1 + Chr(13) + sText2,16,sText3)</paragraph>
67*e74af31eSmseidel<paragraph role="code" id="par_id3155768" xml-lang="en-US" l10n="U">End sub</paragraph>
68cdf0e10cSrcweir</body>
69cdf0e10cSrcweir</helpdocument>
70