xref: /AOO42X/main/helpcontent2/source/text/sbasic/shared/03010102.xhp (revision fc046bda145953e673f3df127a241e83fcfed4f5)
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="textsbasicshared03010102xml" indexer="include" status="PUBLISH">
27cdf0e10cSrcweir<title id="tit" xml-lang="en-US">MsgBox Function [Runtime]</title>
28cdf0e10cSrcweir<filename>/text/sbasic/shared/03010102.xhp</filename>
29cdf0e10cSrcweir</topic>
30cdf0e10cSrcweir</meta>
31cdf0e10cSrcweir<body>
32cdf0e10cSrcweir<section id="msgbox">
335b00253eSmseidel<bookmark xml-lang="en-US" branch="index" id="bm_id3153379">
345b00253eSmseidel<bookmark_value>MsgBox function</bookmark_value>
35cdf0e10cSrcweir</bookmark>
36*fc046bdaSmseidel<paragraph role="heading" id="hd_id3153379" xml-lang="en-US" level="1" l10n="U"><link href="text/sbasic/shared/03010102.xhp" name="MsgBox Function [Runtime]">MsgBox Function [Runtime]</link></paragraph>
37*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3145171" xml-lang="en-US" l10n="U">Displays a dialog box containing a message and returns a value.</paragraph>
38cdf0e10cSrcweir</section>
39*fc046bdaSmseidel<paragraph role="heading" id="hd_id3156281" xml-lang="en-US" level="2" l10n="U">Syntax:</paragraph>
40*fc046bdaSmseidel<paragraph role="code" id="par_id3154685" xml-lang="en-US" l10n="U">MsgBox (Text As String [,Type As Integer [,Dialogtitle As String]])</paragraph>
41*fc046bdaSmseidel<paragraph role="heading" id="hd_id3153771" xml-lang="en-US" level="2" l10n="U">Return value:</paragraph>
42*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3146985" xml-lang="en-US" l10n="U">Integer</paragraph>
43*fc046bdaSmseidel<paragraph role="heading" id="hd_id3153363" xml-lang="en-US" level="2" l10n="U">Parameter:</paragraph>
44*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3153727" 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>
45*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3147317" xml-lang="en-US" l10n="U"><emph>DialogTitle:</emph> String expression displayed in the title bar of the dialog. If omitted, the name of the respective application is displayed.</paragraph>
46*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3153954" xml-lang="en-US" l10n="U"><emph>Type:</emph> Any integer expression that specifies the dialog type and defines the number and type of buttons or icons displayed. <emph>Type</emph> represents a combination of bit patterns (dialog elements defined by adding the respective values):</paragraph>
47*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3154319" xml-lang="en-US" l10n="U"><emph>Values:</emph></paragraph>
48*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3147397" xml-lang="en-US" l10n="U">0 : Display OK button only.</paragraph>
49*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3145646" xml-lang="en-US" l10n="U">1 : Display OK and Cancel buttons.</paragraph>
50*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3149410" xml-lang="en-US" l10n="CHG">2 : Display Abort, Retry, and Ignore buttons.</paragraph>
51*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3151075" xml-lang="en-US" l10n="U">3 : Display Yes, No, and Cancel buttons.</paragraph>
52*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3153878" xml-lang="en-US" l10n="U">4 : Display Yes and No buttons.</paragraph>
53*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3155601" xml-lang="en-US" l10n="U">5 : Display Retry and Cancel buttons.</paragraph>
54*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3150716" xml-lang="en-US" l10n="U">16 : Add the Stop icon to the dialog.</paragraph>
55*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3153837" xml-lang="en-US" l10n="U">32 : Add the Question icon to the dialog.</paragraph>
56*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3150751" xml-lang="en-US" l10n="U">48 : Add the Exclamation Point icon to the dialog.</paragraph>
57*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3146915" xml-lang="en-US" l10n="U">64 : Add the Information icon to the dialog.</paragraph>
58*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3145640" xml-lang="en-US" l10n="U">128 : First button in the dialog as default button.</paragraph>
59*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3153765" xml-lang="en-US" l10n="U">256 : Second button in the dialog as default button.</paragraph>
60*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3153715" xml-lang="en-US" l10n="U">512 : Third button in the dialog as default button.</paragraph>
61*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3159267" xml-lang="en-US" l10n="U"><emph>Return value:</emph></paragraph>
62*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3145230" xml-lang="en-US" l10n="U">1 : OK</paragraph>
63*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3149567" xml-lang="en-US" l10n="U">2 : Cancel</paragraph>
64cdf0e10cSrcweir<paragraph role="paragraph" id="par_id4056825" xml-lang="en-US" l10n="NEW">3 : Abort</paragraph>
65*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3155335" xml-lang="en-US" l10n="U">4 : Retry</paragraph>
66*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3146918" xml-lang="en-US" l10n="U">5 : Ignore</paragraph>
67*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3155961" xml-lang="en-US" l10n="U">6 : Yes</paragraph>
68*fc046bdaSmseidel<paragraph role="paragraph" id="par_id3148488" xml-lang="en-US" l10n="U">7 : No</paragraph>
69cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#errorcode"/>
70cdf0e10cSrcweir<embed href="text/sbasic/shared/00000003.xhp#err5"/>
71*fc046bdaSmseidel<paragraph role="heading" id="hd_id3150090" xml-lang="en-US" level="2" l10n="U">Example:</paragraph>
72*fc046bdaSmseidel<paragraph role="code" id="par_id3154120" xml-lang="en-US" l10n="U">Sub ExampleMsgBox</paragraph>
73*fc046bdaSmseidel<paragraph role="code" id="par_id3145131" xml-lang="en-US" l10n="U">Dim sVar as Integer</paragraph>
74*fc046bdaSmseidel<paragraph role="code" id="par_id3151278" xml-lang="en-US" l10n="U">sVar = MsgBox("Las Vegas")</paragraph>
75*fc046bdaSmseidel<paragraph role="code" id="par_id3149034" xml-lang="en-US" l10n="U">sVar = MsgBox("Las Vegas",1)</paragraph>
76*fc046bdaSmseidel<paragraph role="code" id="par_id3166424" xml-lang="en-US" l10n="U">sVar = MsgBox( "Las Vegas",256 + 16 + 2,"Dialog title")</paragraph>
77*fc046bdaSmseidel<paragraph role="code" id="par_id3152581" xml-lang="en-US" l10n="U">end sub</paragraph>
78cdf0e10cSrcweir</body>
79cdf0e10cSrcweir</helpdocument>
80