Client instruction set checked | Convertigo Documentation

Automatically checks a target element from a web page accessed through Convertigo Site Clipper. The action is performed in the client browser after the page is loaded.

The Client instruction set checked extraction rule stores an instruction of checking/unchecking an element in a queue of client instructions. This queue is then unstacked when the page is client-side loaded. The instruction of checking/unchecking an element is performed on the page when it is loaded by the client browser.
The target element (checkbox or radio button) is defined thanks to the JQuery selector property and the state to which change the element is defined by the Checked state property. These properties are JavaScript expressions, evaluated by Convertigo when the extraction rule is applied.
In order to process the unstacking of client instructions in the web page, client instruction engine code is injected into the page after all response extraction rules are applied. When the page is client-side loaded, the client instruction engine runs and consumes each registered client instruction, in the same order as extraction rules.
Consuming the Client instruction set checked instruction, the engine selects the target element using the JQuery selector and depending on the Checked state property value:

• sets the attribute checked="checked" on the target element, if the Checked state evaluation is true,
• removes the checked attribute from the target element otherwise.

Property	Type	Category	Description
Checked state	JS expression	configuration	JavaScript expression defining the boolean value used to change the target element state. This property defines the checked state to set on the target element. It is defined thanks to a JavaScript expression evaluated using the JavaScript scope of the current context. It should return a boolean to be used as follows: • true for checked state, • false for unchecked state. The target element should be an INPUT element of checkbox or radio type.
Comment	String	configuration	Describes the object comment to include in the documentation report. This property generally contains an explanation about the object.
Is active	boolean	configuration	Defines whether the extraction rule is active.
JQuery selector	JS expression	configuration	JavaScript expression defining a JQuery selector matching the target element from the HTML document. This property defines a JQuery selector used to retrieve the target element (input field, text area, select, checkbox, radio button, etc.) on the client browser when the page is loaded. It is defined thanks to a JavaScript expression evaluated using the JavaScript scope of the current context. It should return a string to be used as a JQuery selector. Here are some default syntaxes for JQuery selectors. An id selector starts with # character, an attribute selector is between [] characters, a class selector starts with . character. The > character separating several selectors defines a constraint to the direct ancestor. The space character separating several selectors defines a constraint to any ancestor. The followings are some simple selectors that can be used in JQuery: • Select an element by id: #the_id_to_search, • Select an any type of element by name: [name="the_name_to_search"] or also *[name="the_name_to_search"], • Select an input element by name: input[name="the_name_of_the_input_to_search"], • Select an any type of element by class: .class_to_search, • Select a div element by class: div.class_of_a_div_to_search, • Select an input by name, direct child of a form element selected by class: form.form_class > input[name="input_name"], • Select an hidden input, descendant of a specified id: #specified_id input[type="hidden"]. Note: The full JQuery selector documentation is available on the official JQuery website: http://api.jquery.com/category/selectors/.