From 759025310872d7c8ad6d360e15ec4af55e7012ac Mon Sep 17 00:00:00 2001 From: Pierre F Date: Sat, 3 Aug 2024 10:34:30 +0200 Subject: [PATCH] MsgBox not a Statement. tdf#162447 originally from https://ask.libreoffice.org/t/msgbox-statement-vs-function/108929 Change-Id: I62e871b878ec463e9d82a7506124a5c99de7ac28 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/171415 Tested-by: Jenkins Reviewed-by: Olivier Hallot --- AllLangHelp_sbasic.mk | 1 - source/auxiliary/sbasic.tree | 1 - source/text/sbasic/shared/03/sf_basic.xhp | 2 +- source/text/sbasic/shared/03010100.xhp | 1 - source/text/sbasic/shared/03010101.xhp | 227 -------------------- source/text/sbasic/shared/03010102.xhp | 247 ++++++++++++++++++---- source/text/sbasic/shared/03040000.xhp | 2 +- source/text/sbasic/shared/03103600.xhp | 2 +- 8 files changed, 210 insertions(+), 273 deletions(-) delete mode 100644 source/text/sbasic/shared/03010101.xhp diff --git a/AllLangHelp_sbasic.mk b/AllLangHelp_sbasic.mk index 7c1670d4f0..6dd1f616b2 100644 --- a/AllLangHelp_sbasic.mk +++ b/AllLangHelp_sbasic.mk @@ -121,7 +121,6 @@ $(eval $(call gb_AllLangHelp_add_helpfiles,sbasic,\ helpcontent2/source/text/sbasic/shared/03000000 \ helpcontent2/source/text/sbasic/shared/03010000 \ helpcontent2/source/text/sbasic/shared/03010100 \ - helpcontent2/source/text/sbasic/shared/03010101 \ helpcontent2/source/text/sbasic/shared/03010102 \ helpcontent2/source/text/sbasic/shared/03010103 \ helpcontent2/source/text/sbasic/shared/03010200 \ diff --git a/source/auxiliary/sbasic.tree b/source/auxiliary/sbasic.tree index ed9ac472c2..f4054738c5 100644 --- a/source/auxiliary/sbasic.tree +++ b/source/auxiliary/sbasic.tree @@ -230,7 +230,6 @@ Month Function MonthName Function [VBA] MsgBox Function - MsgBox Statement Name Statement New keyword Not Operator diff --git a/source/text/sbasic/shared/03/sf_basic.xhp b/source/text/sbasic/shared/03/sf_basic.xhp index bb4f814a7b..67c2fcc94a 100644 --- a/source/text/sbasic/shared/03/sf_basic.xhp +++ b/source/text/sbasic/shared/03/sf_basic.xhp @@ -594,7 +594,7 @@ bas.MsgBox(prompt: str, [buttons: int], [title: str])[: int] - + An optional integer as detailed in above IDxx properties. diff --git a/source/text/sbasic/shared/03010100.xhp b/source/text/sbasic/shared/03010100.xhp index bf15be4633..8fc93123bf 100644 --- a/source/text/sbasic/shared/03010100.xhp +++ b/source/text/sbasic/shared/03010100.xhp @@ -36,7 +36,6 @@

Display Functions

This section describes Runtime functions used to output information to the screen display. - diff --git a/source/text/sbasic/shared/03010101.xhp b/source/text/sbasic/shared/03010101.xhp deleted file mode 100644 index 8e5ae2946c..0000000000 --- a/source/text/sbasic/shared/03010101.xhp +++ /dev/null @@ -1,227 +0,0 @@ - - - - - - - MsgBox Statement - /text/sbasic/shared/03010101.xhp - - - - -
- - MsgBox statement - - -

MsgBox Statement

-Displays a dialog box containing a message. -
- - - - MsgBox prompt As String [,buttons = MB_OK [,title As String]] - response = MsgBox( prompt As String [,buttons = MB_OK [,title As String]]) - - -
- -
- prompt: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13). - title: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application. - buttons: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. buttons represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values: -
- -
- - - - Named constant - - - Integer value - - - Definition - - - - - MB_OK - - - 0 - - - Display OK button only. - - - - - MB_OKCANCEL - - - 1 - - - Display OK and Cancel buttons. - - - - - MB_ABORTRETRYIGNORE - - - 2 - - - Display Abort, Retry, and Ignore buttons. - - - - - MB_YESNOCANCEL - - - 3 - - - Display Yes, No, and Cancel buttons. - - - - - MB_YESNO - - - 4 - - - Display Yes and No buttons. - - - - - MB_RETRYCANCEL - - - 5 - - - Display Retry and Cancel buttons. - - - - - MB_ICONSTOP - - - 16 - - - Add the Stop icon to the dialog. - - - - - MB_ICONQUESTION - - - 32 - - - Add the Question icon to the dialog. - - - - - MB_ICONEXCLAMATION - - - 48 - - - Add the Exclamation Point icon to the dialog. - - - - - MB_ICONINFORMATION - - - 64 - - - Add the Information icon to the dialog. - - - - - - - - 128 - - - First button in the dialog as default button. - - - - - MB_DEFBUTTON2 - - - 256 - - - Second button in the dialog as default button. - - - - - MB_DEFBUTTON3 - - - 512 - - - Third button in the dialog as default button. - - -
-
-
- - - - - - -Sub ExampleMsgBox - Const sText1 = "An unexpected error occurred." - Const sText2 = "The program execution will continue, however." - Const sText3 = "Error" - MsgBox(sText1 + Chr(13) + sText2,16,sText3) - MsgBox(sText1 + Chr(13) + sText2, MB_ICONSTOP, sText3) -End Sub - - - - diff --git a/source/text/sbasic/shared/03010102.xhp b/source/text/sbasic/shared/03010102.xhp index b6e110aeb2..9fef9f1a1d 100644 --- a/source/text/sbasic/shared/03010102.xhp +++ b/source/text/sbasic/shared/03010102.xhp @@ -20,22 +20,20 @@ - MsgBox Function + MsgBox Function /text/sbasic/shared/03010102.xhp -
- + MsgBox function - -

MsgBox Function

-Displays a dialog box containing a message and returns a value. +

MsgBox Function

+Displays a dialog box containing a message and returns a value.
@@ -43,114 +41,283 @@ MsgBox (Prompt As String [,Buttons = MB_OK [,Title As String]]) As Integer - +
+ +
+ prompt: String expression displayed as a message in the dialog box. Line breaks can be inserted with Chr$(13). + title: String expression displayed in the title bar of the dialog. If omitted, the title bar displays the name of the respective application. + buttons: Any integer expression that specifies the dialog type, as well as the number and type of buttons to display, and the icon type. buttons represents a combination of bit patterns, that is, a combination of elements can be defined by adding their respective values: +
+ + +
+ + + + Named constant + + + Integer value + + + Definition + + + + + MB_OK + + + 0 + + + Display OK button only. + + + + + MB_OKCANCEL + + + 1 + + + Display OK and Cancel buttons. + + + + + MB_ABORTRETRYIGNORE + + + 2 + + + Display Abort, Retry, and Ignore buttons. + + + + + MB_YESNOCANCEL + + + 3 + + + Display Yes, No, and Cancel buttons. + + + + + MB_YESNO + + + 4 + + + Display Yes and No buttons. + + + + + MB_RETRYCANCEL + + + 5 + + + Display Retry and Cancel buttons. + + + + + MB_ICONSTOP + + + 16 + + + Add the Stop icon to the dialog. + + + + + MB_ICONQUESTION + + + 32 + + + Add the Question icon to the dialog. + + + + + MB_ICONEXCLAMATION + + + 48 + + + Add the Exclamation Point icon to the dialog. + + + + + MB_ICONINFORMATION + + + 64 + + + Add the Information icon to the dialog. + + + + + + + + 128 + + + First button in the dialog as default button. + + + + + MB_DEFBUTTON2 + + + 256 + + + Second button in the dialog as default button. + + + + + MB_DEFBUTTON3 + + + 512 + + + Third button in the dialog as default button. + + +
+
+ -Integer +Integer + - Named constant + Named constant - Integer value + Integer value - Definition + Definition - IDOK + IDOK - 1 + 1 - OK + OK - IDCANCEL + IDCANCEL - 2 + 2 - Cancel + Cancel - IDABORT + IDABORT - 3 + 3 - Abort + Abort - IDRETRY + IDRETRY - 4 + 4 - Retry + Retry - IDIGNORE + IDIGNORE - 5 + 5 - Ignore + Ignore - IDYES + IDYES - 6 + 6 - Yes + Yes - IDNO + IDNO - 7 + 7 - No + No
+

Example:

-Sub ExampleMsgBox -Dim sVar As Integer - sVar = MsgBox("Las Vegas") - sVar = MsgBox("Las Vegas",1) - sVar = MsgBox( "Las Vegas",256 + 16 + 2,"Dialog title") - sVar = MsgBox("Las Vegas", MB_DEFBUTTON2 + MB_ICONSTOP + MB_ABORTRETRYIGNORE, "Dialog title") -End Sub +Sub ExampleMsgBox +Dim sVar As Integer + sVar = MsgBox("Las Vegas") + sVar = MsgBox("Las Vegas",1) + sVar = MsgBox( "Las Vegas",256 + 16 + 2,"Dialog title") + sVar = MsgBox("Las Vegas", MB_DEFBUTTON2 + MB_ICONSTOP + MB_ABORTRETRYIGNORE, "Dialog title") +End Sub - + \ No newline at end of file diff --git a/source/text/sbasic/shared/03040000.xhp b/source/text/sbasic/shared/03040000.xhp index 4f861e1573..fe310f41cc 100644 --- a/source/text/sbasic/shared/03040000.xhp +++ b/source/text/sbasic/shared/03040000.xhp @@ -209,7 +209,7 @@

MsgBox Named Constants

- +

GetAttr Named Constants

diff --git a/source/text/sbasic/shared/03103600.xhp b/source/text/sbasic/shared/03103600.xhp index 5cf06080d7..5d4d5ac45d 100644 --- a/source/text/sbasic/shared/03103600.xhp +++ b/source/text/sbasic/shared/03103600.xhp @@ -198,7 +198,7 @@
- +