summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/03010201.xhp
diff options
context:
space:
mode:
Diffstat (limited to 'source/text/sbasic/shared/03010201.xhp')
-rw-r--r--source/text/sbasic/shared/03010201.xhp73
1 files changed, 73 insertions, 0 deletions
diff --git a/source/text/sbasic/shared/03010201.xhp b/source/text/sbasic/shared/03010201.xhp
new file mode 100644
index 0000000000..4444a852d6
--- /dev/null
+++ b/source/text/sbasic/shared/03010201.xhp
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+
+<!--***********************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2000, 2010 Oracle and/or its affiliates.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org. If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************-->
+
+<helpdocument version="1.0">
+<meta>
+<topic id="textsbasicshared03010201xml" indexer="include" status="PUBLISH">
+<title id="tit" xml-lang="en-US">InputBox Function [Runtime]</title>
+<filename>/text/sbasic/shared/03010201.xhp</filename>
+</topic>
+<history>
+<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created>
+<lastedited date="2004-09-01T15:11:39">converted from old format - fpe</lastedited>
+</history>
+</meta>
+<body>
+<section id="inputbox">
+<bookmark xml-lang="en-US" branch="index" id="bm_id3148932"><bookmark_value>InputBox function</bookmark_value>
+</bookmark>
+<paragraph role="heading" id="hd_id3148932" xml-lang="en-US" level="1" l10n="U" oldref="1"><link href="text/sbasic/shared/03010201.xhp" name="InputBox Function [Runtime]">InputBox Function [Runtime]</link></paragraph>
+<paragraph role="paragraph" id="par_id3151262" xml-lang="en-US" l10n="U" oldref="2">Displays a prompt in a dialog at which the user can input text. The input is assigned to a variable.</paragraph>
+</section>
+<paragraph role="paragraph" id="par_id3151100" xml-lang="en-US" l10n="U" oldref="3">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>
+<paragraph role="heading" id="hd_id3152347" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph>
+<paragraph role="code" id="par_id3159201" xml-lang="en-US" l10n="U" oldref="5">InputBox (Msg As String[, Title As String[, Default As String[, x_pos As Integer, y_pos As Integer]]]]) </paragraph>
+<paragraph role="heading" id="hd_id3150713" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph>
+<paragraph role="paragraph" id="par_id3145090" xml-lang="en-US" l10n="U" oldref="7">String</paragraph>
+<paragraph role="heading" id="hd_id3149346" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameter:</paragraph>
+<paragraph role="paragraph" id="par_id3153311" xml-lang="en-US" l10n="U" oldref="9">
+<emph>Msg</emph>: String expression displayed as the message in the dialog box.</paragraph>
+<paragraph role="paragraph" id="par_id3145315" xml-lang="en-US" l10n="U" oldref="10">
+<emph>Title</emph>: String expression displayed in the title bar of the dialog box.</paragraph>
+<paragraph role="paragraph" id="par_id3154307" xml-lang="en-US" l10n="U" oldref="11">
+<emph>Default</emph>: String expression displayed in the text box as default if no other input is given.</paragraph>
+<paragraph role="paragraph" id="par_id3147573" xml-lang="en-US" l10n="U" oldref="12">
+<emph>x_pos</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 the office application.</paragraph>
+<paragraph role="paragraph" id="par_id3156024" xml-lang="en-US" l10n="U" oldref="13">
+<emph>y_pos</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 the office application.</paragraph>
+<paragraph role="paragraph" id="par_id3153897" xml-lang="en-US" l10n="U" oldref="14">If <emph>x_pos</emph> and <emph>y_pos</emph> 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>
+<paragraph role="heading" id="hd_id3149456" xml-lang="en-US" level="2" l10n="U" oldref="15">Example:</paragraph>
+<paragraph role="code" id="par_id3153379" xml-lang="en-US" l10n="U" oldref="16">Sub ExampleInputBox</paragraph>
+<paragraph role="code" id="par_id3149656" xml-lang="en-US" l10n="U" oldref="17">Dim sText As String</paragraph>
+<paragraph role="code" id="par_id3154367" xml-lang="en-US" l10n="U" oldref="18">sText = InputBox ("Please enter a phrase:","Dear User")</paragraph>
+<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="19">MsgBox ( sText , 64, "Confirmation of phrase")</paragraph>
+<paragraph role="code" id="par_id3150768" xml-lang="en-US" l10n="U" oldref="20">End Sub</paragraph>
+</body>
+</helpdocument>