PageRenderTime 38ms CodeModel.GetById 14ms RepoModel.GetById 0ms app.codeStats 0ms

/docs/commands/IfBetween.htm

http://github.com/Lexikos/AutoHotkey_L-Docs
HTML | 67 lines | 54 code | 13 blank | 0 comment | 0 complexity | a04e8ad44005c60d94dc10984d47130b MD5 | raw file
    

  1. <!DOCTYPE HTML>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. <title>If Var between Low and High - Syntax &amp; Usage | AutoHotkey</title>
    5. 

  5. <meta name="description" content="The &quot;if Var between Low and High&quot; statement checks whether a variable's contents are numerically or alphabetically between two values (inclusive)." />
    6. 

  6. <meta name="ahk:equiv-v2" content="commands/IfExpression.htm" />
    7. 

  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
    8. 

  8. <meta http-equiv="X-UA-Compatible" content="IE=edge">
    9. 

  9. <link href="../static/theme.css" rel="stylesheet" type="text/css" />
    10. 

  10. <script src="../static/content.js" type="text/javascript"></script>
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. 

  14. <h1>If var [not] between LowerBound and UpperBound</h1>
    15. 

  15. 

  16. <p>Checks whether a <a href="../Variables.htm">variable's</a> contents are numerically or alphabetically between two values (inclusive).</p>
    17. 

    18. 

  18. <pre class="Syntax">
    19. 

  19. <span class="func">if</span> Var <span class="func">between</span> LowerBound <span class="func">and</span> UpperBound
    20. 

  20. <span class="func">if</span> Var <span class="func">not between</span> LowerBound <span class="func">and</span> UpperBound
    21. 

  21. </pre>
    22. 

  22. <h2>Parameters</h2>
    23. 

  23. <dl>
    24. 

  24. 

  25.   <dt>Var</dt>
    26. 

  26.   <dd><p>The <a href="../Variables.htm">variable</a> name whose contents will be checked.</p></dd>
    27. 

  27. 

  28.   <dt>LowerBound</dt>
    29. 

  29.   <dd><p>To be within the specified range, <em>Var</em> must be greater than or equal to this string, number, or variable reference.</p></dd>
    30. 

  30. 

  31.   <dt>UpperBound</dt>
    32. 

  32.   <dd><p>To be within the specified range, <em>Var</em> must be less than or equal to this string, number, or variable reference.</p></dd>
    33. 

  33. 

  34. </dl>
    35. 

  35. 

  36. <h2>Remarks</h2>
    37. 

  37. <p>If all three of the parameters are purely numeric, they will be compared as numbers rather than as strings. Otherwise, they will be compared alphabetically as strings (that is, alphabetical order will determine whether <em>Var</em> is within the specified range). In that case, <code><a href="StringCaseSense.htm">StringCaseSense</a> On</code> can be used to make the comparison case sensitive.</p>
    38. 

  38. <p class="warning"><strong>Caution</strong>: The operators &quot;between&quot;, &quot;is&quot;, &quot;in&quot;, and &quot;contains&quot; are not supported in <a href="../Variables.htm#Expressions">expressions</a>.</p>
    39. 

  39. <h2>Related</h2>
    40. 

  40. <p><a href="IfEqual.htm">IfEqual/Greater/Less</a>, <a href="IfIn.htm">if var in/contains MatchList</a>, <a href="IfIs.htm">if var is type</a>, <a href="IfInString.htm">IfInString</a>, <a href="StringCaseSense.htm">StringCaseSense</a>, <a href="EnvAdd.htm">EnvAdd</a><a href="Block.htm">, Blocks</a>, <a href="Else.htm">Else</a></p>
    41. 

  41. <h2>Examples</h2>
    42. 

  42. <div class="ex" id="ExBasic">
    43. 

  43. <p><a href="#ExBasic">#1</a></p>
    44. 

  44. <pre>if var between 1 and 5
    45. 

  45.     MsgBox, %var% is in the range 1 to 5, inclusive.
    46. 

  46. 

  47. if var not between 0.0 and 1.0
    48. 

  48.     MsgBox %var% is not in the range 0.0 to 1.0, inclusive.
    49. 

  49. 

  50. if var between %VarLow% and %VarHigh%
    51. 

  51.     MsgBox %var% is between %VarLow% and %VarHigh%.
    52. 

  52. 

  53. if var between blue and red
    54. 

  54.     MsgBox %var% is alphabetically between the words blue and red.</pre>
    55. 

  55. </div>
    56. 

  56. 

  57. <div class="ex" id="ExInputBox">
    58. 

  58. <p><a href="#ExInputBox">#2</a></p>
    59. 

  59. <pre>LowerLimit := 1
    60. 

  60. UpperLimit := 10
    61. 

  61. InputBox, UserInput, Enter a number between %LowerLimit% and %UpperLimit%
    62. 

  62. if UserInput not between %LowerLimit% and %UpperLimit%
    63. 

  63.     MsgBox Your input is not within the valid range.</pre>
    64. 

  64. </div>
    65. 

  65. 

  66. </body>
    67. 

  67. </html>
    68. 

  68.