Difference between revisions of "AutoItSetOption"

From AutoIt Wiki
Jump to navigation Jump to search
m
m
Line 1: Line 1:
==Description==
+
<!-- Autogenerated Wiki Page. -->
Changes the operation of various AutoIt functions/parameters.
+
<!-- Not meant to be user editable. -->
 +
<!-- If there is an error here then that means that there is an error in the helpfile. -->
 +
<!-- Report it to Trac with category 'Documentation'. -->
 +
<!-- See this post for more info: http://www.autoitscript.com/forum/topic/153680-convert-helpfile-to-wiki-text/-->
 +
<font face='Segoe UI, Courier New, Lucida Grande, Verdana, Helvetica, sans-serif'>
  
<pre>
+
<font size='3' weight='normal'>Changes the operation of various AutoIt functions/parameters.</font>
AutoItSetOption ( "option" [, param] )
 
</pre>
 
  
==Parameters==
+
<font face='Courier New'><div id='Syntax' style='background-color:#FFFFAA;'>
{| border='1' class='wikitable'
+
 
 +
 
 +
:AutoItSetOption ( "option" [, param] )
 +
 
 +
 
 +
</div></font>
 +
 
 +
 
 +
 
 +
==<font size=4><div id='Section' style='color:#DB7100;'>Parameters</div></font>==
 +
{| class='wikitable'
 
|-
 
|-
 
| option || The option to change. See Remarks.
 
| option || The option to change. See Remarks.
 
|-
 
|-
| param || '''[optional]''' The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword [[Default]] can be used for the parameter to reset the option to its default value.
+
| param || '''[optional]''' The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword [http://www.autoitscript.com/autoit3/docs/keywords/Default.htm Default] can be used for the parameter to reset the option to its default value.
 
|}
 
|}
  
==Return Value==
+
 
{|
+
==<font size=4><div id='Section' style='color:#DB7100;'>Return Value</div></font>==
 +
{| class='wikitable'
 
| Success: || Returns the value of the previous setting for the option.
 
| Success: || Returns the value of the previous setting for the option.
 
|-
 
|-
Line 21: Line 34:
 
|}
 
|}
  
==Remarks==
+
 
You may use [[Opt]] as an alternative to AutoItSetOption
+
 
 +
==<font size=4><div id='Section' style='color:#DB7100;'>Remarks</div></font>==
 +
You may use <a href="AutoItSetOption.htm">Opt()</a> as an alternative to <a href="AutoItSetOption.htm">AutoItSetOption()</a>.
  
 
Options are as follows:
 
Options are as follows:
{| border='1' class='wikitable'
+
{| class='wikitable'
! scope='col' | Option
+
|-
! scope='col' | Param
+
| '''Option''' || '''Param'''
 
|-
 
|-
| CaretCoordMode || [[CaretCoordMode]] Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:
+
| CaretCoordMode || Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:
 
|-
 
|-
| || 0 = relative coords to the active window
+
| CaretCoordMode || 0 = relative coords to the active window
 
|-
 
|-
| || 1 = absolute screen coordinates (default)
+
| CaretCoordMode || 1 = absolute screen coordinates (default)
 
|-
 
|-
| || 2 = relative coords to the client area of the active window
+
| CaretCoordMode || 2 = relative coords to the client area of the active window
 
|-
 
|-
| ExpandEnvStrings || [[ExpandEnvStrings]] Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".
+
| ExpandEnvStrings || Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".
 
|-
 
|-
| || 0 = do not expand environment variables (default)
+
| ExpandEnvStrings || 0 = do not expand environment variables (default)
 
|-
 
|-
| || 1 = expand environment variables
+
| ExpandEnvStrings || 1 = expand environment variables
 
|-
 
|-
| || Without this option the usual way would be: "The temp directory is: " & [[EnvGet]]("temp")
+
| ExpandEnvStrings || Without this option the usual way would be: "The temp directory is: " & [[EnvGet]]("temp")
 
|-
 
|-
| ExpandVarStrings || [[ExpandVarStrings]] Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".
+
| ExpandVarStrings || Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".
 
|-
 
|-
| || 0 = do not expand variables (default)
+
| ExpandVarStrings || 0 = do not expand variables (default)
 
|-
 
|-
| || 1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
+
| ExpandVarStrings || 1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
 
|-
 
|-
| GUICloseOnESC || [[GUICloseOnESC]] When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.
+
| GUICloseOnESC || When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.
 
|-
 
|-
| || 0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.
+
| GUICloseOnESC || 0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.
 
|-
 
|-
| || 1 = [[Send]] the $GUI_EVENT_CLOSE message when ESC is pressed (default).
+
| GUICloseOnESC || 1 = <a href="Send.htm">Send()</a> the $GUI_EVENT_CLOSE message when ESC is pressed (default).
 
|-
 
|-
| GUICoordMode || [[GUICoordMode]] Alters the position of a control defined by [[GUICtrlSetPos]]
+
| GUICoordMode || Alters the position of a control defined by <a href="GUICtrlSetPos.htm">GUICtrlSetPos()</a>.
 
|-
 
|-
| || 0 = relative position to the start of the last control (upper left corner).
+
| GUICoordMode || 0 = relative position to the start of the last control (upper left corner).
 
|-
 
|-
| || 1 = absolute coordinates (default) still relative to the dialog box.
+
| GUICoordMode || 1 = absolute coordinates (default) still relative to the dialog box.
 
|-
 
|-
| || 2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.
+
| GUICoordMode || 2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.
 
|-
 
|-
| || So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.
+
| GUICoordMode || So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.
 
|-
 
|-
| || Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
+
| GUICoordMode || Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
 
|-
 
|-
| GUIDataSeparatorChar || [[GUIDataSeparatorChar]] Define the character which delimits subitems in [[GUICtrlSetData]]
+
| GUIDataSeparatorChar || Define the character which delimits subitems in <a href="GUICtrlSetData.htm">GUICtrlSetData()</a>.
 
|-
 
|-
| || The default character is '|'.
+
| GUIDataSeparatorChar || The default character is '|'.
 
|-
 
|-
| GUIOnEventMode || [[GUIOnEventMode]] Enable/disable OnEvent functions notifications.
+
| GUIOnEventMode || Enable/disable OnEvent functions notifications.
 
|-
 
|-
| || 0 = (default) disable.
+
| GUIOnEventMode || 0 = (default) disable.
 
|-
 
|-
| || 1 = enable.
+
| GUIOnEventMode || 1 = enable.
 
|-
 
|-
| GUIResizeMode || [[GUIResizeMode]] Change default resizing for a control.
+
| GUIResizeMode || Change default resizing for a control.
 
|-
 
|-
| || 0 = (default) keep default control resizing.
+
| GUIResizeMode || 0 = (default) keep default control resizing.
 
|-
 
|-
| || &lt;1024 = any type of resizing see [[GUICtrlSetResizing]]
+
| GUIResizeMode || &lt;1024 = any type of resizing see <a href="GUICtrlSetResizing.htm">GUICtrlSetResizing()</a>.
 
|-
 
|-
| GUIEventOptions || [[GUIEventOptions]] Change special event behavior or GUI function return values.
+
| GUIEventOptions || Change special event behavior or GUI function return values.
 
|-
 
|-
| || 0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.
+
| GUIEventOptions || 0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.
 
|-
 
|-
| || 1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
+
| GUIEventOptions || 1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
 
|-
 
|-
| MouseClickDelay || [[MouseClickDelay]] Alters the length of the brief pause in between mouse clicks.
+
| MouseClickDelay || Alters the length of the brief pause in between mouse clicks.
 
|-
 
|-
| || Time in milliseconds to pause (default=10).
+
| MouseClickDelay || Time in milliseconds to pause (default=10).
 
|-
 
|-
| MouseClickDownDelay || [[MouseClickDownDelay]] Alters the length a click is held down before release.
+
| MouseClickDownDelay || Alters the length a click is held down before release.
 
|-
 
|-
| || Time in milliseconds to pause (default=10).
+
| MouseClickDownDelay || Time in milliseconds to pause (default=10).
 
|-
 
|-
| MouseClickDragDelay || [[MouseClickDragDelay]] Alters the length of the brief pause at the start and end of a mouse drag operation.
+
| MouseClickDragDelay || Alters the length of the brief pause at the start and end of a mouse drag operation.
 
|-
 
|-
| || Time in milliseconds to pause (default=250).
+
| MouseClickDragDelay || Time in milliseconds to pause (default=250).
 
|-
 
|-
| MouseCoordMode || [[MouseCoordMode]] Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:
+
| MouseCoordMode || Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:
 
|-
 
|-
| || 0 = relative coords to the active window
+
| MouseCoordMode || 0 = relative coords to the active window
 
|-
 
|-
| || 1 = absolute screen coordinates (default)
+
| MouseCoordMode || 1 = absolute screen coordinates (default)
 
|-
 
|-
| || 2 = relative coords to the client area of the active window
+
| MouseCoordMode || 2 = relative coords to the client area of the active window
 
|-
 
|-
| MustDeclareVars || [[MustDeclareVars]] If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.
+
| MustDeclareVars || If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.
 
|-
 
|-
| || 0 = Variables don't need to be pre-declared (default)
+
| MustDeclareVars || 0 = Variables don't need to be pre-declared (default)
 
|-
 
|-
| || 1 = Variables must be pre-declared
+
| MustDeclareVars || 1 = Variables must be pre-declared. See <a href="..\Keywords\Dim.htm">Dim / Global / Local / Const</a> for details on declaring variables.
 
|-
 
|-
| PixelCoordMode || [[PixelCoordMode]] Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):
+
| PixelCoordMode || Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):
 
|-
 
|-
| || 0 = relative coords to the defined window
+
| PixelCoordMode || 0 = relative coords to the defined window
 
|-
 
|-
| || 1 = absolute screen coordinates (default)
+
| PixelCoordMode || 1 = absolute screen coordinates (default)
 
|-
 
|-
| || 2 = relative coords to the client area of the defined window
+
| PixelCoordMode || 2 = relative coords to the client area of the defined window
 
|-
 
|-
| SendAttachMode || [[SendAttachMode]] Specifies if AutoIt attaches input threads when using [[Send]] function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the [[Send]]("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. [[ControlSend]] ALWAYS attaches and is not affected by this mode.
+
| SendAttachMode || Specifies if AutoIt attaches input threads when using <a href="Send.htm">Send()</a> function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the <a href="Send.htm">Send</a>("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. <a href="ControlSend.htm">ControlSend()</a> ALWAYS attaches and is not affected by this mode.
 
|-
 
|-
| || 0 = don't attach (default)
+
| SendAttachMode || 0 = don't attach (default)
 
|-
 
|-
| || 1 = attach
+
| SendAttachMode || 1 = attach
 
|-
 
|-
| SendCapslockMode || [[SendCapslockMode]] Specifies if AutoIt should store the state of capslock before a [[Send]] function and restore it afterwards.
+
| SendCapslockMode || Specifies if AutoIt should store the state of capslock before a <a href="Send.htm">Send()</a> function and restore it afterwards.
 
|-
 
|-
| || 0 = don't store/restore
+
| SendCapslockMode || 0 = don't store/restore
 
|-
 
|-
| || 1 = store and restore (default)
+
| SendCapslockMode || 1 = store and restore (default)
 
|-
 
|-
| SendKeyDelay || [[SendKeyDelay]] Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.
+
| SendKeyDelay || Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.
 
|-
 
|-
| || Time in milliseconds to pause (default=5).
+
| SendKeyDelay || Time in milliseconds to pause (default=5).
 
|-
 
|-
| SendKeyDownDelay || [[SendKeyDownDelay]] Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.
+
| SendKeyDownDelay || Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.
 
|-
 
|-
| || Time in milliseconds to pause (default=5).
+
| SendKeyDownDelay || Time in milliseconds to pause (default=5).
 
|-
 
|-
| TCPTimeout || [[TCPTimeout]] Defines the time before TCP functions stop if no communication.
+
| TCPTimeout || Defines the time before TCP functions stop if no communication.
 
|-
 
|-
| || Time in milliseconds before timeout (default=100).
+
| TCPTimeout || Time in milliseconds before timeout (default=100).
 
|-
 
|-
| TrayAutoPause || [[TrayAutoPause]] Script pauses when click on tray icon.
+
| TrayAutoPause || Script pauses when click on tray icon.
 
|-
 
|-
| || 0 = no pause
+
| TrayAutoPause || 0 = no pause
 
|-
 
|-
| || 1 = pause (default). If there is no DefaultMenu no pause will occurs.
+
| TrayAutoPause || 1 = pause (default). If there is no DefaultMenu no pause will occurs.
 
|-
 
|-
| TrayIconDebug || [[TrayIconDebug]] If enabled shows the current script line in the tray icon tip to help debugging.
+
| TrayIconDebug || If enabled shows the current script line in the tray icon tip to help debugging.
 
|-
 
|-
| || 0 = no debug information (default)
+
| TrayIconDebug || 0 = no debug information (default)
 
|-
 
|-
| || 1 = show debug
+
| TrayIconDebug || 1 = show debug
 
|-
 
|-
| TrayIconHide || [[TrayIconHide]] Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.
+
| TrayIconHide || Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.
 
|-
 
|-
| || 0 = show icon (default)
+
| TrayIconHide || 0 = show icon (default)
 
|-
 
|-
| || 1 = hide icon
+
| TrayIconHide || 1 = hide icon
 
|-
 
|-
| TrayMenuMode || [[TrayMenuMode]] Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.
+
| TrayMenuMode || Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.
 
|-
 
|-
| || 0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).
+
| TrayMenuMode || 0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).
 
|-
 
|-
| || 1 = no default menu
+
| TrayMenuMode || 1 = no default menu
 
|-
 
|-
| || 2 = user created checked items will not automatically unchecked if you click it
+
| TrayMenuMode || 2 = user created checked items will not automatically unchecked if you click it
 
|-
 
|-
| || 4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon
+
| TrayMenuMode || 4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon
 
|-
 
|-
| || 8 = turn off auto check of radio item groups
+
| TrayMenuMode || 8 = turn off auto check of radio item groups
 
|-
 
|-
| TrayOnEventMode || [[TrayOnEventMode]] Enable/disable OnEvent functions notifications for the tray.
+
| TrayOnEventMode || Enable/disable OnEvent functions notifications for the tray.
 
|-
 
|-
| || 0 = (default) disable
+
| TrayOnEventMode || 0 = (default) disable
 
|-
 
|-
| || 1 = enable
+
| TrayOnEventMode || 1 = enable
 
|-
 
|-
| WinDetectHiddenText || [[WinDetectHiddenText]] Specifies if hidden window text can be "seen" by the window matching functions.
+
| WinDetectHiddenText || Specifies if hidden window text can be "seen" by the window matching functions.
 
|-
 
|-
| || 0 = Do not detect hidden text (default)
+
| WinDetectHiddenText || 0 = Do not detect hidden text (default)
 
|-
 
|-
| || 1 = Detect hidden text
+
| WinDetectHiddenText || 1 = Detect hidden text
 
|-
 
|-
| WinSearchChildren || [[WinSearchChildren]] Allows the window search routines to search child windows as well as top-level windows.
+
| WinSearchChildren || Allows the window search routines to search child windows as well as top-level windows.
 
|-
 
|-
| || 0 = Only search top-level windows (default)
+
| WinSearchChildren || 0 = Only search top-level windows (default)
 
|-
 
|-
| || 1 = Search top-level and child windows
+
| WinSearchChildren || 1 = Search top-level and child windows
 
|-
 
|-
| WinTextMatchMode || [[WinTextMatchMode]] Alters the method that is used to match window text during search operations.
+
| WinTextMatchMode || Alters the method that is used to match window text during search operations.
 
|-
 
|-
| || 1 = Complete / Slow mode (default)
+
| WinTextMatchMode || 1 = Complete / Slow mode (default)
 
|-
 
|-
| || 2 = Quick mode
+
| WinTextMatchMode || 2 = Quick mode
 
|-
 
|-
| || In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).
+
| WinTextMatchMode || In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).
 
|-
 
|-
| || If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
+
| WinTextMatchMode || If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
 
|-
 
|-
| WinTitleMatchMode || [[WinTitleMatchMode]] Alters the method that is used to match window titles during search operations.
+
| WinTitleMatchMode || Alters the method that is used to match window titles during search operations.
 
|-
 
|-
| || 1 = Match the title from the start (default)
+
| WinTitleMatchMode || 1 = Match the title from the start (default)
 
|-
 
|-
| || 2 = Match any substring in the title
+
| WinTitleMatchMode || 2 = Match any substring in the title
 
|-
 
|-
| || 3 = Exact title match
+
| WinTitleMatchMode || 3 = Exact title match
 
|-
 
|-
| || 4 = Advanced mode, see <a href="../intro/windowsadvanced.htm">Window Titles & Text (Advanced)</a>
+
| WinTitleMatchMode || 4 = Advanced mode, see <a href="../intro/windowsadvanced.htm">Window Titles & Text (Advanced)</a>
 
|-
 
|-
| || -1 to -4 = force lower case match according to other type of match (case-insensitive match.)
+
| WinTitleMatchMode || -1 to -4 = Case insensitive match according to the other type of match.
 
|-
 
|-
| WinWaitDelay || [[WinWaitDelay]] Alters how long a script should briefly pause after a successful window-related operation.
+
| WinWaitDelay || Alters how long a script should briefly pause after a successful window-related operation.
 
|-
 
|-
| || Time in milliseconds to pause (default=250).
+
| WinWaitDelay || Time in milliseconds to pause (default=250).
 
|}
 
|}
  
==Example==
+
 
 +
 
 +
==<font size=4><div id='Section' style='color:#DB7100;'>Related</div></font>==
 +
 
 +
 
 +
 
 +
==<font size=4><div id='Section' style='color:#DB7100;'>Example</div></font>==
 
<syntaxhighlight lang='autoit'>
 
<syntaxhighlight lang='autoit'>
 
; copy any you want to change  ;default value is listed first
 
; copy any you want to change  ;default value is listed first
Line 259: Line 280:
 
Opt("WinWaitDelay", 250) ;250 milliseconds
 
Opt("WinWaitDelay", 250) ;250 milliseconds
 
</syntaxhighlight>
 
</syntaxhighlight>
 
+
</font>
 
__NOTOC__
 
__NOTOC__
 +
__NOEDITSECTION__

Revision as of 06:28, 23 August 2013

Changes the operation of various AutoIt functions/parameters.


AutoItSetOption ( "option" [, param] )



Parameters

option The option to change. See Remarks.
param [optional] The value to assign to the option. The type and meaning vary by option. See remarks below. If the param is not provided, then the function just returns the value already assigned to the option. The keyword Default can be used for the parameter to reset the option to its default value.


Return Value

Success: Returns the value of the previous setting for the option.
Failure: Sets @error to non-zero. Failure will occur if the parameters are invalid (such as an option that doesn't exist).


Remarks

You may use <a href="AutoItSetOption.htm">Opt()</a> as an alternative to <a href="AutoItSetOption.htm">AutoItSetOption()</a>.

Options are as follows:

Option Param
CaretCoordMode Sets the way coords are used in the caret functions, either absolute coords or coords relative to the current active window:
CaretCoordMode 0 = relative coords to the active window
CaretCoordMode 1 = absolute screen coordinates (default)
CaretCoordMode 2 = relative coords to the client area of the active window
ExpandEnvStrings Changes how literal strings and % symbols are interpreted. By default strings are treated literally, this option allows you to use %environment% variables inside strings, e.g., "The temp directory is: %temp%".
ExpandEnvStrings 0 = do not expand environment variables (default)
ExpandEnvStrings 1 = expand environment variables
ExpandEnvStrings Without this option the usual way would be: "The temp directory is: " & EnvGet("temp")
ExpandVarStrings Changes how literal strings and variable/macro ($ and @) symbols are interpreted. By default strings are treated literally, this option allows you to use variables and macros inside strings, e.g., "The value of var1 is $var1$".
ExpandVarStrings 0 = do not expand variables (default)
ExpandVarStrings 1 = expand variables (when in this mode and you want to use a literal $ or @ then double it up: "This is a single dollar $$ sign".
GUICloseOnESC When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.
GUICloseOnESC 0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.
GUICloseOnESC 1 = <a href="Send.htm">Send()</a> the $GUI_EVENT_CLOSE message when ESC is pressed (default).
GUICoordMode Alters the position of a control defined by <a href="GUICtrlSetPos.htm">GUICtrlSetPos()</a>.
GUICoordMode 0 = relative position to the start of the last control (upper left corner).
GUICoordMode 1 = absolute coordinates (default) still relative to the dialog box.
GUICoordMode 2 = cell positioning relative to current cell. A -1 for left or top parameter don't increment the start.
GUICoordMode So next line is -1, offset; next cell is offset,-1; current cell is -1,-1.
GUICoordMode Obviously "offset" cannot be -1 which reserved to indicate the no increment. But if you can use a multiple of the width you choose to skip or go back.
GUIDataSeparatorChar Define the character which delimits subitems in <a href="GUICtrlSetData.htm">GUICtrlSetData()</a>.
GUIDataSeparatorChar '.
GUIOnEventMode Enable/disable OnEvent functions notifications.
GUIOnEventMode 0 = (default) disable.
GUIOnEventMode 1 = enable.
GUIResizeMode Change default resizing for a control.
GUIResizeMode 0 = (default) keep default control resizing.
GUIResizeMode <1024 = any type of resizing see <a href="GUICtrlSetResizing.htm">GUICtrlSetResizing()</a>.
GUIEventOptions Change special event behavior or GUI function return values.
GUIEventOptions 0 = (default) Windows behavior on click on Minimize,Restore, Maximize, Resize.
GUIEventOptions 1 = suppress windows behavior on minimize, restore or maximize click button or window resize. Just sends the notification.
MouseClickDelay Alters the length of the brief pause in between mouse clicks.
MouseClickDelay Time in milliseconds to pause (default=10).
MouseClickDownDelay Alters the length a click is held down before release.
MouseClickDownDelay Time in milliseconds to pause (default=10).
MouseClickDragDelay Alters the length of the brief pause at the start and end of a mouse drag operation.
MouseClickDragDelay Time in milliseconds to pause (default=250).
MouseCoordMode Sets the way coords are used in the mouse functions, either absolute coords or coords relative to the current active window:
MouseCoordMode 0 = relative coords to the active window
MouseCoordMode 1 = absolute screen coordinates (default)
MouseCoordMode 2 = relative coords to the client area of the active window
MustDeclareVars If this option is used then all variables must be pre-declared with Local, Global or in some cases Dim before they can be used - removes the chance for misspelled variables causing bugs.
MustDeclareVars 0 = Variables don't need to be pre-declared (default)
MustDeclareVars 1 = Variables must be pre-declared. See <a href="..\Keywords\Dim.htm">Dim / Global / Local / Const</a> for details on declaring variables.
PixelCoordMode Sets the way coords are used in the pixel functions, either absolute coords or coords relative to the window defined by hwnd (default active window):
PixelCoordMode 0 = relative coords to the defined window
PixelCoordMode 1 = absolute screen coordinates (default)
PixelCoordMode 2 = relative coords to the client area of the defined window
SendAttachMode Specifies if AutoIt attaches input threads when using <a href="Send.htm">Send()</a> function. When not attaching (default mode=0) detecting the state of capslock/scrolllock and numlock can be unreliable under NT4. However, when you specify attach mode=1 the <a href="Send.htm">Send</a>("{... down/up}") syntax will not work and there may be problems with sending keys to "hung" windows. <a href="ControlSend.htm">ControlSend()</a> ALWAYS attaches and is not affected by this mode.
SendAttachMode 0 = don't attach (default)
SendAttachMode 1 = attach
SendCapslockMode Specifies if AutoIt should store the state of capslock before a <a href="Send.htm">Send()</a> function and restore it afterwards.
SendCapslockMode 0 = don't store/restore
SendCapslockMode 1 = store and restore (default)
SendKeyDelay Alters the length of the brief pause in between sent keystrokes. A value of 0 removes the delay completely.
SendKeyDelay Time in milliseconds to pause (default=5).
SendKeyDownDelay Alters the length of time a key is held down before being released during a keystroke. For applications that take a while to register keypresses you may need to raise this value from the default. A value of 0 removes the delay completely.
SendKeyDownDelay Time in milliseconds to pause (default=5).
TCPTimeout Defines the time before TCP functions stop if no communication.
TCPTimeout Time in milliseconds before timeout (default=100).
TrayAutoPause Script pauses when click on tray icon.
TrayAutoPause 0 = no pause
TrayAutoPause 1 = pause (default). If there is no DefaultMenu no pause will occurs.
TrayIconDebug If enabled shows the current script line in the tray icon tip to help debugging.
TrayIconDebug 0 = no debug information (default)
TrayIconDebug 1 = show debug
TrayIconHide Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.
TrayIconHide 0 = show icon (default)
TrayIconHide 1 = hide icon
TrayMenuMode Extend the behaviour of the script tray icon/menu. This can be done with a combination (adding) of the following values.
TrayMenuMode 0 = default menu items (Script Paused/Exit) are appended to the usercreated menu; usercreated checked items will automatically unchecked; if you double click the tray icon then the controlid is returned which has the "Default"-style (default).
TrayMenuMode 1 = no default menu
TrayMenuMode 2 = user created checked items will not automatically unchecked if you click it
TrayMenuMode 4 = don't return the menuitemID which has the "default"-style in the main contextmenu if you double click the tray icon
TrayMenuMode 8 = turn off auto check of radio item groups
TrayOnEventMode Enable/disable OnEvent functions notifications for the tray.
TrayOnEventMode 0 = (default) disable
TrayOnEventMode 1 = enable
WinDetectHiddenText Specifies if hidden window text can be "seen" by the window matching functions.
WinDetectHiddenText 0 = Do not detect hidden text (default)
WinDetectHiddenText 1 = Detect hidden text
WinSearchChildren Allows the window search routines to search child windows as well as top-level windows.
WinSearchChildren 0 = Only search top-level windows (default)
WinSearchChildren 1 = Search top-level and child windows
WinTextMatchMode Alters the method that is used to match window text during search operations.
WinTextMatchMode 1 = Complete / Slow mode (default)
WinTextMatchMode 2 = Quick mode
WinTextMatchMode In quick mode AutoIt can usually only "see" dialog text, button text and the captions of some controls. In the default mode much more text can be seen (for instance the contents of the Notepad window).
WinTextMatchMode If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
WinTitleMatchMode Alters the method that is used to match window titles during search operations.
WinTitleMatchMode 1 = Match the title from the start (default)
WinTitleMatchMode 2 = Match any substring in the title
WinTitleMatchMode 3 = Exact title match
WinTitleMatchMode 4 = Advanced mode, see <a href="../intro/windowsadvanced.htm">Window Titles & Text (Advanced)</a>
WinTitleMatchMode -1 to -4 = Case insensitive match according to the other type of match.
WinWaitDelay Alters how long a script should briefly pause after a successful window-related operation.
WinWaitDelay Time in milliseconds to pause (default=250).


Related

Example

; copy any you want to change   ;default value is listed first

Opt("CaretCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("ExpandEnvStrings", 0) ;0=don't expand, 1=do expand
Opt("ExpandVarStrings", 0) ;0=don't expand, 1=do expand
Opt("GUICloseOnESC", 1) ;1=ESC  closes, 0=ESC won't close
Opt("GUICoordMode", 1) ;1=absolute, 0=relative, 2=cell
Opt("GUIDataSeparatorChar", "|") ;"|" is the default
Opt("GUIOnEventMode", 0) ;0=disabled, 1=OnEvent mode enabled
Opt("GUIResizeMode", 0) ;0=no resizing, <1024 special resizing
Opt("GUIEventOptions", 0) ;0=default, 1=just notification, 2=GUICtrlRead tab index
Opt("MouseClickDelay", 10) ;10 milliseconds
Opt("MouseClickDownDelay", 10) ;10 milliseconds
Opt("MouseClickDragDelay", 250) ;250 milliseconds
Opt("MouseCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("MustDeclareVars", 0) ;0=no, 1=require pre-declaration
Opt("PixelCoordMode", 1) ;1=absolute, 0=relative, 2=client
Opt("SendAttachMode", 0) ;0=don't attach, 1=do attach
Opt("SendCapslockMode", 1) ;1=store and restore, 0=don't
Opt("SendKeyDelay", 5) ;5 milliseconds
Opt("SendKeyDownDelay", 1) ;1 millisecond
Opt("TCPTimeout", 100) ;100 milliseconds
Opt("TrayAutoPause", 1) ;0=no pause, 1=Pause
Opt("TrayIconDebug", 0) ;0=no info, 1=debug line info
Opt("TrayIconHide", 0) ;0=show, 1=hide tray icon
Opt("TrayMenuMode", 0) ;0=append, 1=no default menu, 2=no automatic check, 4=menuitemID  not return
Opt("TrayOnEventMode", 0) ;0=disable, 1=enable
Opt("WinDetectHiddenText", 0) ;0=don't detect, 1=do detect
Opt("WinSearchChildren", 1) ;0=no, 1=search children also
Opt("WinTextMatchMode", 1) ;1=complete, 2=quick
Opt("WinTitleMatchMode", 1) ;1=start, 2=subStr, 3=exact, 4=advanced, -1 to -4=Nocase
Opt("WinWaitDelay", 250) ;250 milliseconds