summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlain Romedenne <alain.romedenne@libreoffice.org>2021-04-06 17:25:17 +0200
committerOlivier Hallot <olivier.hallot@libreoffice.org>2021-04-14 13:28:49 +0200
commitf1c3329df60dd8e0d5fb495a1e2f12790eb7a829 (patch)
treee4684eb17812ed2d50db9827ce316ff004d11533
parentCreate SFDocuments.Form help page (diff)
downloadhelp-f1c3329df60dd8e0d5fb495a1e2f12790eb7a829.tar.gz
help-f1c3329df60dd8e0d5fb495a1e2f12790eb7a829.zip
tdf#141474 InputBox Basic method signature
Change-Id: Ie7e5a956e7871d964fb55d81ce639cff0f64642d Reviewed-on: https://gerrit.libreoffice.org/c/help/+/113643 Tested-by: Jenkins Reviewed-by: Olivier Hallot <olivier.hallot@libreoffice.org>
-rw-r--r--source/text/sbasic/shared/03010201.xhp27
1 files changed, 13 insertions, 14 deletions
diff --git a/source/text/sbasic/shared/03010201.xhp b/source/text/sbasic/shared/03010201.xhp
index 353d6a4425..5e7ee3543d 100644
--- a/source/text/sbasic/shared/03010201.xhp
+++ b/source/text/sbasic/shared/03010201.xhp
@@ -33,29 +33,28 @@
<bookmark_value>InputBox function</bookmark_value>
</bookmark>
-
-<paragraph id="hd_id3148932" role="heading" level="1" xml-lang="en-US"><link href="text/sbasic/shared/03010201.xhp" name="InputBox Function">InputBox Function</link></paragraph>
+<h1 id="hd_id3148932" xml-lang="en-US"><link href="text/sbasic/shared/03010201.xhp" name="InputBox Function">InputBox Function</link></h1>
<paragraph id="par_id3151262" role="paragraph" xml-lang="en-US">Displays a prompt in a dialog at which the user can input text. The input is assigned to a variable.</paragraph>
</section>
<paragraph id="par_id3151100" role="paragraph" xml-lang="en-US">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 id="hd_id3152347" role="heading" level="2" xml-lang="en-US">Syntax:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functsyntax"/>
<bascode>
-<paragraph id="par_id3159201" role="bascode" xml-lang="en-US">InputBox (Msg As String[, Title As String[, Default As String[, x_pos As Integer, y_pos As Integer]]]]) </paragraph>
+<paragraph id="par_id3159201" role="bascode" localize="false">InputBox (Prompt As String[, Title As String[, Default As String[, xPosTwips As Integer, yPosTwips As Integer]]]) As String</paragraph>
</bascode>
-<paragraph id="hd_id3150713" role="heading" level="2" xml-lang="en-US">Return value:</paragraph>
-<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">String</paragraph>
-
-<paragraph id="hd_id3149346" role="heading" level="2" xml-lang="en-US">Parameter:</paragraph>
-<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US"> <emph>Msg</emph>: String expression displayed as the message in the dialog box.</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functparameters"/>
+<paragraph id="par_id3153311" role="paragraph" xml-lang="en-US"> <emph>Prompt</emph>: String expression displayed as the message in the dialog box.</paragraph>
<paragraph id="par_id3145315" role="paragraph" xml-lang="en-US"> <emph>Title</emph>: String expression displayed in the title bar of the dialog box.</paragraph>
<paragraph id="par_id3154307" role="paragraph" xml-lang="en-US"> <emph>Default</emph>: String expression displayed in the text box as default if no other input is given.</paragraph>
-<paragraph id="par_id3147573" role="paragraph" xml-lang="en-US"> <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 id="par_id3156024" role="paragraph" xml-lang="en-US"> <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 id="par_id3153897" role="paragraph" xml-lang="en-US">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 id="par_id3147573" role="paragraph" xml-lang="en-US"> <emph>xPosTwips</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 id="par_id3156024" role="paragraph" xml-lang="en-US"> <emph>yPosTwips</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 id="par_id3153897" role="paragraph" xml-lang="en-US">If <emph>xPosTwips</emph> and <emph>yPosTwips</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 id="hd_id3149456" role="heading" level="2" xml-lang="en-US">Example:</paragraph>
+<embed href="text/sbasic/shared/00000003.xhp#functvalue"/>
+<paragraph id="par_id3145090" role="paragraph" xml-lang="en-US">String</paragraph>
+
+<embed href="text/sbasic/shared/00000003.xhp#functexample"/>
<bascode>
<paragraph id="par_idm1341285584" role="bascode" localize="false" xml-lang="en-US">Sub ExampleInputBox</paragraph>
<paragraph id="par_idm1341284352" role="bascode" localize="false" xml-lang="en-US">Dim sText As String</paragraph>
@@ -63,6 +62,6 @@
<paragraph id="par_id3151042" role="bascode" xml-lang="en-US"> MsgBox ( sText , 64, "Confirmation of phrase")</paragraph>
<paragraph id="par_idm1341279568" role="bascode" localize="false" xml-lang="en-US">End Sub</paragraph>
</bascode>
-</body>
+</body>
</helpdocument> \ No newline at end of file