ktMsgBox [ Syntax ] [ Return Value ] [ Arguments ] [ Commentary ] [ Examples ] ktMsgBoxEX [ Syntax ] [ Return Value ] [ Arguments ] [ Commentary ] [ Examples ] Help file download ( ktMsgBox_Help.chm )
'Source code generation wizard' is included in the workbook for demonstration.
It is OK even if it doesn't learn all syntax and rules.
It is possible to create a code easily if using the wizad.
[ Ver 3.40 release : 16 Apr. 2018 ]
ktMsgBoxAddin Ver3.40 supports OS/Excel (x64).
( Excel97 is not supported since Ver 3.30. )
［ AddinBox Home (Jpn) ］ [ English Home ] ［ ktMsgBox MainPage (Eng) ]
ktMsgBox ( Prompt, [Buttons], [Title], [Top], [Left], [PromptColor], [BackColor], [Chime], [WaveFile], [IconFile], [FontName], [FontSize], [WaitSecond], [InputType], [UserDefBtn], [BackImage], [ImageWidth], [ImageHeight], [ChimeColor], [HyperLink1], [HyperLink2], [HyperLink3] )
Return Value -- Variant ( Integer / String / Boolean ) Prompt -- String Buttons -- Long (Optional Variant, vbMsgBoxStyle by default) Title -- String (Optional Variant) ---Below, it is ["ktMsgBox" Original Interface] from here. --- Top -- Variant (Integer / Empty) (Optional Variant) Left -- Variant (Integer / Empty) (Optional Variant) PromptColor -- Long (Optional Variant, -1 by default As vbWindowText) BackColor -- Long (Optional Variant, -1 by default As vbButtonFace) Chime -- Boolean (Optional Variant, False by default) WaveFile -- String (Optional Variant) IconFile -- String (Optional Variant) FontName -- String (Optional Variant) FontSize -- Integer (Optional Variant) WaitSecond -- Integer (Optional Variant) InputType -- String (Optional Variant) UserDefBtn -- String (Optional Variant) BackImage -- String (Optional Variant) ImageWidth -- Integer (Optional Variant) ImageHeight -- Integer (Optional Variant) ChimeColor -- Long (Optional Variant, -1 by default As Brown) HyperLink1
- HyperLink3-- String (Optional Variant)
It is a function only for VBA
[ Page Top ]
The number of the clicked button returns.
The buttons argument settings are same as MsgBox.
The following shows Constant, Value and Description.vbOK 1 [ OK ] vbCancel 2 [ Cancel ] vbAbort 3 [ Abort ] vbRetry 4 [ Retry ] vbIgnore 5 [ Ignore ] vbYes 6 [ Yes ] vbNo 7 [ No ]
When you use 'User defined Button', the buttons named '1st. Button' to '4th Button' from left to right, the following values returns.
(The inside of a parenthesis is the name of the constant used in Add-in.)
1st.Button 9 ( kt_MsgBox_UserBtn1 ) 2nd.Button 10 ( kt_MsgBox_UserBtn2 ) 3rd.Button 11 ( kt_MsgBox_UserBtn3 ) 4th.Button 12 ( kt_MsgBox_UserBtn4 )
When use 'Wait Function', always [vbOK(1)] returns.
When use InputBox Function, the following values returns.
--- Click Cancel button ---
When get it as Variant type variable, [False] as Boolean type
When get it as String type variable, "False" as String type
--- After text is entered, press [Enter] key or Click [OK] button. ---
Inpted text returnes as TEXT type.
Even if it ware Numeric/Date type, it returnes as TEXT type as it is.
'#VALUE!' is returned, in case this function is wiritten in Cells.
[ Page Top ]
The ktMsgBox function syntax has these named arguments:
The Description of [ Prompt , Buttons , Title ] are same as MsgBox.
'Fixed font' stands for the font is set of 'design/screen/messagebox property of control panel'.
ForeColor : It is the color which is gotten at system color constant [vbWindowText ].
BackColor : It is the color which is gotten at system color constant [vbButtonFace ].
In ktMsgBox, there is not [Boldface] specification in the font.
When it is necessary to specify the boldface, uses [ktMsgBoxEX].
Prompt Required. String expression displayed as the message in the dialog box.
If prompt consists of more than one line, you can separate the lines using [vbCrLf], between each line.
The size of the form depending on the width of the characters used.
The message is shown with fixed font by default.
Buttons Optional. Numeric expression that is the sum of values specifying the number and type of buttons to display, the icon style to use, the identity of the default button, and the modality of the message box.
The buttons of ktMsgBox argument settings are:
--- Kind of Buttons --- vbOKOnly(0) vbOKCancel(1) vbAbortRetryIgnore(2) vbYesNoCancel(3) vbYesNo(4) vbRetryCancel(5) --- Kind of Icons --- vbCritical(16) vbQuestion(32) vbExclamation(48) vbInformation(64) << ktMsgBoxAddin Original Icons >> kt_MsgBox_MelodyIcon(80) kt_MsgBox_LimitIcon(96) kt_MsgBox_ErrIcon(112) kt_MsgBox_PencilIcon(4194320) kt_MsgBox_KeyIcon(4194336) kt_MsgBox_TrashIcon(4194352) kt_MsgBox_PinIcon(4194368) kt_MsgBox_ClipIcon(4194384) kt_MsgBox_MemoIcon(4194400) kt_MsgBox_CalendarIcon(4194416) kt_MsgBox_SandglassIcon(8388624) kt_MsgBox_CoffeeIcon(8388640) kt_MsgBox_AlarmClockIcon(8388656)
--- Default Button --- vbDefaultButton1(0) vbDefaultButton2(256) vbDefaultButton3(512) vbDefaultButton4(768)
If omitted, the default value for buttons is 0.
Same as [vbOKOnly + vbDefaultButton1] with no icon.
If [UserDefBtn] is Specified, the Kind of Buttons (vbYesNo etc.) would be ignored.
On InputBox Function, the buttons are fixed as [vbOKCancel + vbDefaultButton] only.
Title String expression displayed as the caption in the dialog box.
If omitted, the default string for caption is [ktMsgBox].
Top and Left Setting the Left or Top property of the ktMsgBox like an userform.
If one side or both are omitted ktMsgBox is shown as CenterOwner.
If one side or both are appointed Empty, ktMsgBox is shown as Center-Owner.
( added since Ver 3.30 )
When you display it on a certain Cell,
you appoint the value that converted the coordinate of the Cell by
ktCell2Position function.
( added since Ver 3.30 please refer to Example)
(Note)
Press space key when it overflowed the screen and the position
which cannot be clicked is specified by mistake.
Since a setup of a default button is effective, ktMsgBox can
be closed. If omitted, tt is interpreted as [vbDefaultButton1(0)].
PromptColor Specifies the color of a message.
You can use any integer that represents a valid color or Hexadecimal number.
You can also specify a color by using the RGB function with red, green, and blue color components.
It is possible to specify by 'the color name' using the ktWebColor2Num function.
(Eg.) PromptColor:=ktWebColor2Num("AquaMarine")
If omitted, -1 by default as [vbWindowText].
BackColor Specifies the color of a ktMsgBox's background.
You can use any integer that represents a valid color or Hexadecimal number.
You can also specify a color by using the RGB function with red, green, and blue color components.
It is possible to specify by 'the color name' using the ktWebColor2Num function.
(Eg.) BackColor:=ktWebColor2Num("AquaMarine")
If omitted, -1 by default as [vbButtonFace].
Chime When you would like to make the sound to the chime by continuation reproduction, specify [True].
If omitted [WaveFile]:
It is performed as [ System sounds : New Mail Notification ]
not related to the presence of the icon.
Specify [WaveFile]
It is performed by specified [wav] file.
WaveFile When you would like to performe your own wev file, specify the pathname of wav file include the directory or folder, and the drive. So it is performed as follows.
When No icon
[ System sounds : Default Beep ]
When icon is specifyied
Icon is vbCritical [ System sounds : System Error ] Icon is vbQuestion [ System sounds : Message (Question) ] Icon is vbExclamation [ System sounds : Message (Exclamation) ] Icon is vbInformation [ System sounds : Message (Asterisk) ] other [ System sounds : Message (Asterisk) ]
IconFile When you would like to display your own icon, specify the pathname the picture file(ico, gif, bmp ) include the directory or folder.
The display size would be [36 x 36pixel]
Besides, in case IconFile is specified, specified icon such as [vbCritical] is ignored.
FontName Specify this when you would like to use other font except fixed font.
The FontName argument has following 5 kind(You can specify by both of Uppercase or Lowercase ) of argument, or specifies the font-name installed in your PC.
"ARI" : Arial "CENT" : Century "COUR" : Courier New "ROMAN" : Times New Roman "TAHOMA" : Tahoma Except above,
Not installed font-name: fixed font
FontSize Specify this when you would like to use other font size except fixed font size.
The font size argument has following 8 kind of argument.
[9, 10, 11, 12, 14, 16, 18, 20]
When except follwing argument is specified, it would be fixed fontsize.
WaitSecond Specify this as seconds when you would like to close automatically, NOT dependent on click the button by user.You can specify 'from 5 to 60' sec.
The present time is displaied in the window upper part as real time duling 'Wait'.
Besides, when you specify [WaitSecond], [Buttons][InputType][UserDefBtn]
[HyperLink] are ignored and there are no buttons on the message box.
InputType If the width of input argument and the input column and a default display value are specified, it will function as InputBox.
Specifies continuously argument ['N'umeric, 'D'ate, 'S'tring, 'P'assword] and
width of input [1 to 8]. Defauld value should be written following to semi-colon ;.
(Eg： "N1;500" , "D2;10/30/2002" )
On InputBox Function, the buttons are fixed as [vbOKCancel + vbDefaultButton] only.
When specified Numeric/Date, inputed data will be validity checked.
When specified Password, it becomes the following operation.
a) A type character is displayed in "*".
b) The defalut argument value is not displayed.
c) When specified defalut argument, it is compared with the entry character.
(Note)
There is no function specify cell range by mouse, like InputBox Method of
Excel VBA. It's the function instead of [InputBox Function] of VB Function.
The author will not be include such a function. Thanks for your understand.
UserDefBtn You can use user defined buttons( Max 4 buttons ).
If [UserDefBtn] is Specified, the Kind of Buttons (vbYesNo etc.) would be ignored.
'The Caption of the Button' and 'The Access Key' should be written divided by
semi-colon( ; ) and Buttons are divided by comma ( , ).
"Cap1[; Key1][, Cap2[; key2][, Cap3[; key3][, Cap4[; key4]]]]"
Eg: "YesToAll(1);1,NoToAll(2);2,Yes;Y,No;N"
The width of buttons are fixed, so it cannot display so much long text.
BackImage When you would like to use Background picture as background of msgbox,
Specify the full path of the image file. [ jpg ,gif ,bmp ,wmf ] are can be specified.
It would be arranged based on the left of the message window.
(The feature of "Tiling" spreading one image on UserForm all over is not supported.)
ImageWidth / ImageHeight It would be enabled when [BackImage] is specified.
Genarally, the size of the message window would be fixed automatically according to text size and number of icon or buttons.
But when [BackImage] is specified, you can specify window size in order to make background image fit.
It's OK only specify width or height.
Omitted one would be fitted automatically.
Besise, if the value specified is smaller than autofit size, autofit would be enabled. When specify the value learger than picture image, the background of the window is sometimes shown, so I reccomend a littele smaller value than the picture size.
ChimeColor Specify to change text color of upper side of the window when 'Chime Function' or 'Wait Function' is used. If omitted, the default color would be BROWN.
It is possible to specify by 'the color name' using the ktWebColor2Num function.
(Eg.) ChimeColor:=ktWebColor2Num("AquaMarine")
HyperLink1 - HyperLink3 When specify URL or Email address, text would be Hyperlink style with blue colored underline. Displays at fixed font and size.
The mouse icon would be changed to finger style, Web browser or mail application would be shown by click.
In case URL, specify from [ http: ]
In case mail address from [ mailto: ], and write email address without space.
( Note )
If [PromptColor / BackColor / ChimeColor] is specified by the hexadecimal number
like [&H 8000 - &H FFFF], it will be recognized as Minus Integer type,
so to be as Long type please add Ampersand to the end of [End of character] like this.
[&H 8000& - &H FFFF& ]
[ Page Top ]
The question like "I would like to specify a display position with a MsgBox function"
is often posted, but MsgBox Function by VBA has not arguments about it.
This "ktMsgBox Function" was developed as the Function for the completely same
usage as a "MsgBox function", and position specification is possible. Additionally,
also [Font Color / Background Color / Wev Sound / Icon] can be customized.
Besides, the wave sounds are used in this "ktMsgBox Function" are same as "MsgBox
Function". The Wave files are located in ["Media" Directory] of ["Windows" Directory]
as follows.It can be customized so you can use properly this "ktMsgBox Function" according to
When No icon [ System sounds : Default Beep ] When icon is specifyied Icon is vbCritical [ System sounds : System Error ] Icon is vbQuestion [ System sounds : Message (Question) ] Icon is vbExclamation [ System sounds : Message (Exclamation) ] Icon is vbInformation [ System sounds : Message (Asterisk) ] other [ System sounds : Message (Asterisk) ] Fixed Sound of "Chime Function" [ System sounds : New Mail Notification ]
the meaning of your message.(Eg. When you would like to use it for Error, [Red Text],
or when abnormal occurrence [Red Background] and so on.)
It is better to specify a light color to background color,
but to decide
'what color and which value are better?'
actually, you can use the "Pallet form(Full Color)" from
the "demonstration form" of workbook named "ktMsgBoxTrial.xls". By using it, you can choose colors by your own eyes and can get RGB value.
Also icon can be changed freely, for example it's possible to display the "company logograph".
(Supplement)
All of the icons which are displayed when using
[vbCritical / vbQuestion / vbExclamation / vbInformation]
are my own making.
As other example, save as Wave file the voice like 'I found an Error!' or 'Processing has
been done.' By using the files you can have message box with an original voice!
[ Page Top ]
ktMsgBox "Done"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Dim Resp As Integer
Resp = ktMsgBox("Done" & vbCrLf & "Would like to continue？", vbOKCancel)
If (Resp = vbNo) Then
Exit Sub
End If
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Specify the display position //
------ Fixed position------
ktMsgBox "Input Error", _
vbOkOnly + vbInformation, "Input Date", _
Top:=100, Left:=200
----Adjust according to position of Input Item ot Position of the UserForm.----
ktMsgBox "Input Error", _
vbOkOnly + vbInformation, "Input Date", _
Top:=(Me.Top + 20), Left:=(Me.Left + 50)
ktMsgBox "Input Error", _
vbOkOnly + vbInformation, "Input Date", _
Top:=(Me.Top + TextBox1.Top - 10), _
Left:=(Me.Left + TextBox1.Left + 50)
---- Display it near [F5] Cell (Using ktCell2Position (Usable since Ver3.30) ) ----
Dim vntPos As Variant
Dim vntTop As Variant
Dim vntLeft As Variant
vntPos = ktCell2Position(ActiveSheet.Range("F5"))
If IsError(vntPos) Then
'[F5] Cell is out of an indication range --> omit Top/Left
vntTop = Empty
vntLeft = Empty
Else
vntTop = vntPos(0) + 5
vntLeft = vntPos(1) + 5
End If
ktMsgBox "Input Error", _
vbOkOnly + vbInformation, "Input Date", _
Top:=vntTop, Left:=vntLeft
( Note )
Press space key when it overflowed the screen and the position which cannot be
clicked is specified by mistake. Since a setup of a default button is effective,
ktMsgBox can be closed. If omitted, it is interpreted as [vbDefaultButton1(0)].
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Emphasize input error (Red font) //
ktMsgBox "Input Error", _
vbOkOnly + vbInformation, "Input Date", _
PromptColor:=vbRed
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Make background color to be a light color //
ktMsgBox "Done", _
vbOkOnly + vbInformation, "Monthly Work", _
BackColor:=&HE0E0E0
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Notify by the chime, when the end of long processing is over //
ktMsgBox "Done" & vbCrLf & "Please return to your seat quickly.", _
vbOkOnly + vbInformation, "Monthly Work", _
PromptColor:=vbBlue, Chime:=True
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Notify by changing Background color (to thin crimson) - with chime //
ktMsgBox "Inputed data is unusual." & vbCrLf & "Processing is interrupted.", _
vbOkOnly + vbExclamation, "Monthly Work", _
BackColor:=&HC0C0FF, Chime:=True
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Change fixed sound to the sound of Mail arrival //
ktMsgBox "Done", _
WaveFile:="C:\Windows\Media\Notify.wav"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Change Icon //
ktMsgBox "Done",_
IconFile:="C:\Windows\WinUpd.ico"
( Supplement )
Displayed size would be [ 36 x 36 pixcel ] when you use [ ico, gif, bmp ] file.
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Change Font Style (to Arial / 14p) //
ktMsgBox "Inputed data is unusual." & vbCrLf & "Processing is interrupted.", _
vbOkOnly + vbExclamation, "Monthly Work", _
FontName:="ARI", FontSize:=14
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// User Defined Buttons //
ktMsgBox ".....................", _
UserDefBtn:="YesToAll(1);1,NoToAll(2);2,YES;Y,NO;N"
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// InputBox Features //
Dim dtmMyDate As Date
Dim rc As String
rc = ktMsgBox("Input the Date", _
InputType:="D2;" & Format(Date, "d/mmm/yyyy"))
If (rc <> "False") Then
dtmMyDate = CDate(rc)
End If
( Note )
The contents to receive in [rc] are the character string as it typed in.
When handling as the serial value, the contents of [rc] must be changed
into the date type at the CDate function.
Because there is an error checking feature, in case of this example, it is
guaranteed that the received character string is "the character string which
can be recognized as the date".
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// Uses the Image at Background //
// Closes automatically after a few seconds //
ktMsgBox "Hi. Good morning." & vbCrLf & _
"Today, too, let's exert." & vbCrLf & vbCrLf & _
"Sorry, this window closes automatically at 30 seconds." & vbCrLf & _
"Please keep waiting.", _
WaitSecond:=30,
BackImage:="C:\My Documents\ ........ \good_morning.gif", _
ImageWidth:=200, ImageHeight:=150
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
// HyperLink //
ktMsgBox "xxxxxx Ver1.00" & vbCrLf & vbCrLf, _
HyperLink1:="http://www. ........ /index.htm", _
HyperLink2:="mailto:xxxx@........"
[ Page Top ]
ktMsgBoxEX ( Prompt, [Buttons], [Title], [Top], [Left], [BackColor], [Chime], [WaveFile], [IconFile], [WaitSecond], [InputType], [UserDefBtn], [BackImage], [ImageWidth], [ImageHeight], [ChimeColor], [HyperLink1], [HyperLink2], [HyperLink3] )
Return Value -- Variant ( Integer / String / Boolean) Prompt -- kt_MsgBoxPromptType (User defined type) Buttons -- Long (Optional Variant, vbMsgBoxStyle by default) Title -- String (Optional Variant) ---Below, it is ["ktMsgBoxEX" Original Interface] from here. --- Top -- Variant (Integer / Empty) (Optional Variant) Left -- Variant (Integer / Empty) (Optional Variant) BackColor -- Long (Optional Variant, -1 by default As vbButtonFace) Chime -- Boolean (Optional Variant, False by default) WaveFile -- String (Optional Variant) IconFile -- String (Optional Variant) WaitSecond -- Integer (Optional Variant) InputType -- String (Optional Variant) UserDefBtn -- String (Optional Variant) BackImage -- String (Optional Variant) ImageWidth -- Integer (Optional Variant) ImageHeight -- Integer (Optional Variant) ChimeColor -- Long (Optional Variant, -1 by default As Brown) HyperLink1
- HyperLink3-- String (Optional Variant)
(Note)
At user's side, argument named [Prompt] needs declare variables as follows.
Dim Prompt As kt_MsgBoxPromptType
User defined type [kt_MsgBoxPromptType ] is declared as follows in [ktMsgBoxAddin.xla].
You can use it for the referencing.
Public Type kt_MsgBoxPromptType
Message (1 To 10) As String
FName (1 To 10) As String
FSize (1 To 10) As Integer
FColor (1 To 10) As Long
FBold (1 To 10) As Boolean
End Type
(Note)
When you would like to Initialization this User defined type, call Subroutine for Initialization
as follows. This subroutine is included in [ktMsgBoxAddin.xla].
you can use it for the referencing.
Dim Prompt As kt_MsgBoxPromptType
Call ktMsgBoxPromptTypeInit( Prompt )
It is a function only for VBA
[ Page Top ]
Please refer to [ktMsgBox]
[ Page Top ]
As for the explanation except [Prompt], refer to [ktMsgBox].
Prompt Can be specified within 10 groups.
The font(Name, Size, Color ) can be specified in each group unit.
It would be Fixed font when you keep default value by [ktMsgBoxPromptTypeInit].
( Message ) To clear the value should be [""] Empty Char
Within Message, Line feed code (vbCrLf) is also effective.
When Empty Char("") comes out, message ends.
Whe you would like to insert space between the lines, use Line feed code or prepare the group containing a space.
( FName ) To clear the value should be [""] Empty Char
Specify this when you would like to use other font except fixed font.
The FontName argument has following 5 kind(You can specify by both of Uppercase or Lowercase ) of argument, or specifies the font-name installed in your PC.
.
"ARI" : Arial "CENT" : Century "COUR" : Courier New "ROMAN" : Times New Roman "TAHOMA" : Tahoma Except above,
Not installed font-name: fixed font
( FSize ) To clear the value should be -1.
Specify this when you would like to use other font size except fixed font size.
The font size argument has following 8 kind of argument.
[9, 10, 11, 12, 14, 16, 18, 20]
When except follwing argument is specified, it would be fixed fontsize.
( FColor ) To clear the value should be -1.
Specifies the color of a message.
You can use any integer that represents a valid color or Hexadecimal number.
You can also specify a color by using the RGB function with red, green, and blue color components.
It is possible to specify by 'the color name' using the ktWebColor2Num function.
(Eg.) Prompt(1).FColor=ktWebColor2Num("AquaMarine")
If omitted, -1 by default as [vbWindowText].
( FBold ) To clear the value should be False.
When making a bold font, it sets "True".
There is a font which becomes a bold font automatically, too, when making a size big.
( Note )
If [PromptColor / BackColor / ChimeColor] is specified by the hexadecimal number
like [&H 8000 - &H FFFF], it will be recognized as Minus Integer type,
so to be as Long type please add Ampersand to the end of [End of character] like this.
[&H 8000& - &H FFFF& ]
[ Page Top ]
Dim Prompt As kt_MsgBoxPromptType［ AddinBox Home (Jpn) ］ [English Home ] ［ ktMsgBox MainPage(Eng) ］
Call ktMsgBoxPromptTypeInit(Prompt)
With Prompt
.Message(1) = "* An error occurred. *"
.FSize(1) = 14
.FName(1) = "CENT"
.FColor(1) = vbRed
.Message(2) = "The reason why the error occurred xxx" & vbCrLf & _
"-----" & vbCrLf & "-----"
.FSize(2) = 10
.FColor(2) = vbBlue
.Message(3) = "Detailed information1:xxxxx" & vbCrLf & _
"Detailed information2:xxxxx" & vbCrLf & _
"Detailed information3:xxxxx"
.FSize(3) = 9
.FColor(3) = vbBlack
End With
ktMsgBoxEX Prompt, _
vbOkOnly + vbExclamation, "Monthly Work", _
Chime:=True
