SplitSideBySide, AccessibilityInspector, BrowserAutomation & index generator

Author: sancarn

.gen/index.js

@@ -0,0 +1,27 @@
+const { readdirSync, readFileSync, writeFileSync } = require("fs");
+let paths = readdirSync("../examples").map(e => `../examples/${e}/README.md`);
+let regex = /<!--\s*({(?:\s|(?!-->).)*})\s*-->/;
+let metas = paths.map(e => ({ path: e, text: readFileSync(e).toString() }))
+    .filter(e => regex.test(e.text))
+    .map(e => ({ path: e.path, data: JSON.parse(regex.exec(e.text)[1]) }))
+console.log(metas)
+
+let md = `
+# \`stdVBA\` Examples
+
+This repository holds examples of using \`stdVBA\`. This should give people a better idea of how to use \`stdVBA\` and libraries.
+
+## Contents
+
+| Title | Tags | Dependencies |
+|-------|------|--------------|
+${metas.map(function (meta) {
+    return "|" + [
+        "[" + meta.data.description + "](" + encodeURI(meta.path.substring(3, meta.path.length - "/README.md".length)) + ")",
+        meta.data.tags.join(", "),
+        meta.data.deps.join(", ")
+    ].join("|") + "|"
+}).join("\r\n")}
+`
+writeFileSync("../README.md", md)
+

.gen/readme.build.bat

@@ -0,0 +1 @@
+node .

Examples/Accessibility Inspector/README.md

@@ -0,0 +1,45 @@
+<!--
+    {
+        "description": "Accessibility Inspector",
+        "tags":["ui", "window", "automation", "embedding"],
+        "deps":["stdAcc", "stdProcess", "stdWindow", "stdICallable"]
+    }
+-->
+
+# Accessibility Inspector
+
+While using `stdAcc` it is often useful to be able to obtain the accessibility information at the cursor. This can help you find elements to further investigate the accessibility tree. This example provides a utility application which can be used to:
+
+* Pinpoint element attributes to assist during automation.
+* Allows setting of `accValue`, typically useful to test setting fields with information.
+* Allows execution of `DoDefaultAction`.
+
+
+![inspector](./docs/inspector.png)
+
+## Requirements
+
+* [stdVBA](http://github.com/sancarn/stdVBA)
+    * stdAcc
+    * stdWindow
+    * stdICallable
+* Currently only works on Windows OS
+
+## Usage
+
+Open xlsm and click launch!
+
+Move your mouse around to extract accessibility information
+
+## Roadmap
+
+* [X] Extract basic accessibility information
+* [X] Provide a button to freeze time, allowing the copy and paste of data out of the form.
+* [X] Make form topmost
+* [ ] FIXME: Slow path creation over Excel.
+* [ ] Option to highlighting the hovered accessibility element with a yellow rect created with GDI+ to help indicate which window is being inspected.
+* [ ] Display the accessibility tree in a treeview control. Navigating the tree should navigate the inspected element and navigate "hover rectangle" above - this will likely be a different project.
+
+## Known issues
+
+* Path field has currently been disabled. See roadmap.

Examples/Accessibility Inspector/docs/inspector.png

@@ -0,0 +1,113 @@
+VERSION 5.00
+Begin {C62A69F0-16DC-11CE-9E98-00AA00574A4F} AccHelper 
+   Caption         =   "Accessibility Helper"
+   ClientHeight    =   4800
+   ClientLeft      =   45
+   ClientTop       =   390
+   ClientWidth     =   4755
+   OleObjectBlob   =   "AccHelper.frx":0000
+   ShowModal       =   0   'False
+   StartUpPosition =   1  'CenterOwner
+End
+Attribute VB_Name = "AccHelper"
+Attribute VB_GlobalNameSpace = False
+Attribute VB_Creatable = False
+Attribute VB_PredeclaredId = True
+Attribute VB_Exposed = False
+'in a module
+Option Explicit
+
+Public Shown As Boolean
+
+Public Enum EInspectState
+  Permanent
+  Temporary
+End Enum
+
+Private pInspectorState As EInspectState
+Private pDisabledTime As Date
+Private oInspected As stdAcc
+
+
+
+Private Sub DoDefaultAction_Click()
+  stdWindow.CreateFromHwnd(oInspected.hwnd).Activate
+  oInspected.DoDefaultAction
+End Sub
+
+Private Sub SetValue_Click()
+  stdWindow.CreateFromHwnd(oInspected.hwnd).Activate
+  oInspected.value = InputBox("What value due you want to set it to?")
+  Call UpdateFromInspected
+End Sub
+
+Private Sub UserForm_Initialize()
+    Me.Show
+    Shown = True
+End Sub
+
+Public Sub Watch()
+  stdWindow.CreateFromIUnknown(Me).isTopmost = True
+  While Shown
+    If Inspecting.value Then
+      Set oInspected = stdAcc.CreateFromMouse()
+      Call UpdateFromInspected
+    End If
+    
+    'Handle temporary inspector
+    If pInspectorState = Temporary Then
+      Dim c: c = Now()
+      Dim timeLeft As Double: timeLeft = Round(Second(Application.Max(pDisabledTime - Now(), 0)), 1)
+      If timeLeft = 0 Then
+        Inspecting.value = False
+        pInspectorState = Permanent
+      End If
+      SecondsLeft.Caption = timeLeft
+    End If
+    
+    DoEvents
+  Wend
+End Sub
+
+Public Sub UpdateFromInspected()
+  On Error Resume Next
+  With oInspected
+    Me.crName.value = .name & "[P:" & .parent.name & "]"
+    Me.crDefaultAction.value = .DefaultAction
+    Me.crDescription.value = .Description
+    Me.crRole.value = .Role
+    Me.crStates.value = .States
+    Me.crValue.value = .value
+    Me.crLocation.value = "X: " & .Location!left & " Y: " & .Location!top & " W: " & .Location!width & " H: " & .Location!height
+    Me.crHWND.value = .hwnd
+    With stdWindow.CreateFromHwnd(.hwnd)
+      If .Exists Then
+        Me.crAppName.value = .ProcessName
+        Me.crWindowClass.value = .Class
+      End If
+    End With
+    On Error Resume Next
+        'Me.crPath.value = ""
+        'Me.crPath.value = .getPath()
+    On Error GoTo 0
+  End With
+End Sub
+
+Private Sub UserForm_QueryClose(Cancel As Integer, CloseMode As Integer)
+    Shown = False
+    Unload Me
+End Sub
+
+Private Sub Enable5_Click()
+  pInspectorState = Temporary
+  pDisabledTime = Now() + TimeSerial(0, 0, 5)
+  Inspecting.value = True
+End Sub
+Private Sub Inspecting_MouseDown(ByVal Button As Integer, ByVal Shift As Integer, ByVal x As Single, ByVal y As Single)
+  pInspectorState = Permanent
+End Sub
+
+Private Sub UserForm_Terminate()
+    Unload Me
+End Sub
+

Examples/Accessibility Inspector/src/AccHelper.frm

@@ -0,0 +1,5 @@
+Attribute VB_Name = "LaunchInspect"
+Sub Launch()
+    Call AccHelper.Show
+    Call AccHelper.Watch
+End Sub

Examples/Accessibility Inspector/src/AccHelper.frx

@@ -1,3 +1,10 @@
+<!--
+    {
+        "description": "Automate the web with Chrome",
+        "tags":["web", "automation", "accessibility"],
+        "deps":["stdAcc", "stdEnumerator", "stdLambda", "stdProcess", "stdWindow", "stdICallable"]
+    }
+-->
 # Browser Automation with stdVBA
 
 On 15th June 2022, Internet explorer officially retires as an application. It is uncertain what will happen when this occurs, however many users of VBA rely heavily on Internet Explorer to automate web reports etc. 

Examples/Accessibility Inspector/src/LaunchInspect.bas

@@ -1,10 +1,14 @@
-# TextBoxEx for VBA UserForms
-
-Split the screen into 2 halves. The left half should contain the excel window. The right half should contain a browser window of your choosing
-
-
+<!--
+    {
+        "description": "Split windows side by side",
+        "tags":["window", "automation"],
+        "deps":["stdLambda", "stdWindow", "stdICallable"]
+    }
+-->
 
+# Excel and Browser side-by-side
 
+Split the screen into 2 halves. The left half should contain the excel window. The right half should contain a browser window of your choosing
 
 ## Requirements
 
@@ -29,5 +33,3 @@ End Sub
 With `stdVBA` we've trimmed our solution down to 162 lines to about 62. `stdVBA` helps you cut down on boiler plate and helps you focus on the important questions like "How do I move my window" rather than "How do I get the caption text of a window?".
 
 ![comparison](docs/comparison.png)
-
-

Examples/Various/BrowserAutomation/examples/ArcGISOnlinePublisher.bas renamed to Examples/BrowserAutomation/Examples/ArcGISOnlinePublisher.bas

@@ -1,3 +1,11 @@
+<!--
+    {
+        "description": "Embed Microsoft Word into a userform",
+        "tags":["ui", "window", "automation", "embedding"],
+        "deps":["stdLambda", "stdWindow", "stdICallable", "stdProcess"]
+    }
+-->
+
 # TextBoxEx for VBA UserForms
 
 This is a text box control which uses a Microsoft Word instance as a userform control. This control offers all the features you get in word, critically **spell checking**.

Examples/Various/BrowserAutomation/README.md renamed to Examples/BrowserAutomation/README.md

@@ -0,0 +1,13 @@
+
+# `stdVBA` Examples
+
+This repository holds examples of using `stdVBA`. This should give people a better idea of how to use `stdVBA` and libraries.
+
+## Contents
+
+| Title | Tags | Dependencies |
+|-------|------|--------------|
+|[Accessibility Inspector](examples/Accessibility%20Inspector)|ui, window, automation, embedding|stdAcc, stdProcess, stdWindow, stdICallable|
+|[Automate the web with Chrome](examples/BrowserAutomation)|web, automation, accessibility|stdAcc, stdEnumerator, stdLambda, stdProcess, stdWindow, stdICallable|
+|[Split windows side by side](examples/SplitSideBySide)|window, automation|stdLambda, stdWindow, stdICallable|
+|[Embed Microsoft Word into a userform](examples/uiTextBoxEx-WordControl)|ui, window, automation, embedding|stdLambda, stdWindow, stdICallable, stdProcess|