1*b1cdbd2cSJim Jagielski<?xml version="1.0" encoding="UTF-8"?> 2*b1cdbd2cSJim Jagielski 3*b1cdbd2cSJim Jagielski 4*b1cdbd2cSJim Jagielski<!--*********************************************************** 5*b1cdbd2cSJim Jagielski * 6*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 7*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 8*b1cdbd2cSJim Jagielski * distributed with this work for additional information 9*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 10*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 11*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 12*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 13*b1cdbd2cSJim Jagielski * 14*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 15*b1cdbd2cSJim Jagielski * 16*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 17*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 18*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 19*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 20*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 21*b1cdbd2cSJim Jagielski * under the License. 22*b1cdbd2cSJim Jagielski * 23*b1cdbd2cSJim Jagielski ***********************************************************--> 24*b1cdbd2cSJim Jagielski 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski<helpdocument version="1.0"> 28*b1cdbd2cSJim Jagielski<meta> 29*b1cdbd2cSJim Jagielski<topic id="textsbasicshared03010201xml" indexer="include" status="PUBLISH"> 30*b1cdbd2cSJim Jagielski<title id="tit" xml-lang="en-US">InputBox Function [Runtime]</title> 31*b1cdbd2cSJim Jagielski<filename>/text/sbasic/shared/03010201.xhp</filename> 32*b1cdbd2cSJim Jagielski</topic> 33*b1cdbd2cSJim Jagielski<history> 34*b1cdbd2cSJim Jagielski<created date="2003-10-31T00:00:00">Sun Microsystems, Inc.</created> 35*b1cdbd2cSJim Jagielski<lastedited date="2004-09-01T15:11:39">converted from old format - fpe</lastedited> 36*b1cdbd2cSJim Jagielski</history> 37*b1cdbd2cSJim Jagielski</meta> 38*b1cdbd2cSJim Jagielski<body> 39*b1cdbd2cSJim Jagielski<section id="inputbox"> 40*b1cdbd2cSJim Jagielski<bookmark xml-lang="en-US" branch="index" id="bm_id3148932"><bookmark_value>InputBox function</bookmark_value> 41*b1cdbd2cSJim Jagielski</bookmark> 42*b1cdbd2cSJim Jagielski<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> 43*b1cdbd2cSJim Jagielski<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> 44*b1cdbd2cSJim Jagielski</section> 45*b1cdbd2cSJim Jagielski<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> 46*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3152347" xml-lang="en-US" level="2" l10n="U" oldref="4">Syntax:</paragraph> 47*b1cdbd2cSJim Jagielski<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> 48*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3150713" xml-lang="en-US" level="2" l10n="U" oldref="6">Return value:</paragraph> 49*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3145090" xml-lang="en-US" l10n="U" oldref="7">String</paragraph> 50*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3149346" xml-lang="en-US" level="2" l10n="U" oldref="8">Parameter:</paragraph> 51*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3153311" xml-lang="en-US" l10n="U" oldref="9"> 52*b1cdbd2cSJim Jagielski<emph>Msg</emph>: String expression displayed as the message in the dialog box.</paragraph> 53*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3145315" xml-lang="en-US" l10n="U" oldref="10"> 54*b1cdbd2cSJim Jagielski<emph>Title</emph>: String expression displayed in the title bar of the dialog box.</paragraph> 55*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3154307" xml-lang="en-US" l10n="U" oldref="11"> 56*b1cdbd2cSJim Jagielski<emph>Default</emph>: String expression displayed in the text box as default if no other input is given.</paragraph> 57*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3147573" xml-lang="en-US" l10n="U" oldref="12"> 58*b1cdbd2cSJim Jagielski<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> 59*b1cdbd2cSJim Jagielski<paragraph role="paragraph" id="par_id3156024" xml-lang="en-US" l10n="U" oldref="13"> 60*b1cdbd2cSJim Jagielski<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> 61*b1cdbd2cSJim Jagielski<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> 62*b1cdbd2cSJim Jagielski<paragraph role="heading" id="hd_id3149456" xml-lang="en-US" level="2" l10n="U" oldref="15">Example:</paragraph> 63*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3153379" xml-lang="en-US" l10n="U" oldref="16">Sub ExampleInputBox</paragraph> 64*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3149656" xml-lang="en-US" l10n="U" oldref="17">Dim sText As String</paragraph> 65*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3154367" xml-lang="en-US" l10n="U" oldref="18">sText = InputBox ("Please enter a phrase:","Dear User")</paragraph> 66*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3151042" xml-lang="en-US" l10n="U" oldref="19">MsgBox ( sText , 64, "Confirmation of phrase")</paragraph> 67*b1cdbd2cSJim Jagielski<paragraph role="code" id="par_id3150768" xml-lang="en-US" l10n="U" oldref="20">End Sub</paragraph> 68*b1cdbd2cSJim Jagielski</body> 69*b1cdbd2cSJim Jagielski</helpdocument> 70