Difference between revisions of "Component: Input Message Box (Controls )"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
+
{| style="width:50%"
 
 
{| width="50%"
 
 
|-
 
|-
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
| 1.0 (Release)
+
| 1.0
 
|-
 
|-
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Controls  
 
| Controls  
 
|}
 
|}
  
  
 +
==Input Message Box component==
 +
Creates simple dialogue boxes to collect information from a user. Available with multiple button options, OK, Yes / No / Cancel and User String input.
  
==[[File:Component Icon 6ed9452d_1ae7_4f70_991c_6d8085a2d923.png|Image]] Input Message Box component==
+
==Component Pack==
Creates simple dialogue boxes to collect information from a user.
 
Available with multiple button options, OK, Yes / No / Cancel and User String input.
 
  
==Examples==
+
FREE
''<span style="color:red;">No additional examples</span>''
 
  
 +
==Detailed description==
  
==Downloadable macro reference==
 
  
''This component does not contain any downloadable macros''
 
  
==Simulation macro reference==
 
  
===<span style="font-weight: normal;"><u><tt>YesNoCancelMessageBox</tt></u></span>===
 
Creates a simple Yes/No/Cancel message box with a user message.
 
  
Returns 0 for Cancel, 1 for No and 2 for Yes
 
  
'''Parameters'''
 
  
:[[Variable Types|<- STRING]] ''Message''
 
::The message to display to the user
 
::''This parameter may be returned back to the caller''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BYTE]]
 
  
 +
''No detailed description exists yet for this component''
  
===<span style="font-weight: normal;"><u><tt>YesNoMessageBox</tt></u></span>===
+
==Examples==
Creates a simple Yes/No message box with a user message.
 
  
Returns True for Yes and False for No
 
  
'''Parameters'''
 
  
:[[Variable Types|<- STRING]] ''Message''
 
::The message to display to the user
 
::''This parameter may be returned back to the caller''
 
  
  
'''Return value'''
 
  
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
 
  
  
===<span style="font-weight: normal;"><u><tt>InputMessageBox</tt></u></span>===
 
Creates a simple Yes/No input box with a user message and a caption.
 
  
The Input variable returns the string the entered by the user.
 
  
Returns True for Yes and False for No
 
  
'''Parameters'''
 
  
:[[Variable Types|<- STRING]] ''Message''
+
''<span style="color:red;">No additional examples</span>''
::The message to display to the user
 
::''This parameter may be returned back to the caller''
 
  
:[[Variable Types|<- STRING]] ''Caption''
 
::The input field caption
 
::''This parameter may be returned back to the caller''
 
  
:[[Variable Types|<- STRING]] ''Input''
+
==Downloadable macro reference==
::The input string entered by the user
 
::''This parameter may be returned back to the caller''
 
  
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''YesNoCancelMessageBox'''
 +
|-
 +
| colspan="2" | Creates a simple Yes/No/Cancel message box with a user message. Returns 0 for Cancel, 1 for No and 2 for Yes&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Message
 +
|-
 +
| colspan="2" | The message to display to the user&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
'''Return value'''
 
  
:[[Variable Types|BOOL]] : Returns true if the operation is a success, else false
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''YesNoMessageBox'''
 +
|-
 +
| colspan="2" | Creates a simple Yes/No message box with a user message. Returns True for Yes and False for No&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Message
 +
|-
 +
| colspan="2" | The message to display to the user&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''InputMessageBox'''
 +
|-
 +
| colspan="2" | Creates a simple Yes/No input box with a user message and a caption. The Input variable returns the string the entered by the user. Returns True for Yes and False for No&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Message
 +
|-
 +
| colspan="2" | The message to display to the user&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Caption
 +
|-
 +
| colspan="2" | The input field caption&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Input
 +
|-
 +
| colspan="2" | The input string entered by the user&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
  
  
Line 93: Line 118:
  
 
==Property reference==
 
==Property reference==
''This component does not contain any properties''
+
 
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|}

Latest revision as of 17:22, 9 November 2022

Author Matrix TSL
Version 1.0
Category Controls


Input Message Box component

Creates simple dialogue boxes to collect information from a user. Available with multiple button options, OK, Yes / No / Cancel and User String input.

Component Pack

FREE

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

Fc9-comp-macro.png YesNoCancelMessageBox
Creates a simple Yes/No/Cancel message box with a user message. Returns 0 for Cancel, 1 for No and 2 for Yes 
Fc9-string-icon.png - STRING Message
The message to display to the user 
Fc9-u8-icon.png - BYTE Return


Fc9-comp-macro.png YesNoMessageBox
Creates a simple Yes/No message box with a user message. Returns True for Yes and False for No 
Fc9-string-icon.png - STRING Message
The message to display to the user 
Fc9-bool-icon.png - BOOL Return


Fc9-comp-macro.png InputMessageBox
Creates a simple Yes/No input box with a user message and a caption. The Input variable returns the string the entered by the user. Returns True for Yes and False for No 
Fc9-string-icon.png - STRING Message
The message to display to the user 
Fc9-string-icon.png - STRING Caption
The input field caption 
Fc9-string-icon.png - STRING Input
The input string entered by the user 
Fc9-bool-icon.png - BOOL Return



Property reference

Fc9-prop-icon.png Properties