_IEquerySelectorAll()

uncommon · March 21, 2016

So in my time of coding I found a better, precise and more powerful way of finding element objects by classname and by tags. Its called querySelectorAll and it looks like this.

Now I can forget needing to use a combination of _ietagnameget... and _iegetobjbyclassname... and just use one function.

I have not tested this on the latest version of autoit, due to the many script braking changes, but I think it should still work.

Credit to Dale Hohm who built the foundation of IE UDF and mLipok who made the error checking better on a previous post.

DO note: This a relatively recent add-on to IE so it requires IE 9 and above. If you find you receive a com error of "unknown name" its likely the site is using meta tag attribute X-UA-Compatible which has reverted the browser to forget about it.

Comments welcome

;#FUNCTION#=============================================================================================================
; Name...........: _IEquerySelectorAll()
; Description ...: Returns an Object or a Colection of objects
; Syntax.........: (ByRef $oDoc, $sQuery, $iItemIndex = Default)
; Parameters ....: $oDoc - The document object from IE
;                  $sQuery - String of Query. Example: _IEquerySelectorAll($oDoc, '"div.note, div.alert"', Default) will return a colection of div elements with classes of note and alert
;                  $iItemIndex -     [optional] Default returns a colection, else use a 0 based index to indicate the object in sequence
; Return values .: Success - Object or a Colection of objects
;                  Failure - returns 0 sets the @error flag to non-zero.
;                   3 ($_IEStatus_InvalidDataType) - Invalid Data Type
;                   4 ($_IEStatus_InvalidObjectType) - Invalid Object Type
;                   5 ($_IEStatus_InvalidValue) - Invalid Value
;                   7 ($_IEStatus_NoMatch) - No Match
; Author ........: XThrax aka uncommon
; Remarks .......: This fuction was pretty much stolen from Dale Hohm the IE UDF creator so much credit to him, also to mLipok who made the error checking better.
;                   Also note that this a relatively recent add-on to IE so it requires IE 9 and above.
;                   If you find you receive a com error of "unknown name" its likely the site is using meta tag attribute X-UA-Compatible which has reverted the browser to forget about it.
;
; Related .......: _IETagNameAllGetCollection();_IEClassNameGetCollection()
; Link ..........;https://www.autoitscript.com/forum/topic/181376-_iequeryselectorall/
;                 https://msdn.microsoft.com/en-us/library/cc304115(v=vs.85).aspx
; Example .......; No
; =====================================================================================================================


Func _IEquerySelectorAll(ByRef $oDoc, $sQuery, $iItemIndex = Default)
    If Not IsObj($oDoc) Then
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidDataType & " Invalid DataType" & @LF)
        Return SetError($_IEStatus_InvalidDataType, 1, 0)
    ElseIf Not __IEIsObjType($oDoc, "browserdom") Then
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidObjectType & " Invalid ObjectType" & @LF)
        Return SetError($_IEStatus_InvalidObjectType, 2, 0)
    ElseIf Not IsNumber($iItemIndex) And $iItemIndex <> Default Then
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidValue & " Invalid Index" & @LF)
        Return SetError($_IEStatus_InvalidValue, 3, 0)
    ElseIf $iItemIndex = Default Or $iItemIndex >= 0 Then
        Local $oTemp = Null
        If __IEIsObjType($oDoc, "documentcontainer") Then
            $oTemp = _IEDocGetObj($oDoc)
            ConsoleWriteError("--> _IEDocGetObj Error: " & @error & " Ext: " & @extended & @LF)
            If @error Then Return SetError(@error, @extended, 0)
        Else
            $oTemp = $oDoc
        EndIf
        Local $oClassColl = $oTemp.querySelectorAll($sQuery)
        If @error Then
            ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IESTATUS_GeneralError & " GeneralError1: " & @error & @LF)
            Return SetError($_IESTATUS_GeneralError, 3, 0)
        ElseIf (Not IsObj($oClassColl)) Or $oClassColl = Null Or $oClassColl.length = 0 Then
            ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_NoMatch & " NoMatch" & @LF)
            Return SetError($_IEStatus_NoMatch, 0, 0) ; Could be caused by parameter 2, 3 or both
        Else
            If $iItemIndex = Default Then
                Return SetError($_IEStatus_Success, $oClassColl.length, $oClassColl)
            ElseIf $iItemIndex > $oClassColl.length Then
                ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidValue & " Invalid Value" & @LF)
                Return SetError($_IEStatus_InvalidValue, $oClassColl.length, 0)
            Else
                $oItem = $oClassColl.Item($iItemIndex)
                If @error Then
                    ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IESTATUS_GeneralError & " GeneralError2: " & @error & @LF)
                    Return SetError($_IESTATUS_GeneralError, 3, 0)
                ElseIf (Not IsObj($oItem)) Or $oItem = Null Then
                    ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_NoMatch & " NoMatch Index: " & $iItemIndex & @LF)
                    Return SetError($_IEStatus_NoMatch, 0, 0) ; Could be caused by parameter 2, 3 or both
                Else
                    Return SetError($_IEStatus_Success, 0, $oItem)
                EndIf
            EndIf
        EndIf
    Else
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidValue & " Invalid Value: " & $iItemIndex & @LF)
        Return SetError($_IEStatus_InvalidValue, 3, 0)
    EndIf
EndFunc   ;==>_IEquerySelectorAll

Edited March 30, 2016 by uncommon
spelling

mLipok · March 21, 2016

An interesting function.
What you think about adding them to the IE UDF ?

EDIT:
https://msdn.microsoft.com/pl-pl/library/cc304115(v=vs.85).aspx

Edited March 21, 2016 by mLipok

mLipok · March 22, 2016

Please make an example.

uncommon · March 22, 2016

36 minutes ago, mLipok said:

What you think about adding them to the IE UDF ?

:drool: I would be honored!

....

Well that's a shame, I had prepared this nice example on autoitscript.com but there seems to be some sort of problem with exiting a for in loop iteration.

interestingly enough, its not a detectable com error nor can it be avoided buy exiting a loop early. I am still using autoit 3.3.12.0 I am sure its a bug that has been fixed by now.... right? :sweating:

; Navigates to www.autoitscript.com

; runs _IEquerySelectorAll for first element with class of ".et-pb-controllers" then runs _IEquerySelectorAll for all "a" tags and clicks them.

; runs _IEquerySelectorAll for all "div" elements text with a class of "et_pb_slide_content".

; runs _IEquerySelectorAll for all "li" elements text with in The element with the ID top-menu.

#include <IE.au3>

$oIE = _IECreate("www.autoitscript.com")
If Not @error Then
    $oDoc = _IEDocGetObj($oIE)
    $oElement = _IEquerySelectorAll($oDoc, ".et-pb-controllers", 0)
    If IsObj($oElement) Then
    $oDot = _IEquerySelectorAll($oElement, "a", 3)
    If IsObj($oDot) Then _IEAction($oDot, "click")
    Sleep(2000)
    $oDot = _IEquerySelectorAll($oElement, "a", 2)
        If IsObj($oDot) Then _IEAction($oDot, "click")
    Sleep(2000)
    $oDot = _IEquerySelectorAll($oElement, "a", 1)
        If IsObj($oDot) Then _IEAction($oDot, "click")
    Sleep(2000)
    $oDot = _IEquerySelectorAll($oElement, "a", 0)
        If IsObj($oDot) Then _IEAction($oDot, "click")
    EndIf
    $oElements = _IEquerySelectorAll($oDoc, "div.et_pb_slide_content")
    If IsObj($oElements) Then
        For $oElement In $oElements
            ConsoleWrite($oElement.InnerTEXT & @LF & @LF)
        Next
    EndIf
    $oMenu = _IEGetObjById($oDoc, "top-menu")
    If IsObj($oMenu) Then
        $oElements = _IEquerySelectorAll($oMenu, "li")
        If IsObj($oElements) Then
            For $oElement In $oElements
                ConsoleWrite($oElement.InnerTEXT & @LF)
            Next
        EndIf
    EndIf
EndIf

mLipok · March 22, 2016

Unfortunately, in version 3.3.14.2 it is still not fixed ( I think this is already reported on track).
Thanks for example.

mLipok · March 28, 2016

I found what was a problem:

This is not bug in AutoIt.
This is bug in script.

First read here:

https://msdn.microsoft.com/pl-pl/library/cc304115(v=vs.85).aspx
https://msdn.microsoft.com/pl-pl/library/aa752483(v=vs.85).aspx

then look in MSDN example:

function getFruit() {
   var fruits = document.getElementById('fruitsalad').querySelectorAll('li.fruit');
   var fruitList = "";
   for (var i = 0; i < fruits.length; i++) {
      fruitList = fruitList + (fruits[i].innerHTML+' ');
   }
   inOut.innerHTML = fruitList;
}
function getGreen() {
   var greens = document.getElementById('greensalad').querySelectorAll('li.green');
   var greenList = "";
   for (var i = 0; i < greens.length; i++) {
      greenList = greenList + (greens[i].innerHTML + ' ');
   }
   inOut.innerHTML = greenList;
}

I was wondering why they acces to greens like an array ?
And why they iterating elements in a loop in this specific way.

Then I remember about Remarks in AutoIt HelpFile about frames:

Quote

Although MSDN documents the return value for this function as a collection object, it cannot be looped through with a For...In...Next loop like a standard collection object.
You must instead step through the collection by index - see example.

and ... voila :

;~ #AutoIt3Wrapper_Run_Debug_Mode=Y

; Navigates to www.autoitscript.com

; runs _IEquerySelectorAll for first element with class of ".et-pb-controllers" then runs _IEquerySelectorAll for all "a" tags and clicks them.

; runs _IEquerySelectorAll for all "div" elements text with a class of "et_pb_slide_content".

; runs _IEquerySelectorAll for all "li" elements text with in The element with the ID top-menu.

#include <IE.au3>
_IEErrorHandlerRegister(_User_ErrFunc)

$oIE = _IECreate("www.autoitscript.com")
If Not @error Then
    $oDoc = _IEDocGetObj($oIE)
    $oElement = _IEquerySelectorAll($oDoc, ".et-pb-controllers", 0)
    If IsObj($oElement) Then
        $oDot = _IEquerySelectorAll($oElement, "a", 3)
        If IsObj($oDot) Then _IEAction($oDot, "click")
        Sleep(2000)
        $oDot = _IEquerySelectorAll($oElement, "a", 2)
        If IsObj($oDot) Then _IEAction($oDot, "click")
        Sleep(2000)
        $oDot = _IEquerySelectorAll($oElement, "a", 1)
        If IsObj($oDot) Then _IEAction($oDot, "click")
        Sleep(2000)
        $oDot = _IEquerySelectorAll($oElement, "a", 0)
        If IsObj($oDot) Then _IEAction($oDot, "click")
    EndIf

    $oElements = _IEquerySelectorAll($oDoc, "div.et_pb_slide_content")

    If IsObj($oElements) Then
        For $iElement_idx = 1 To $oElements.length
            ConsoleWrite($oElements.item($iElement_idx).innerText & @LF & @LF)
        Next
    EndIf

    $oMenu = _IEGetObjById($oIE, "top-menu")
    If IsObj($oMenu) Then
        $oElements = _IEquerySelectorAll($oMenu, "li")
        If IsObj($oElements) Then
            For $iElement_idx = 1 To $oElements.length
                ConsoleWrite($oElements.item($iElement_idx).InnerTEXT & @LF)
            Next
        EndIf
    EndIf

EndIf

;#FUNCTION#=============================================================================================================
; Name...........: _IEquerySelectorAll()
; Description ...: Returns an Object or a Colection of objects
; Syntax.........: (ByRef $oDoc, $sQuery, $iItemIndex = Default)
; Parameters ....: $oDoc - The document object from IE
;                  $sQuery - String of Query. Example: _IEquerySelectorAll($oDoc, '"div.note, div.alert"', Default) will return a colection of div elements with classes of note and alert
;                  $iItemIndex -     [optional] Default returns a colection, else use a 0 based index to indicate the object in sequence
; Return values .: Success - Object or a Colection of objects
;                  Failure - returns 0 sets the @error flag to non-zero.
;                   3 ($_IEStatus_InvalidDataType) - Invalid Data Type
;                   4 ($_IEStatus_InvalidObjectType) - Invalid Object Type
;                   5 ($_IEStatus_InvalidValue) - Invalid Value
;                   7 ($_IEStatus_NoMatch) - No Match
; Author ........: XThrax aka uncommon
; Remarks .......: This fuction was pretty much stolen from Dale Hohm the IE UDF creator so much credit to him, also to mLipok who made the error checking better.
;                   Also note that this a relatively recent add-on to IE so it requires IE 9 and above.
;                   If you find you receive a com error of "unknown name" its likely the site is using meta tag attribute X-UA-Compatible which has reverted the browser to forget about it.
;
; Related .......: _IETagNameAllGetCollection();_IEClassNameGetCollection()
; Link ..........;https://www.autoitscript.com/forum/topic/181376-_iequeryselectorall/
;                 https://msdn.microsoft.com/en-us/library/cc304115(v=vs.85).aspx
; Example .......; No
; =====================================================================================================================


Func _IEquerySelectorAll(ByRef $oDoc, $sQuery, $iItemIndex = Default)
    If Not IsObj($oDoc) Then
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidDataType & " Invalid DataType" & @LF)
        Return SetError($_IEStatus_InvalidDataType, 1, 0)
    ElseIf Not __IEIsObjType($oDoc, "browserdom") Then
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidObjectType & " Invalid ObjectType" & @LF)
        Return SetError($_IEStatus_InvalidObjectType, 2, 0)
    ElseIf Not IsNumber($iItemIndex) And $iItemIndex <> Default Then
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidValue & " Invalid Index" & @LF)
        Return SetError($_IEStatus_InvalidValue, 3, 0)
    ElseIf $iItemIndex = Default Or $iItemIndex >= 0 Then
        Local $oTemp = Null
        If __IEIsObjType($oDoc, "documentcontainer") Then
            $oTemp = _IEDocGetObj($oDoc)
            ConsoleWriteError("--> _IEDocGetObj Error: " & @error & " Ext: " & @extended & @LF)
            If @error Then Return SetError(@error, @extended, 0)
        Else
            $oTemp = $oDoc
        EndIf
        Local $oClassColl = $oTemp.querySelectorAll($sQuery)
        If @error Then
            ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IESTATUS_GeneralError & " GeneralError1: " & @error & @LF)
            Return SetError($_IESTATUS_GeneralError, 3, 0)
        ElseIf (Not IsObj($oClassColl)) Or $oClassColl = Null Or $oClassColl.length = 0 Then
            ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_NoMatch & " NoMatch" & @LF)
            Return SetError($_IEStatus_NoMatch, 0, 0) ; Could be caused by parameter 2, 3 or both
        Else
            If $iItemIndex = Default Then
                Return SetError($_IEStatus_Success, $oClassColl.length, $oClassColl)
            ElseIf $iItemIndex > $oClassColl.length Then
                ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidValue & " Invalid Value" & @LF)
                Return SetError($_IEStatus_InvalidValue, $oClassColl.length, 0)
            Else
                $oItem = $oClassColl.Item($iItemIndex)
                If @error Then
                    ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IESTATUS_GeneralError & " GeneralError2: " & @error & @LF)
                    Return SetError($_IESTATUS_GeneralError, 3, 0)
                ElseIf (Not IsObj($oItem)) Or $oItem = Null Then
                    ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_NoMatch & " NoMatch Index: " & $iItemIndex & @LF)
                    Return SetError($_IEStatus_NoMatch, 0, 0) ; Could be caused by parameter 2, 3 or both
                Else
                    Return SetError($_IEStatus_Success, 0, $oItem)
                EndIf
            EndIf
        EndIf
    Else
        ConsoleWriteError("--> _IEquerySelectorAll Error: " & $_IEStatus_InvalidValue & " Invalid Value: " & $iItemIndex & @LF)
        Return SetError($_IEStatus_InvalidValue, 3, 0)
    EndIf
EndFunc   ;==>_IEquerySelectorAll

; User's COM error function.
; After SetUp with ObjEvent("AutoIt.Error", ....) will be called if COM error occurs
Func _User_ErrFunc($oError)
    ; Do anything here.
    ConsoleWrite(@ScriptFullPath & " (" & $oError.scriptline & ") : ==> COM Error intercepted !" & @CRLF & _
            @TAB & "err.number is: " & @TAB & @TAB & "0x" & Hex($oError.number) & @CRLF & _
            @TAB & "err.windescription:" & @TAB & $oError.windescription & @CRLF & _
            @TAB & "err.description is: " & @TAB & $oError.description & @CRLF & _
            @TAB & "err.source is: " & @TAB & @TAB & $oError.source & @CRLF & _
            @TAB & "err.helpfile is: " & @TAB & $oError.helpfile & @CRLF & _
            @TAB & "err.helpcontext is: " & @TAB & $oError.helpcontext & @CRLF & _
            @TAB & "err.lastdllerror is: " & @TAB & $oError.lastdllerror & @CRLF & _
            @TAB & "err.scriptline is: " & @TAB & $oError.scriptline & @CRLF & _
            @TAB & "err.retcode is: " & @TAB & "0x" & Hex($oError.retcode) & @CRLF & @CRLF)
EndFunc   ;==>_User_ErrFunc

Edited March 28, 2016 by mLipok

uncommon · March 29, 2016

Oh! now I see it was crashing because it would try and move to the next iteration and there would not be one. I for in iteration would "Know" or do some kind of internal check to find the length. Makes sense now, thanks for fixing my problem.

mLipok · March 29, 2016

Our "comunity" problem, as this function will be very handy.
Again thanks for sharing.

_IEquerySelectorAll()

Recommended Posts

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Link to comment

Share on other sites

Create an account or sign in to comment

Create an account

Sign in

Recently Browsing 0 members

Similar Content