DisableJqEvent Method

9.9A

The DisableJqEvent method disable one or more jQuery events by name for the PWS GUI object. This method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. A PWS GUI object that has been previously declared.

return

Optional. A Numeric Variable that always returns zero.

jqevents

Required. A Character String Variable or string literal that specifies one or more jQuery event names disabled for the PWS {object}.

selector

Optional. A Character String Variable or string literal that contains selection criteria that selects objects that match the criteria.

flags

Optional. A Numeric Variable or decimal number that specifies a bit mask value that controls the behaviors of this method.

Flags Affected: OVER, ZERO

Note the following:

1. The ZERO flag is always set to TRUE because the {return} value is always zero.

2. The OVER flag is set if the {return} variable is too small to receive the numeric result.

3. This is an advanced method that is required only when custom coding is performed using the JQuery framework.

4. The DisableJqEvent method uses the {jqevents} and {selector} parameters to invoke the jQuery '.off' method as described at this URL link:

 

http://api.jquery.com/off/

 

5. The {jqevents} is a character string that contains one or more jQuery events separated by whitespace characters. The jQuery events as described at this URL link:

 

http://api.jquery.com/category/events/

 

6. The {selector} character string is a filter that determines which HTML element(s} have the jQuery event(s) disabled. If the {selector} parameter is not specified, the 'id' of the {object} specifies the selector. If the {selector} is specified, the {jqevents} are disabled for all HTML objects matching the selector. The {selector} string is passed exactly as specified to the jQuery '.on' method when the DisableJqEvent method is executed.

 

See this following URL link for more information for the {selector} criteria:

 

http://api.jquery.com/category/selectors/

 

7. The {flags} parameter is reserved for future use to control the behaviors of this method.

 

Example Code:

 

   Panel1.DisableJqEvent Using "click"

 

In this case, the {selector} defaults to use the HTML 'id' of Panel1 when disabling the jQuery event.

 

   Panel1.DisableJqEvent Using "click","##zz1"

 

In this case, the {selector} is specified as '#zz1' as the 'id' of one or more HTML object(s) on Panel1 for which the jQuery event(s) is disabled.

See Also: Method Syntax