helpcontent2/source/text/sbasic/shared/03010201.xhp

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