1<?xml version="1.0" encoding="UTF-8"?> 2 3 4<!--*********************************************************************** 5 * 6 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 7 * 8 * Copyright 2000, 2010 Oracle and/or its affiliates. 9 * 10 * OpenOffice.org - a multi-platform office productivity suite 11 * 12 * This file is part of OpenOffice.org. 13 * 14 * OpenOffice.org is free software: you can redistribute it and/or modify 15 * it under the terms of the GNU Lesser General Public License version 3 16 * only, as published by the Free Software Foundation. 17 * 18 * OpenOffice.org is distributed in the hope that it will be useful, 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 * GNU Lesser General Public License version 3 for more details 22 * (a copy is included in the LICENSE file that accompanied this code). 23 * 24 * You should have received a copy of the GNU Lesser General Public License 25 * version 3 along with OpenOffice.org. If not, see 26 * <http://www.openoffice.org/license.html> 27 * for a copy of the LGPLv3 License. 28 * 29 ************************************************************************--> 30 31<helpdocument version="1.0"> 32<meta> 33<topic id="textsbasicshared03010201xml" indexer="include" status="PUBLISH"> 34<title id="tit" xml-lang="en-US">InputBox Function [Runtime]</title> 35<filename>/text/sbasic/shared/03010201.xhp</filename> 36</topic> 37<history> 38<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 39<lastedited date="2004-09-01T15:11:39">converted from old format - fpe</lastedited> 40</history> 41</meta> 42<body> 43<section id="inputbox"> 44<bookmark xml-lang="en-US" branch="index" id="bm_id3148932"><bookmark_value>InputBox function</bookmark_value> 45</bookmark> 46<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> 47<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> 48</section> 49<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> 50<paragraph role="heading" id="hd_id3152347" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph> 51<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> 52<paragraph role="heading" id="hd_id3150713" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph> 53<paragraph role="paragraph" id="par_id3145090" xml-lang="en-US" l10n="U" oldref="7">String</paragraph> 54<paragraph role="heading" id="hd_id3149346" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameter:</paragraph> 55<paragraph role="paragraph" id="par_id3153311" xml-lang="en-US" l10n="U" oldref="9"> 56<emph>Msg</emph>: String expression displayed as the message in the dialog box.</paragraph> 57<paragraph role="paragraph" id="par_id3145315" xml-lang="en-US" l10n="U" oldref="10"> 58<emph>Title</emph>: String expression displayed in the title bar of the dialog box.</paragraph> 59<paragraph role="paragraph" id="par_id3154307" xml-lang="en-US" l10n="U" oldref="11"> 60<emph>Default</emph>: String expression displayed in the text box as default if no other input is given.</paragraph> 61<paragraph role="paragraph" id="par_id3147573" xml-lang="en-US" l10n="U" oldref="12"> 62<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> 63<paragraph role="paragraph" id="par_id3156024" xml-lang="en-US" l10n="U" oldref="13"> 64<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> 65<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> 66<paragraph role="heading" id="hd_id3149456" xml-lang="en-US" level="2" l10n="U" oldref="15">Example:</paragraph> 67<paragraph role="code" id="par_id3153379" xml-lang="en-US" l10n="U" oldref="16">Sub ExampleInputBox</paragraph> 68<paragraph role="code" id="par_id3149656" xml-lang="en-US" l10n="U" oldref="17">Dim sText As String</paragraph> 69<paragraph role="code" id="par_id3154367" xml-lang="en-US" l10n="U" oldref="18">sText = InputBox ("Please enter a phrase:","Dear User")</paragraph> 70<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="19">MsgBox ( sText , 64, "Confirmation of phrase")</paragraph> 71<paragraph role="code" id="par_id3150768" xml-lang="en-US" l10n="U" oldref="20">End Sub</paragraph> 72</body> 73</helpdocument> 74