summaryrefslogtreecommitdiffstats
path: root/helpcontent2/source/text/sbasic/shared/03010201.xhp
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /helpcontent2/source/text/sbasic/shared/03010201.xhp
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'helpcontent2/source/text/sbasic/shared/03010201.xhp')
-rw-r--r--helpcontent2/source/text/sbasic/shared/03010201.xhp69
1 files changed, 69 insertions, 0 deletions
diff --git a/helpcontent2/source/text/sbasic/shared/03010201.xhp b/helpcontent2/source/text/sbasic/shared/03010201.xhp
new file mode 100644
index 000000000..598129fc4
--- /dev/null
+++ b/helpcontent2/source/text/sbasic/shared/03010201.xhp
@@ -0,0 +1,69 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<helpdocument version="1.0">
+<!--
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+-->
+
+<meta>
+ <topic id="textsbasicshared03010201xml" indexer="include" status="PUBLISH">
+ <title id="tit" xml-lang="en-US">InputBox Function</title>
+ <filename>/text/sbasic/shared/03010201.xhp</filename>
+ </topic>
+</meta>
+
+<body>
+
+
+<section id="inputbox">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3148932">
+ <bookmark_value>InputBox function</bookmark_value>
+</bookmark>
+
+<h1 id="hd_id3148932" xml-lang="en-US"><link href="text/sbasic/shared/03010201.xhp" name="InputBox Function">InputBox Function</link></h1>
+<paragraph id="par_id3151262" role="paragraph" xml-lang="en-US">Displays a prompt in a dialog at which the user can input text. The input is assigned to a variable.</paragraph>
+</section>
+<paragraph id="par_id3151100" role="paragraph" xml-lang="en-US">The <emph>InputBox</emph> statement is a convenient method of entering text through a dialog. Confirm the input by clicking OK or pressing Return. The input is returned as the function return value. If you close the dialog with Cancel, <emph>InputBox</emph> returns a zero-length string ("").</paragraph>
+
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
+<bascode>
+<paragraph id="par_id3159201" role="bascode" localize="false">InputBox (Prompt As String[, Title As String[, Default As String[, xpostwips As Integer, ypostwips As Integer]]]) As String</paragraph>
+</bascode>
+
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+<section id="parameters">
+<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US"> <emph>prompt</emph>: String expression displayed as the message in the dialog box.</paragraph>
+<paragraph id="par_id3145315" role="paragraph" xml-lang="en-US"> <emph>title</emph>: String expression displayed in the title bar of the dialog box.</paragraph>
+<paragraph id="par_id3154307" role="paragraph" xml-lang="en-US"> <emph>default</emph>: String expression displayed in the text box as default if no other input is given.</paragraph>
+<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US"> <emph>xpostwips</emph>: Integer expression that specifies the horizontal position of the dialog. The position is an absolute coordinate and does not refer to the window of %PRODUCTNAME.</paragraph>
+<paragraph id="par_id3156024" role="paragraph" xml-lang="en-US"> <emph>ypostwips</emph>: Integer expression that specifies the vertical position of the dialog. The position is an absolute coordinate and does not refer to the window of %PRODUCTNAME.</paragraph>
+<paragraph id="par_id3153897" role="paragraph" xml-lang="en-US">If <literal>xpostwips</literal> and <literal>ypostwips</literal> are omitted, the dialog is centered on the screen. The position is specified in <link href="text/sbasic/shared/00000002.xhp#twips" name="twips">twips</link>.</paragraph>
+</section>
+
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">String</paragraph>
+
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
+<bascode>
+<paragraph id="par_idm1341285584" role="bascode" localize="false" xml-lang="en-US">Sub ExampleInputBox</paragraph>
+<paragraph id="par_idm1341284352" role="bascode" localize="false" xml-lang="en-US">Dim sText As String</paragraph>
+<paragraph id="par_id3154367" role="bascode" xml-lang="en-US"> sText = InputBox ("Please enter a phrase:","Dear User")</paragraph>
+<paragraph id="par_id3151042" role="bascode" xml-lang="en-US"> MsgBox ( sText , 64, "Confirmation of phrase")</paragraph>
+<paragraph id="par_idm1341279568" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
+</bascode>
+
+</body>
+</helpdocument> \ No newline at end of file