Aide:AutoItSetOption.txt
De Wiki AutoIt Français
Document original V3.3.6.1 :
###Function###
AutoItSetOption
###Description###
Changes the operation of various AutoIt functions/parameters.
###Syntax###
AutoItSetOption ( "option" [, param] )
###Parameters###
@@ParamTable@@
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 <a href="../keywords/Default.htm">Default</a> can be used for the parameter to reset the option to its default value.
@@End@@
###ReturnValue###
@@ReturnTable@@
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).
@@End@@
###Remarks###
You may use Opt() as an alternative to AutoItSetOption().
Options are as follows:
<br>
@@ParamTable@@
<b>Option</b>
<b>Param</b>
CaretCoordMode
<a name="CaretCoordMode"></a>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
1 = absolute screen coordinates (default)
2 = relative coords to the client area of the active window
ExpandEnvStrings
<a name="ExpandEnvStrings"></a>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%".
1 = expand environment variables (similar to AutoIt v2)
0 = do not expand environment variables (default)
Without this option the usual way would be: "The temp directory is: " & EnvGet("temp") ;
ExpandVarStrings
<a name="ExpandVarStrings"></a>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$".
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".
0 = do not expand variables (default)
GUICloseOnESC
<a name="GUICloseOnESC"></a>When ESC is pressed on a GUI the $GUI_EVENT_CLOSE message is sent. This option toggles this behavior on and off.
1 = Send the $GUI_EVENT_CLOSE message when ESC is pressed (default).
0 = Don't send the $GUI_EVENT_CLOSE message when ESC is pressed.
GUICoordMode
<a name="GUICoordMode"></a>Alters the position of a control defined by <a href="GUICtrlSetPos.htm">GUICtrlSetPos</a>.
1 = absolute coordinates (default) still relative to the dialog box.
0 = relative position to the start of the last control (upper left corner).
2 = cell positionining 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.
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
<a name="GUIDataSeparatorChar"></a>Define the character which delimits subitems in GUICtrlSetData.
The default character is '|'.
GUIOnEventMode
<a name="GUIOnEventMode"></a>Enable/disable OnEvent functions notifications.
0 = (default) disable.
1 = enable.
GUIResizeMode
<a name="GUIResizeMode"></a>Change default resizing for a control.
0 = (default) keep default control resizing.
<1024 = anytype of resizing see <a href="GUICtrlSetResizing.htm">GUICtrlSetResizing</a>.
GUIEventOptions
<a name="GUIEventOptions"></a>Change special event behavior or GUI function return values.
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.
MouseClickDelay
<a name="MouseClickDelay"></a>Alters the length of the brief pause in between mouse clicks.
Time in milliseconds to pause (default=10).
MouseClickDownDelay
<a name="MouseClickDownDelay"></a>Alters the length a click is held down before release.
Time in milliseconds to pause (default=10).
MouseClickDragDelay
<a name="MouseClickDragDelay"></a>Alters the length of the brief pause at the start and end of a mouse drag operation.
Time in milliseconds to pause (default=250).
MouseCoordMode
<a name="MouseCoordMode"></a>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
1 = absolute screen coordinates (default)
2 = relative coords to the client area of the active window
MustDeclareVars
<a name="MustDeclareVars"></a>If this option is used then all variables must be pre-declared with Dim, Local or Global before they can be used - removes the chance for misspelled variables causing bugs.
1 = Variables must be pre-declared
0 = Variables don't need to be pre-declared (default)
PixelCoordMode
<a name="PixelCoordMode"></a>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
1 = absolute screen coordinates (default)
2 = relative coords to the client area of the defined window
SendAttachMode
<a name="SendAttachMode"></a>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.
0 = don't attach (default)
1 = attach
SendCapslockMode
<a name="SendCapslockMode"></a>Specifies if AutoIt should store the state of capslock before a Send function and restore it afterwards.
0 = don't store/restore
1 = store and restore (default)
SendKeyDelay
<a name="SendKeyDelay"></a>Alters the 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).
SendKeyDownDelay
<a name="SendKeyDownDelay"></a>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 (and many games) 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).
TCPTimeout
<a name="TCPTimeout"></a>Defines the time before TCP functions stop if no communication.
Time in milliseconds before timeout (default=100).
TrayAutoPause
<a name="TrayAutoPause"></a>Script pauses when click on tray icon.
0 = no pause
1 = pause (default). If there is no DefaultMenu no pause will occurs.
TrayIconDebug
<a name="TrayIconDebug"></a>If enabled shows the current script line in the tray icon tip to help debugging.
0 = no debug information (default)
1 = show debug
TrayIconHide
<a name="TrayIconHide"></a>Hides the AutoIt tray icon. Note: The icon will still initially appear ~750 milliseconds.
0 = show icon (default)
1 = hide icon
TrayMenuMode
<a name="TrayMenuMode"></a>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).
1 = no default menu
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
8 = turn off auto check of radio item groups
TrayOnEventMode
<a name="TrayOnEventMode"></a>Enable/disable OnEvent functions notifications for the tray.
0 = (default) disable
1 = enable
WinDetectHiddenText
<a name="WinDetectHiddenText"></a>Specifies if hidden window text can be "seen" by the window matching functions.
0 = Do not detect hidden text (default)
1 = Detect hidden text
WinSearchChildren
<a name="WinSearchChildren"></a>Allows the window search routines to search child windows as well as top-level windows.
0 = Only search top-level windows (default)
1 = Search top-level and child windows
WinTextMatchMode
<a name="WinTextMatchMode"></a>Alters the method that is used to match window text during search operations.
1 = Complete / Slow mode (default)
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).
If you are having performance problems when performing many window searches then changing to the "quick" mode may help.
WinTitleMatchMode
<a name="WinTitleMatchMode"></a>Alters the method that is used to match window titles during search operations.
1 = Match the title from the start (default)
2 = Match any substring in the title
3 = Exact title match
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.
WinWaitDelay
<a name="WinWaitDelay"></a>Alters how long a script should briefly pause after a successful window-related operation.
Time in milliseconds to pause (default=250).
@@End@@
###Related###
Many.
###Example###
@@IncludeExample@@
Document traduit V3.3.6.1 :
###Function###
AutoItSetOption
###Description###
Change le mode de fonctionnement de divers fonctions/paramètres d'AutoIt.
###Syntax###
AutoItSetOption ( "option" [, param] )
###Parameters###
@@ParamTable@@
option
L'option à changer (Voir Remarques).
param
[optionnel] La valeur à assigner à l'option. Le type et la signification varient selon l'option. Voir Remarques ci-dessous. Si le paramètre n'est pas indiqué, alors la fonction retourne la valeur qui lui est assignée. Le mot clé <a href="../keywords/défaut.htm">défaut</a> peut être utilisé en paramètre pour réinitialiser la valeur par défaut de l'option.
@@End@@
###ReturnValue###
@@ReturnTable@@
Succès : Retourne la valeur du paramètre précédent pour l'option.
Échec : Met @error <> 0. L'échec peut se produire si les paramètres sont invalides (Telle qu'un paramètre qui n'existe pas).
@@End@@
###Remarks###
Vous pouvez utiliser Opt() comme alternative à AutoItSetOption().
Les paramètres sont comme il suit :
<br>
@@ParamTable@@
<b>Option</b>
<b>Param</b>
CaretCoordMode
<a name="CaretCoordMode"></a>Détermine la manière dont les coordonnées sont utilisées dans les fonctions 'caret'. soit coordonnées absolues ou coordonnées relatives à la fenêtre active courante :
0 = Coordonnées relatives à la fenêtre active
1 = Coordonnées écran absolues (défaut)
2 = Coordonnées relatives à la zone client de la fenêtre active
ExpandEnvStrings
<a name="ExpandEnvStrings"></a>Change la méthode d'interprétation des chaînes littérales et des symboles %. Par défaut les chaînes sont traitées littéralement. Ce paramètre vous permet d'utiliser les variables %environnement% à l'intérieur des chaînes. Exemple : "Le répertoire temporaire est : %temp%".
1 = Étend les variables d'environnement (similaire à AutoIt v2)
0 = N'étend pas les variables d'environnement (défaut)
Sans ce paramètre, la méthode classique est : "Le répertoire temporaire est : " & EnvGet("temp") ;
ExpandVarStrings
<a name="ExpandVarStrings"></a>Change la méthode d'interprétation des chaînes littérales et des symboles variable/macro ($ et @). Par défaut les chaînes sont traitées littéralement. Ce paramètre vous permet d'utiliser les variables et le macros à l'intérieur des chaînes. Exemple : "La valeur de var1 est $var1$".
1 = Étend les variables (Lorsque vous êtes dans ce mode et que vous voulez utiliser les symboles $ ou @ alors doublez les : "Ceci est le symbole dollar $$".
0 = N'étend pas les variables (défaut)
GUICloseOnESC
<a name="GUICloseOnESC"></a>Lorsque la touche ESC est appuyée dans une GUI le message $GUI_EVENT_CLOSE est envoyé. Ce paramètre alterne ce comportement sur On et Off.
1 = Envoi le message $GUI_EVENT_CLOSE lorsque la touche ESC est appuyée (défaut).
0 = N'envoi pas le message $GUI_EVENT_CLOSE lorsque la touche ESC est appuyée.
GUICoordMode
<a name="GUICoordMode"></a>Modifie la position d'un contrôle définit par <a
href="GUICtrlSetPos.htm">GUICtrlSetPos</a>.
1 = Coordonnées absolues (défaut) toujours relatives à la boite de dialogue.
0 = Position relative au début du dernier contrôle (coin supérieur gauche).
2 = Positionnement de cellule relative à la cellule actuelle. Un -1 en paramètre gauche ou haut n'incrémente pas le début.
donc la ligne suivante est -1,décalage; cellule suivante est décalage,-1; cellule actuelle est -1,-1.
Évidemment le "décalage" ne peut être égal à -1 qui est réservé pour indiquer la non-incrémentation.
Mais si vous pouvez utiliser un multiple de la largeur vous choisissez de sauter ou revenir.
GUIDataSeparatorChar
<a name="GUIDataSeparatorChar"></a>Définit le caractère de délimitation des sous-éléments dans GUICtrlSetData.
Le caractère par défaut est '|'.
GUIOnEventMode
<a name="GUIOnEventMode"></a>Active/Désactive les fonctions de notification du mode événementiel.
0 = Désactive (défaut).
1 = Active.
GUIResizeMode
<a name="GUIResizeMode"></a>Change le mode de redimensionnement par défaut d'un contrôle.
0 = Garde le mode de redimensionnement par défaut (défaut).
<1024 = n'importe quel type de redimensionnement. Voir <a href="GUICtrlSetResizing.htm">GUICtrlSetResizing</a>.
GUIEventOptions
<a name="GUIEventOptions"></a>Change le comportement d'événement spécial ou les valeurs de retour de fonction graphique.
0 = Comportement normal de fenêtres au clic sur réduction, rétablissement, maximisation, redimensionnement (défaut).
1 = Supprime le comportement normal de fenêtres au clic sur réduction, rétablissement, maximisation, redimensionnement. Envoi la notification seulement.
MouseClickDelay
<a name="MouseClickDelay"></a>Modifie la durée de la pause entre les clics de souris.
Temps de pause en millisecondes (défaut = 10).
MouseClickDownDelay
<a name="MouseClickDownDelay"></a>Modifie la durée de maintient du clic avant relâchement.
Temps de pause en millisecondes (défaut = 10).
MouseClickDragDelay
<a name="MouseClickDragDelay"></a>Modifie la durée de la pause entre le début et à la fin d'une opération de déplacement.
Temps de pause en millisecondes (défaut = 250).
MouseCoordMode
<a name="MouseCoordMode"></a>Détermine la manière d'utiliser les coordonnées dans les fonctions de souris, soit coordonnées absolues ou coordonnées relatives à la fenêtre active courante :
0 = Coordonnées relatives à la fenêtre active
1 = Coordonnées absolues d'écran (défaut)
2 = Coordonnées relatives à la zone client de la fenêtre active
MustDeclareVars
<a name="MustDeclareVars"></a>Si ce paramètre est utilisée, alors toutes les variables doivent être pré-déclarées avec Dim, Local ou Global avant d'être utilisées - Évite la mauvaise orthographe de variables qui cause parfois des bogues.
1 = Les variables doivent être pré-déclarées
0 = Les variables n'ont pas besoin d'être pré-déclarée (défaut)
PixelCoordMode
<a name="PixelCoordMode"></a>Détermine la manière d'utiliser les coordonnées dans les fonctions pixel, soit coordonnées absolues ou coordonnées relatives à la fenêtre définie par hwnd (fenêtre active par défaut) :
0 = Coordonnées relatives à la fenêtre définie
1 = Coordonnées absolues d'écran (défaut)
2 = Coordonnées relatives à la zone client de la fenêtre définie
SendAttachMode
<a name="SendAttachMode"></a>Spécifie si AutoIt attache les threads d'entrée lors de l'utilisation de la fonction Send(). Sans l'attachement (mode par défaut = 0) la détection de l'état de capslock/scrolllock et numlock peut être incertaine sous NT4. Toutefois, lorsque vous spécifiez le mode d'attachement mode = 1, la syntaxe Send("{... down/up}") ne fonctionnera pas et il peut y avoir des problèmes avec l'envoi de touches aux fenêtres "bloquées". ControlSend() attache TOUJOURS et n'est pas affecté par ce mode.
0 = N'attache pas (défaut)
1 = Attache
SendCapslockMode
<a name="SendCapslockMode"></a>Spécifie si AutoIt devrait stocker l'état de verrouillage en majuscules avant une fonction Send et la restaurer après.
0 = Ne stock/restaure pas
1 = Stock et restaure (défaut)
SendKeyDelay
<a name="SendKeyDelay"></a>Modifie la durée de la pause entre les envois de frappe clavier. Une valeur de 0 supprime complètement la pause.
Temps de pause en millisecondes (défaut=5).
SendKeyDownDelay
<a name="SendKeyDownDelay"></a>Modifie le délais de maintient d'une touche avant qu'elle ne soit relâchée lors d'une frappe clavier. Pour les applications qui prennent un certain temps pour enregistrer l'appui de touches, (et certains jeux) vous aurez besoin d'augmenter cette valeur. Une valeur de 0 supprime complètement ce délais.
Temps de pause en millisecondes (défaut=5).
TCPTimeout
<a name="TCPTimeout"></a>Définit la durée avant que les fonctions TCP ne s’arrêtent si il n'y a pas de communication.
Délai d'attente en millisecondes (défaut=100).
TrayAutoPause
<a name="TrayAutoPause"></a>Met en pause le script lors du clic sur l'icône de la barre des tâches.
0 = Pas de pause
1 = Pause (défaut). Si il n'y a pas de menu par défaut, aucune pause n'aura lieu.
TrayIconDebug
<a name="TrayIconDebug"></a>Si activé, montre la ligne en cours du script, dans une bulle d'information de la barre des tâches pour aider au débogage.
0 = Aucune informations de débogage (défaut)
1 = Montre les informations de débogage
TrayIconHide
<a name="TrayIconHide"></a>Cache l'icône de AutoIt dans la barre des tâches. Note: L'icône apparaitra ~750 millisecondes lors de l'initialisation.
0 = Montre l'icône (défaut)
1 = Cache l'icône
TrayMenuMode
<a name="TrayMenuMode"></a>Étend le comportement de l'icône/menu de la barre des tâches. Ceci peut être fait avec une combinaison (addition) des valeurs suivantes :
0 = Les éléments du menu par défaut (Script Paused/Exit) sont ajoutés au menu créer. Les éléments activés par l'utilisateur seront automatiquement désactivés; si vous double-cliquez l'icône de la barre des tâches alors le Control ID est retourné avec le style "default" (défaut).
1 = Pas de menu par défaut
2 = Les éléments activés par l'utilisateur ne seront pas désactivés si vous cliquez dessus.
4 = Ne retourne pas le menuitemID avec le style "default" dans le menu contextuel principal si vous double cliquez l'icône de la barre des tâches
8 = Désactive l'auto activation d'élément des groupes radio
TrayOnEventMode
<a name="TrayOnEventMode"></a>Active/Désactive la notification des fonctions OnEvent pour la barre des tâches.
0 = Désactivé (défaut)
1 = Activé
WinDetectHiddenText
<a name="WinDetectHiddenText"></a>Spécifie si le texte des fenêtres cachées peut être "vu" par les fonctions de comparaison de fenêtre.
0 = Ne détecte pas le texte caché (défaut)
1 = Détecte le texte caché
WinSearchChildren
<a name="WinSearchChildren"></a>Permet aux routines de recherche de fenêtres, la recherche de fenêtres enfants aussi bien que des fenêtres de haut niveau.
0 = Cherche les fenêtres de haut niveau seulement (défaut)
1 = Cherche les fenêtres de haut niveau et enfants
WinTextMatchMode
<a name="WinTextMatchMode"></a>Change la méthode de comparaison du texte de fenêtre pendant les opérations de recherche.
1 = Complète / Mode lent (défaut)
2 = Mode rapide
Dans le mode rapide, AutoIt ne "voit" que le texte des boites de dialogue, le texte des boutons et la légende de quelques contrôles.
Dans le mode par défaut, beaucoup plus de texte peut être vu (par exemple le contenu de la fenêtre bloc-notes).
Si vous avez des problèmes de performance lors de multiples recherches de fenêtres, alors le passage en mode "rapide" pourra aider.
WinTitleMatchMode
<a name="WinTitleMatchMode"></a>Change la méthode de comparaison du titre des fenêtres pendant les opérations de recherche.
1 = Compare le titre du début (défaut)
2 = Compare n'importe quelle sous-chaîne dans le titre
3 = Compare l'exactitude du titre
4 = Mode avancé, voir <a href="../intro/windowsadvanced.htm">Titre et texte d'une fenêtre (Avancé)</a>
-1 à -4 = force la comparaison en minuscule en accord avec l'autre type de comparaison.
WinWaitDelay
<a name="WinWaitDelay"></a>Change la durée de la pause après une opération de fenêtre réussie.
Temps de pause en millisecondes (défaut=250).
@@End@@
###Related###
Un grand nombre.
###Example###
@@IncludeExample@@
Traducteur : Tlem
Contributeurs (pour les modifications avant le Wiki) : TommyDDR, sylvanie, zeshrek,
