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