Set the value of a specified form element.
#include <IE.au3>
_IEFormElementCheckBoxSelect ( ByRef $o_object, $s_string [, $s_name = "" [, $f_select = 1 [, $s_mode = "byValue" [, $f_fireEvent = 1]]]] )
Parameters
$o_object | Object variable of an InternetExplorer.Application, Form object |
$s_string | Value used to match element - treatment based on $s_mode |
$s_name | Optional: Name or Id of checkbox(es) |
$f_select | Optional: specifies whether element should be checked or unchecked -1 = Return checked state 0 = Uncheck the element 1 = (Default) Check the element |
$s_mode | Optional: specify search mode byValue = (Default) value of the checkbox you wish to select byIndex = 0-based index of checkbox you wish to select |
$f_fireEvent | Optional: specifies whether to fire an OnChange event after changing value 0 = do not fire OnChange event after setting value 1 = (Default) fire OnChange event after setting value |
Return Value
Success: | If $f_select = -1, returns the current checked state, else returns 1 |
Failure: | Returns 0 and sets @ERROR |
@Error: | 0 ($_IEStatus_Success) = No Error |
3 ($_IEStatus_InvalidDataType) = Invalid Data Type | |
4 ($_IEStatus_InvalidObjectType) = Invalid Object Type | |
5 ($_IEStatus_InvalidValue) = Invalid Value | |
7 ($_IEStatus_NoMatch) = No Match | |
@Extended: | Contains invalid parameter number |
Remarks
The $f_fireEvent parameter is significant only if the form element has an onChange event associated with it.
Related
_IEFormElementOptionSelect, _IEFormElementRadioSelect
Example
; *******************************************************
; Example 1 - Open a browser with the form example, get reference to form, select and
; deselect the checkboxes byValue. Since $s_Name is not specified, operate
; on the collection of all <input type=checkbox> elements in the form
; Note: You will likely need to scroll down on the page to see the changes
; *******************************************************
;
#include <IE.au3>
$oIE = _IE_Example ("form")
$oForm = _IEFormGetObjByName ($oIE, "ExampleForm")
For $i = 1 To 5
_IEFormElementCheckboxSelect ($oForm, "gameBasketball", "", 1, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameFootball", "", 1, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameTennis", "", 1, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameBaseball", "", 1, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameBasketball", "", 0, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameFootball", "", 0, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameTennis", "", 0, "byValue")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, "gameBaseball", "", 0, "byValue")
Sleep(1000)
Next
; *******************************************************
; Example 2 - Open a browser with the form example, get reference to form, select and
; deselect the checkboxes byIndex. Since $s_Name is not specified, operate
; on the collection of all <input type=checkbox> elements in the form
; Note: You will likely need to scroll down on the page to see the changes
; *******************************************************
;
#include <IE.au3>
$oIE = _IE_Example ("form")
$oForm = _IEFormGetObjByName ($oIE, "ExampleForm")
For $i = 1 To 5
_IEFormElementCheckboxSelect ($oForm, 3, "", 1, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 2, "", 1, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 1, "", 1, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 0, "", 1, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 3, "", 0, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 2, "", 0, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 1, "", 0, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 0, "", 0, "byIndex")
Sleep(1000)
Next
; *******************************************************
; Example 3 - Open a browser with the form example, get reference to form, select and
; deselect the checkboxes byIndex in the group that shares the name checkboxG2Example
; Note: You will likely need to scroll down on the page to see the changes
; *******************************************************
;
#include <IE.au3>
$oIE = _IE_Example ("form")
$oForm = _IEFormGetObjByName ($oIE, "ExampleForm")
For $i = 1 To 5
_IEFormElementCheckboxSelect ($oForm, 0, "checkboxG2Example", 1, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 1, "checkboxG2Example", 1, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 0, "checkboxG2Example", 0, "byIndex")
Sleep(1000)
_IEFormElementCheckboxSelect ($oForm, 1, "checkboxG2Example", 0, "byIndex")
Sleep(1000)
Next