GenerallyPositive.Browser.Browser Class Reference

Browser object that contains the fluent methods to create your Browser workflow.
Instatiated using GPAL.Browser. More...

Inheritance diagram for GenerallyPositive.Browser.Browser:

Public Member Functions
delegate CallIfStatus	CallIfDelegate (IBrowser browser, List< IGPALElement > foundElements, List< IGPALElement > matchedElements, Selector selector, bool matchedAll)
	Delegate callback for the CallIfFound/CallIfNotFound EventHandlers which will be invoked when a selector is found/not found CallIf handlers may be defined at two levels: At each selector or for a Unit of Work (UOW) [will be invoked for each Selector in the UOW] A UOW is defined as all Selectors between actions (first action is Goto) More than one callback handler can be defined and subsequent handlers will only be invoked based upon return code values.
delegate CallIfStatus	CallAfterFillInDelegate (IBrowser browser, IGPALGrid< string > tokens, int tokenIdx)
	Delegate callback for the CallAfterFillIn EventHandler which will be invoked after each row of tokens is consumed. Invoked whenever FillInFrom/FilllInFromDatabase/FillInFrom are used.
delegate CallIfStatus	CallAfterFetchDelegate (IBrowser browser, List< string > results, IGPALGrid< string > tokens, int tokenIdx)
	Delegate callback for the CallAfterFetch handler declared on a GPALRequest, invoked after each row of tokens has been fetched, with every page that row produced. Invoked whenever .Fetch is used, once even when there is no token source.
delegate CallIfStatus	CallOnFailDelegate (IBrowser browser, GPALFailure failure, string detail)
	Delegate for the CallOnFail handler, invoked when something fails that the workflow, rather than GPAL, is in a position to decide about. GPAL fails forward: it reports what happened and keeps going, so a handler is how a workflow takes a different decision. Return NotHandled and everything proceeds exactly as it would without a handler, Handled to say the workflow dealt with it, or Terminate to end the run.
IBrowser	ToGPALObject ()
	Return a GPAL.Browser object so that GPAL.Browser does not have to be cast.
IAllowBrowserSettingsOrGoTo	WithDriverLocation (string directory)
	Specifies the location where the browser driver executable is loaded from. Default location is the directory with the GPAL executable.
IAllowBrowserSettingsOrGoTo	WithUseDirectDownload (bool trueFalse)
	For use with .RightClickAndDownload, use websockets to directly download what the webelement references.
IAllowBrowserSettingsOrGoTo	WithDownloadTimeoutInSec (int seconds)
	Sets the maximum time to wait for a download to complete.
IAllowBrowserSettingsOrGoTo	WithDownloadLocation (string directory)
	Specifies the download location for this browser sessions, overrides the default.
IAllowBrowserSettingsOrGoTo	WithBlockPopUps (bool blockPopUp)
	Specifies whether to block popups in the browser.
IAllowBrowserSettingsOrGoTo	WithHiddenDesktop (bool hiddenDesktop)
	Run the browser on a Win32 desktop object of its own: a real window, real rendering, no headless fingerprint, on a desktop nobody is looking at. The machine stays usable while the workflow runs. NOTE: naming no desktop gets this browser one of its own that nothing else will be given. Sharing a desktop is what WithHiddenDesktop(string) is for. NOTE: this is not a Windows virtual desktop (Win+Tab). Those group windows within the one desktop and isolate nothing. NOTE: SendInput only reaches the desktop the user is on, so a hardware engine cannot drive a browser here. One asked for anyway steps down to the protocol engine of its own family, and the browser says which engine it settled on.
IAllowBrowserSettingsOrGoTo	WithHiddenDesktop (string desktopName)
	Run the browser on the named Win32 desktop object. Browsers naming the same desktop share it, and browsers naming different ones get one each, so three browsers on one desktop and three browsers on three desktops are the same call with different names. NOTE: everything WithHiddenDesktop(bool) says applies here too, hardware engines included.
IAllowBrowserSettingsOrGoTo	WithBrowserType (BrowserType browserType)
	Specify which browser to run the workflow in. NOTE: Chrome and Edge act mostly the same, Firefox has some behavioral differences. For all browsers, GPAL handles any differences for you. Of particular note is topping the browser window with Firefox requires a hardware click.
IAllowBrowserSettingsOrGoTo	WithOverwriteExistingFile (bool overwriteFile)
	Overwrite the destination file locally when downloading. If set to false, filenames will have a date timestamp appended to make each filename unique. Used with .LeftClickAndDownload(filename) and .RightClickAndDownload(filename).
IAllowBrowserSettingsOrGoTo	WithLoadImages (bool loadImages)
	Determine whether to show images on a webpage. .
IAllowBrowserSettingsOrGoTo	WithScrollIntoView (bool trueFalse=true)
	Scroll each scraped element into view as it is read, so the page visibly follows the workflow. This is for watching a run, not for correctness: GPAL reads elements whether or not they are on screen. Ignored in headless, where there is nothing to watch, and skipped for GPALElement matches, which have no place on the page to scroll to.
IAllowBrowserSettingsOrGoTo	WithPromptForDownload (bool promptForDownload)
	Set to true to always display the SAVE AS dialog box when downloading a file. Very useful with LeftClickAndDownload(filename). When set, every download will prompt you with the SAVE AS dialog, forcing you to fill in the filename. For maximum ease You can use .LeftClickAndDownload(filename) or write GPAL code like this (example) .LeftClick().WaitForWindowRegex("([sSaAvVeE])\w+*).SendString(filename).SendKey(GPAL.VK_ENTER).
IAllowBrowserSettingsOrGoTo	WithOpenPDFExternally (bool openPDFExternally)
	Specifies whether the browser will render PDFs or launch an external program. .
IAllowWithHeaderOrFileActions	WithGridToSave (IGPALGrid< string > inputGrid)
	Specifies a GPALGrid<string> that will be subsequently saved to disk. Headers can be specified inline using .WithHeader or, if not specified, will use the Selector name as the column header. If using the Selector name as the header, the names and order of the headers are from the current UOW and the order the Selectors are defined. NOTE: Scraping data occurs when .GetGrid(optionalOutGrid) is called. An internal grid is then created in the currentUOW. This internal grid will be used in any subsequent .SaveTo[CSV|TabbedText|Text] method calls. In this case, you do not need to specify an input grid using WithGridToSave.
IAllowBrowserActionOrAnySelector	WithExistingBrowser (int port)
	Specifies the port to use to connect to an existing session from another workflow started with .WithDebugPort MUST be the same port as used when calling .WithDebugPort().
IAllowBrowserSettingsOrGoTo	WithRestApiUrl (string restApiUrl)
	Specifies the TCP port number to start the browser, but also connect to this browser session from a completely different GPAL workflow. NOTE: Mutually exclusive with Debug Pipe, DebugPipe will take precedence, if specific with DebugPort.
IAllowBrowserSettingsOrGoTo	WithUseDebugPort (int port=0xdead)
IAllowBrowserSettingsOrGoTo	WithAutomationEngine (AutomationEngine automationEngine)
	Selects which automation engine drives the browser: Selenium, OttoMagic, or one of the Puppeteer connection modes. Firefox only supports Selenium or OttoMagic.
IAllowBrowserSettingsOrGoTo	WithUseDebugPipe (bool trueFalse=false)
	Use CDP protocol over pipes, should this impply CDP because selenium doesn't support pipe, so this is all us? NOTE: Mutually exclusive with Debug Pipe, DebugPipe will take precedence, if specific with DebugPort NOTE: Firefox does not support CDP pipes.
IAllowBrowserSettingsOrGoTo	WithWaitOnDocumentReady (int timeoutInMs)
	Specifies GPAL will wait for a true in the browser DocumentReady flag before trying to locate elements. Mutally excludes WithWaitOnNetworkIdle - setting this true will set WithWaitOnNetworkIdle to false.
IAllowBrowserSettingsOrGoTo	WithNavigationGrace (int graceInMs)
	How long a click waits to see whether it started a navigation, before deciding it stayed on the page. A click returns as soon as the event is dispatched, so a slow site still reports the old url for a moment. Only clicks that navigate go on to wait for the load, which WithWaitOnDocumentReady controls. This is paid in full by every click that does not navigate, so it trades run time for not acting on a stale page.
IAllowBrowserSettingsOrGoTo	WithWaitOnIdleConnection (bool trueFalse=true)
	Specifies GPAL will wait for network to be idle on current page before trying to locate elements. Mutally excludes WithWaitOnDocumentReady - setting this true will set WithWaitOnDocumentReady to false.
IAllowNetworkIdleSettings	WithNetworkIdleTimeoutMs (int networkIdleTimeoutMs=500)
	Specifies max time in milliseconds to wait for the network idle before returning false.
IAllowNetworkIdleSettings	WithNetworkIdleMaxConnections (int maxConnections=0)
	Specifies the maximum duration to keep network stats before pruning old data.
IAllowNetworkIdleSettings	WithNetworkIdlePruneMs (int networkIdlePruneMs=3_000)
	Specifies the maximum duration to keep network stats before pruning old data The time to wait for new connections to count as open. eg, If prune is 3 seconds, if there are 9 connections and another one opens after 3 seconds, it is considered idle.
IAllowBrowserSettingsOrGoTo	WithProfileDataDirectory (string profileDataDirectory)
	Specify the profile directory to use for this browser automation session NOTE: if both Profile User Name and Profile Directory are defined, the specific directory will be used.
IAllowBrowserSettingsOrGoTo	WithProfileUserName (string profileUserName)
	Specify the operating system login username to find the profile directory to use for this browser automation session NOTE: if both Profile User Name and Profile Directory are defined, the specific directory will be used.
IAllowBrowserSettingsOrGoTo	WithProfileName (string profileName)
	Specify the profile name to use under the data directory for this browser automation session NOTE: use this if a data directory contains multiple profile directories and you do not want to use the default profile.
IAllowBrowserSettingsOrGoTo	WithUseStealth (StealthType steathType)
	Use stealth operations to block bot detection use Runtime.disable before clicking login button Add persistent script the runs before all others to inject anti-CDP detection script.
IAllowBrowserSettingsOrGoTo	WithUseReferrer (string referrer="")
	Set the refererrer to use with any Goto or Get for the rest of the browser sessions. Will only clear if you clear it explicitly with an empty string or no parameter.
IAllowBrowserSettingsOrGoTo	WithUseUserAgent (string userAgent="")
	Set the user agent to use with any Goto or Get for the rest of the browser sessions. Will only clear if you clear it explicitly with an empty string or no parameter.
IAllowBrowserSettingsOrGoTo	WithUserAgentFromBrowser (bool userAgentFromBrowser=true)
	Launch a browser purely to read its own user agent, instead of working one out without one. Headless browsers announce themselves in their user agent, so GPAL has always started a browser, read the real string, and taken the word Headless back out of it. That costs a browser launch on every headless start, and it is only worth paying when nothing better is known. Off by default, in which case the user agent comes from WithUseUserAgent if it was set, then the userAgent in gpal.yaml, then the per-browser template in gpal.yaml with the installed version filled in, which needs no browser and is what GPAL's own requests already use.
IAllowAfterAnySelector	WithSelector (Selector selector)
	Add a selector to the current UOW. Selectors make up a Unit of Work (UOW) to perform actions upon. A UOW is: All selectors defined between actions like GoTo, LeftClick, Hover, Focus, etc. Use in conjunction with the CallIf handlers to create workflows to deal with found/not found selector(s). Selectors may remove themselves from a UOW by using selector.Remove() .
IAllowAfterAnySelector	WithSelector (string literalData)
	Add literal data to a grid when using .GetGrid.
IAllowAfterAnySelector	WithSelector (Func< string > dataFunction)
	Add literal data to a grid by invoking this function when using .GetGrid.
IAllowBrowserActionOrAnySelector	ContinueAsRESTClient (out IRESTClient client)
	Carries on without the browser: hands back a RESTClient holding what this browser has, its origin, its cookies, the user agent and accept language it is really sending, and the credential it was given with .WithCredentials. The browser can be closed on the next line and the client keeps working. What does not come along is the TLS handshake, so a target that fingerprints the transport still needs .Fetch from inside the page.
IAllowStorageOutData	RunGet (WebsiteStorageType storageType)
	Reads data from browser storage (cookies, local/session storage, IndexedDB) using the domain/path/key configured by the preceding .WithStorage* calls.
IAllowBrowserActionOrAnySelector	RunSet (WebsiteStorageType storageType)
	Writes data to browser storage (cookies, local/session storage, IndexedDB) using the domain/path/key/data configured by the preceding .WithStorage* calls.
IAllowBrowserActionOrAnySelector	RunDelete (WebsiteStorageType storageType)
	Deletes data from browser storage (cookies, local/session storage, IndexedDB) using the domain/path/key configured by the preceding .WithStorage* calls.
IAllowStorageOptions	WithStorageDomain (string domain)
	Specifies the domain to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.
IAllowStorageOptions	WithStoragePath (string path)
	Specifies the path to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.
IAllowStorageOptions	WithStorageKey (string key)
	Specifies the key to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.
IAllowStorageOptions	WithStorageStoreName (string storeName)
	Specifies the IndexedDB store name to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.
IAllowStorageOptions	WithStorageData (string data)
	Specifies the data value to write for the next storage .RunSet action. Starts a new StorageAction if the previous one was already run.
IAllowStorageOptions	WithUserDefinedFilter (string userDefined)
	Specifies a user-defined filter string passed through to the storage action implementation. Starts a new StorageAction if the previous one was already run.
IAllowBrowserActionOrAnySelector	GetStorageData (out string data)
	Retrieves the data read by the most recent .RunGet storage action.
IAllowAfterAnySelector	InElement (Selector selector)
	InElement indicates the root element for following withselector element searches which would use a relative selector Example: on ebay, we could use a generic selector to get all descriptions, links, prices and images, but that assumes 1:1 correlation of the globally found items or, we can find all the result spans, then search for the description, link, price and image relative to that containing div/span/element.
IAllowAfterAnySelector	InFrame (Selector selector)
	Specify that the following .WithSelector(s) are contained in an iFrame specified by the Selector. Use .InMainDom() to get back to working with the main document.
IAllowAfterAnySelector	InShadowDom (Selector shadowDomSelector)
	Specify that the following .WithSelectors are contained in an a shadow dom specified by the Selector. Use .InMainDom() to get back to working with the main document. NOTE: can only use CSS selectors in shadow dom.
IAllowAfterAnySelector	InMainDom ()
	Specify that GPAL is no longer working in an iFram or shadow dom and reset back to the main document.
IAllowWithPagesAndGridActions	WithNextPageButton (Selector nextPageButtonselector)
	Specifies the Next Page button used to retrieve multiple pages of data. Use with .GetPages(numOfPages) to specify how to get those next pages. .GetGrid or any .SaveTo[CSV|Excel|File] will treat the current UOW as output Selectors from which to retrieve data. Retrieving data will retrieve only the current page if nothing is specified. Also useful with .WithAllThatMatch to retrieve repeating results (like on eBay) See also .WithInfiniteScroll.
IAllowGetGridAndFillInFrom	WithPages (int pageCount)
	Specified the number of pages to retrieve when using GetGrid or any .SaveTo[CSV|Excel|File] Must also specify the Next Page button [.WithNextPageButton(selector)] or Infinite scroll [.WithInfiniteScroll] to tell GPAL how to retrieve next pages. .
IAllowWithPagesAndFetch	WithTokensFrom (IGPALGrid< string > inputGrid)
	Supply the values .Fetch drops into the numbered tokens of its request, one row per set of requests. A column of the row fills the token of the same number, so the first column fills {0}, the second {1}, the same way FillInFrom hands a row of tokens to a row of inputs.
IAllowWithPagesAndFetch	WithTokensFrom (GPALFile inputFile)
IAllowWithPagesAndFetch	WithTokensFrom (GPALDatabase inputDatabase)
IAllowWithPagesAndFetch	WithTokensFrom (string tokens)
IAllowAfterAnySelector	CallAfterFillIn (Browser.CallAfterFillInDelegate callAfterFillIn)
	Add a handler to call after a row of tokens is consumed and after all inputs are filled in with data. Only one CallAfterFillIn handler exists. Use FillInFrom[Database|File|GPALGrid] to loop thru data in your main workflow and then perform next workflow steps in the CallAfter handler.
IAllowAfterAnySelector	CallIfFound (Browser.CallIfDelegate callIfFoundDelegate)
	Add a Unit of Work level CallIfFound handler to be called if any defined selectors find/match elements. This method will be called for every found selector in the current UOW. CallIf handlers can remove themselves by calling myBrowser.RemoveCallIfHandlerEverywhere(handler) Selectors may remove themselves from a UOW by using selector.Remove() More than one callback may be defined and will cascade thru the list depending upon the callback return value. See: CallIfDelegate.
IAllowAfterAnySelector	CallIfNotFound (Browser.CallIfDelegate callIfNotFound)
	Add a Unit of Work level CallIfNotFound handler to be called if any defined selectors DO NOT find/match elements. This method will be called for every NOT FOUND selector in the current UOW. CallIf handlers can remove themselve by calling myBrowser.RemoveCallIfHandlerEverywhere(handler) Selectors may remove themselves from a UOW by using selector.Remove() More than one callback may be defined and will cascade thru the list depending upon the callback return value. See: CallIfDelegate.
IAllowAfterWaitForAndSizeControl	WithWaitForWindowTimeout (int waitTimeInSeconds)
	Define the time in seconds to WaitForWindow/Regex.
IAllowBrowserSettingsOrGoTo	PersistentCallIfFound (CallIfDelegate persistentCallIfFound)
	Add a persistent CallIfFound handler to be called if any defined persistent selectors find/match elements. Persistent selectors are always looked for before every action cross-cutting your workflow. Persistent handlers can remove themselves in the CallIfHandler by calling myApplication.RemoveCallIfHandlerEverywhere(handler) More than one callback may be defined and will cascade thru the list depending upon the callback return value. See: CallIfDelegate.
IAllowBrowserSettingsOrGoTo	PersistentCallIfNotFound (CallIfDelegate persistentCallIfNotFound)
	Add a persistent CallIfNotFound handler to be called if any defined persistent selectors DO NOT find/match elements. Persistent selectors are always looked for before every action cross-cutting your workflow. Persistent handlers can remove themselves in the CallIfHandler by calling myApplication.RemoveCallIfHandlerEverywhere(handler) More than one callback may be defined and will cascade thru the list depending upon the callback return value. See: CallIfDelegate.
IAllowBrowserSettingsOrGoTo	WithCredentials (ICredentials credentials)
	Add a handler to be called when something fails on this browser that the workflow is in a position to decide about, a navigation that never loaded a page being the case that exists today. GPAL fails forward, so without a handler the failure is reported and the run carries on, which for a dead page means the selectors find nothing and the CallIfNotFound handlers fire. A handler is how a workflow takes a different decision: retry the url, go somewhere else, or terminate. A browser with no handler of its own falls through to GPAL.CallOnFail, so several workflows can share one handler and tell themselves apart by the browser they are handed.
IAllowBrowserSettingsOrGoTo	CallOnFail (CallOnFailDelegate callOnFail)
IAllowSelectorInFrameBrowserSettingsOrGoto	WithPersistentSelector (Selector selector)
	Add a persistent selector to the persistent UOW. Persistent selectors are always looked for whenever you perform an action on a UOW, like LeftClick, Hover, Focus, etc. Use in conjunction with the PersistentCallIf handlers to create workflows to deal with the persistent selector(s). Selectors may remove themselves from a UOW by using selector.Remove() Only one persistent Unit of Work exists. All selectors are evaluated in the order they are defined. Example: For browser, a persistent selector could look for a popup panel like 'Accept all cookies' that displays on all pages and may block processing.. NOTE: persisten selectors are only looked for in content/frame 0 as they are designed to deal with page popups eminating from base content. Use workflows to deal with elements in frames.
IAllowWithHeaderOrFileActions	WithHeader (string header)
	Specify a column header for output. Headers are output in order defined.
IAllowAfterAnySelectorExceptWithAll	WithAllThatMatch (int rowCount=int.MaxValue)
	Indicates the Selectors refer to/match repeating, multiple elements on the page. Use after all your .WithSelector statements. Used two ways. For scraping: This is used to retrieve multiple rows of data from the webpage, up to rowCount. For input tokens/strings: This will repeat the same input into multiple elements, up to rowCount of lines. NOTE: if called before any.
IAllowAllBrowserAndAllSelector	WithWindowSize (Rectangle windowSize)
	Set the default window size for when the browser opens. As well, exiting fullscreen will return to this size. IF NOT SET: 'Normal' to restore the window will restore the window to the Size before enterinng fullscreen.
IAllowBrowserSettingsOrGoTo	WithObeyRobotsTxt (bool trueFalse=false)
	Set whether to deny navigating to webpage if denied by robots.txt.
IAllowBrowserSettingsOrGoTo	WithRespectRobotMetaTags (bool trueFalse=false)
	Set whether to respect robots-related meta tags (e.g. noindex/nofollow) on the page.
IAllowBrowserActionOrAnySelector	Get (GPALUrl URL)
	Navigate to the URL specified in headless mode. If no headless browser is open, one will be launched. If using an already open browser, navigate in the current tab. Use .WithNewTab before .Get to navigate on a new tab.
IAllowBrowserActionOrAnySelector	GoTo (GPALUrl URL)
	Navigate to the URL specified. If no browser is open, one will be launched. If using an already open browser, navigate in the current tab. Use .WithNewTab before .GoTo to navigate on a new tab.
IAllowBrowserActionOrAnySelector	CloseTab (dynamic URLorTabId=null)
	Close the current in focus, active tab.
IAllowBrowserActionOrAnySelector	NewTab (GPALUrl url)
	Used to specify the next GoTo command should open in a new tab. The new tab is then the active tab. Use .NextTab and .PreviousTab to navigate tabs. NOTE: Applies only once. Use .WithNewTab before each .GoTo to open in a new tab.
IAllowBrowserActionOrAnySelector	LeftClick ()
	Left click the element found for Selector(s) defined in the UOW One left click for the first element found for each selector. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	LeftClick (ModifierKeys modifierKeys)
	Left click the element found for Selector(s) defined in the UOW One left click for each element found for selector. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	LeftClick (Selector selector)
	Left click the element(s) found for Selector parameter, creates a UOW of 1 element One left click w/ no modiofiers pressed for each element found for the selector. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	SelectClick (SelectClickType selectClickType)
	Clicks the option element(s) found for the current selector(s) using the given select-click behavior (e.g. RandomSelect, SequentialSelect).
IAllowBrowserActionOrAnySelector	StealthLeftClick (Selector selector)
IAllowBrowserActionOrAnySelector	LeftDoubleClick ()
	Left double click the element found for Selector(s) defined in the UOW One left click for each element found for each selector. Should probably be used with only one Selector in the UOW. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	MiddleClick ()
	Midle click the element found for Selector(s) defined in the UOW One middle click for each element found for each selector. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	RightClick (Selector selector=null)
	Right click the element found for Selector(s) defined in the UOW One right click for the first element found for each selector. Should probably be used with only one Selector in the UOW. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	LeftClickAndDownload (GPALFile gPalFileToDownloadTo)
	Left clicks the element(s) found for the current selector(s) and downloads the resulting file to gPalFileToDownloadTo .
IAllowBrowserActionOrAnySelector	LeftClickAndUpload (GPALFile gPalFileToUpload)
	Left click the input[type=file] or custom control button Headful - enter filename in open file dialog Headless - selenium and puppeteer can use CDP top populate files, OttoMagic requires the native app to stream the file to the browser...
IAllowBrowserActionOrAnySelector	RightClickAndDownload (GPALFile filenames)
	Right click the element(s) found for Selector(s) defined in the UOW, select 'Save as...', wait for the SAVE AS dialog, enter the filename and save the file. The saved filename is then added to the end of the filename list. Useful if files are not overwritten. One right click for the first element found for each selector. Should probably be used with only one Selector in the UOW. If .WithAllThatMatch is defined on the current UOW, then a right click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	AppendFrom (GPALDatabase inputDatabase)
	Append data from the database to the end of any input Selectors defined in the UOW One token (one column in the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	InsertFrom (GPALDatabase inputDatabase)
	Insert the text from the database at the beginning of the input Selector(s) defined in the UOW One token (one column in the current row) per input/element found. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	FillInFrom (GPALDatabase inputDatabase)
	FillIn data from the database overwriting text in the input Selector(s) defined in the UOW One token (one column in the current row) per input/element found. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	AppendFrom (GPALFile inputFile)
	Append the data from the input file to the end of any input Selectors defined in the UOW One token (one string [between commas] from the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	FillInFrom (GPALFile inputFile)
	FillIn data from the file overwriting text in the input Selector(s) defined in the UOW One token (one string [between commas] from the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	InsertFrom (GPALFile inputFile)
	Insert the data from the file at the beginning of the text in the input Selector(s) defined in the UOW One token (one string [between commas] from the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	AppendFrom (IGPALGrid< string > inputGrid)
	Append the data from the input grid to the end of any input Selectors defined in the UOW One token (one string from the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then this token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	FillInFrom (IGPALGrid< string > inputGrid)
	FillIn data from the grid overwriting text in the input Selector(s) defined in the UOW One token (one string from the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then this token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	InsertFrom (IGPALGrid< string > inputGrid)
	Insert the data from the grid at the beginning of the text in the input Selector(s) defined in the UOW One token (one string from the current row) per input. Inputs are filled by tokens in the order they are both declared. If .WithAllThatMatch is defined on the current UOW, then this token is entered into {num} inputs that matches the corresponding Selector in the current UOW. If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.
IAllowBrowserActionOrAnySelector	AppendFrom (string text)
	Append the given text to the first input in the UOW. Should probably only be used with one selector at a time. If .WithAllThatMatch is defined on the current UOW, then this text is entered into {num} inputs that matches the Selector(s) in the current UOW.
IAllowBrowserActionOrAnySelector	FillInFrom (string text)
	Overwrite all text in the first input in the UOW. Should probably only be used with one selector at a time. If .WithAllThatMatch is defined on the current UOW, then this text is entered into {num} inputs that matches the Selector(s) in the current UOW.
IAllowBrowserActionOrAnySelector	InsertFrom (string textToUse)
	Insert text at the beginning of the first input in the UOW. Should probably only be used with one selector at a time. Example: If three inputs are defined and three 'InsertFrom' are defined, then the text is assigned to the same ordinal input element found via the Selector(s) If .WithAllThatMatch is defined on the current UOW, then this text is entered into {num} inputs that matches the corresponding Selector(s) in the current UOW.
IAllowBrowserActionOrAnySelector	Focus (Selector selector)
	Focus the current element found via the Selector. Only the first element per Selector found will be focused. IF using hardwre emulation (.WithHardware) for this selector, for text inputs, focus is a click in the control. Otherwise, hardware emulation hovers the mouse over the control. If .WithAllThatMatch is defined on the current UOW, then focus will interate over {num} elements that matches the Selector(s) in the current UOW.
IAllowBrowserActionOrAnySelector	Hide (Selector selector=null)
	Hides the element(s) found for selector (or the current selector(s) if none is given) by setting their CSS display to none.
IAllowSetAttributeValue	WithAttribute (string attribute)
	Names the DOM attribute to set on the current selector(s). Must be followed by SetAttribute(string) to supply the value and complete the action. See IAllowSetAttributeValue.SetAttribute for the distinction between this and SendString/FillIn*.
IAllowBrowserActionOrAnySelector	SetAttribute (string value)
	Assigns value to the attribute named by the preceding WithAttribute call, completing the SetAttribute action.
IAllowBrowserActionOrAnySelector	SetValueFrom (Selector selector)
	Sets the value of the element(s) matched by the preceding WithSelector call from the value of the element matched by selector , i.e. destElement.value = srcElement.value. Uses OttoMagic, Puppeteer or JavaScript depending on the active engine, and fires "input"/"change" events on the destination so the page reacts to the new value.
IAllowBrowserActionOrAnySelector	Hover (Selector selector=null)
	Fluent alias for MoveTo(Selector). Moving the mouse to an element is a real input-layer event on every engine, so the browser naturally updates CSS :hover state and fires mouseenter/mouseover/mouseleave - this is what reveals hover-triggered menus and tooltips. There is no separate "hover" operation; Hover exists only because it's the more discoverable name for this intent.
IAllowBrowserActionOrAnySelector	MoveTo (Selector selector=null)
	Moves the mouse to the current element found via the Selector. Only the first element per Selector found will be 'moved to'. IF using hardwre emulation (.WithHardware) for this selector, the mouse is moved to hover over the control. If .WithAllThatMatch is defined on the current UOW, then MoveTo will move the mouse over {num} elements that matches the Selector(s) in the current UOW. How and where on the page an element is moved to differs depending upon the technique: Hardware, OttoMagic, Puppeteer or Selenium all perform a real cursor move (triggering CSS :hover and mouseover/mouseenter/mouseleave). As a last resort, when no real cursor is available (e.g. plain Selenium in headless mode), a synthetic "mouseover" event is dispatched via JavaScript - this only fires JS mouseover listeners and does NOT trigger CSS :hover.
IAllowBrowserActionOrAnySelector	StartWorkflow ()
	Start a workflow to invoke CallIf handlers (if no other action is being used in the workflow) A LeftClick, Hover, GetGrid, SaveTo. FillIn and other actions will all start the workflow. Sometimes your Unit of Work (UOW) consists of finding one repeating element, then chaining to a CallIfFound handler. StartWorkflow will kick off looking for your UOW selectors. NOTE: Only call this if you have not called another action. Any prior action will start the workflow and this will be ignored if used. But if you have not called an action, you can use .StartWorkflow to kick off the workflow which will invoke your CallIf handlers.
IAllowBrowserActionOrAnySelector	GetElements (out List< GPALElement > elements)
IAllowWithHeaderOrFileActions	GetGrid (ref IGPALGrid< string > returnGrid)
	Retrieve the current UOW selectors data into a <string> of columns and rows to use with GPAL or however you want. using GenerallyPositive.Common;.
IAllowCallTemplate	WithCallFilter (string urlFragment)
	Save the retrieved grid. The output format and delimiter are determined by the GPALFile (its extension, e.g. .csv/.tsv/.txt/.xlsx/.json, or its explicit file settings). The single save syntax; the output format and delimiter come from the GPALFile.
IAllowBrowserActionOrAnySelector	CaptureCallTemplate (out GPALRequest template)
	Waits for the page to make a call the filter matches, then hands it back as a request ready to issue. This is how a workflow carries a value it cannot know: a token minted per session, a signed parameter, a header the page's own code adds. Nothing is pasted and nothing goes stale, because the template is taken from the run that is happening. The last match wins, since a page that calls an endpoint more than once has settled by the last one. Hands back null when nothing matched in time, so the workflow decides what that means.
IAllowBrowserActionOrAnySelector	CaptureCalls (bool capture=true)
IAllowBrowserActionOrAnySelector	CaptureCalls (out List< GPALCall > calls)
	Records what the page asks for and hands back everything recorded so far, so an endpoint can be read off a site rather than guessed at. Say it before going anywhere and say it again whenever you want what has happened since. Each call hands back its own list, so a workflow reading one is never reading what the browser is still writing.
IAllowBrowserActionOrAnySelector	ClearCapturedCalls ()
	Forgets everything recorded so far, so what is captured next is what happened next. Recording carries on, and what was already handed back to a workflow is untouched.
IAllowWithHeaderOrFileActions	Fetch (GPALRequest request)
IAllowBrowserActionOrAnySelector	SaveTo (ref string data)
	Hand back what .Fetch retrieved, as a JSON array holding one response body per page requested, so a single page and twenty pages come out in the same shape.
IAllowBrowserActionOrAnySelector	SaveTo (GPALFile file)
IAllowBrowserActionOrAnySelector	AppendTo (GPALFile file)
	Append the retrieved grid. The output format and delimiter are determined by the GPALFile (its extension or explicit file settings). Headers are not repeated on append.
IAllowAfterWaitFor	WaitFor (WaitTime waitForTimeInMs)
	Either wait the amount of time specified or wait UP TO the amount of time specified waiting for elements to be found for the Selector(s) in the current UOW. If an action has already been called, then this is interpretted as a sleep for the specified miliseconds. If only selectors have been defined in the current UOW, then this is a delay waiting for the selectors to be present before continuing with the workflow. Waiting for elements does not guarantee they will be present when the workflow continues. If they are not present, the CallIfNotFound handler will be invoked so you can deal with that. NOTE: WaitFor is not considered an action, if defines a time to wait for elements to be present before trying to perform actions.
IAllowAfterWaitFor	WaitFor (Selector waitForSelector)
	Wait for the specified elements(s) defined by withForSelector to be present and defined on-page.
IAllowAfterWaitFor	WaitFor (ElementState elementState)
	Waitfor an element to eneter the specified state. This is an action.
IAllowAfterWaitForAndSizeControl	WaitForWindow (string waitForTitle)
	Wait for a Windows window with title to appear on the desktop. Used in conjunction with .WithWaitForWindowTimeout to set the wait duration in seconds. .
IAllowAfterWaitForAndSizeControl	WaitForWindowRegex (string waitForTitleRegex)
	Wait for a Windows window with title that matches the regex pattern to appear on the desktop. Used in conjunction with .WithWaitForWindowTimeout to set the wait duration in seconds. .
IAllowBrowserActionOrAnySelector	WithPageOrientation (PageOrientation pageOrientation)
	Sets the page orientation (Portrait/Landscape) used by PrintToPDF.
IAllowBrowserActionOrAnySelector	PrintToPDF (GPALFile gpalFile)
	Prints the current selector's element (or the whole page if no selector is set) to a PDF file.
IAllowBrowserActionOrAnySelector	SendString (string textToSend)
	Type in the literal string provided. NOTE: If you press SHIFT then SendString a mixed-case string, SHIFT will be released. To send ALL CAPS, press SHIFT then send an all lowercase string.
IAllowBrowserActionOrAnySelector	PressModifierKey (ModifierKeys modifierKeys)
	Press the specified modifer keys (can be ORd) NOTE: If you SendString a mixed case string, the SHIFT key will be released if it is pressed.
IAllowBrowserActionOrAnySelector	ReleaseModifierKey (ModifierKeys modifierKeys)
	Release the specified modifer keys (can be ORd) NOTE: If you SendString a mixed case string, the SHIFT key will be released if it is pressed.
IAllowBrowserActionOrAnySelector	SendKey (byte VKCode)
	Type special characters like Enter, Page Up, Page Down, Tab, etc. Use GPAL.VK constants for ease of access to commmon keys. For all Virtual Keycodes, visit: https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes.
IAllowBrowserActionOrAnySelector	ScrollWindowByHorizontal (int scrollAmountInPixels)
	Scroll the browser window horizontally the number of pixels. Negative numbers scroll left. JavaScript only.
IAllowBrowserActionOrAnySelector	ScrollWindowByVertical (int scrollAmountInPixels)
	Scroll the browser window horizontally the number of pixels. Negative numbers scroll up. JavaScript only.
IAllowBrowserActionOrAnySelector	ScrollElementHorizontalByPixels (int scrollAmountInPixels)
	Scroll the element horizontally by number of pixels. Negative numbers scroll left. JavaScript only.
IAllowBrowserActionOrAnySelector	ScrollElementVerticalByPixels (int scrollAmountInPixels)
	Scroll the element vertically by number of pixels. Negative numbers scroll up. JavaScript only.
IAllowBrowserActionOrAnySelector	GoToTab (dynamic URLorTabTuple=null)
	Goto the tab with the specified URL If using OttoMagic, you can use the tabid from browser.BrowserSettings.TabIds[tabid] search for matching URL.
IAllowBrowserActionOrAnySelector	DragAndDrop (ModifierKeys modifierKeys)
	Left click the element found for Selector(s) defined in the UOW One left click for the first element found for each selector. If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW. .
IAllowBrowserActionOrAnySelector	DragAndDrop (Selector selector=null)
	Drags the element(s) found for selector (or the current selector(s) if none is given) by the selector's DeltaX/DeltaY.
IAllowBrowserActionOrAnySelector	ExecuteJavaScriptObj (string javascript)
	Executes JavaScript in the browser and stores the raw result object in JavaScriptResultObj.
IAllowBrowserActionOrAnySelector	ExecuteJavaScriptStr (string javascript)
	Executes JavaScript in the browser and stores the result as a string in JavaScriptResultStr.
IAllowBrowserActionOrAnySelector	WithDialogsAccepted (bool accept)
	Answers the alert, confirm and prompt dialogs the page raises instead of letting them open and stop everything until somebody clicks. True is OK, and confirm reads true; false is Cancel, and confirm reads false. Not calling this leaves dialogs alone, so they open and block the way they would for a person. Selenium and Puppeteer answer them at the browser: the driver does it as a capability and Puppeteer over CDP, and the page's own alert, confirm and prompt are untouched, so nothing about it is visible to the page. OttoMagic cannot do that, because an open dialog stops the page thread the extension talks through, so there GPAL replaces those three functions before the page runs and no dialog is ever raised. That replacement is the one thing here a page could notice, which is why it is only done on the engine that has no other way.
IAllowBrowserActionOrAnySelector	WithDialogText (string text)
	What a prompt hands back when dialogs are accepted. Left unsaid, the prompt's own default stands.
IAllowBrowserActionOrAnySelector	ClearDialogHandling ()
	Stops answering dialogs, so they open and block again the way they would for a person. This is the opposite of WithDialogsAccepted(bool) rather than the false half of it: false is still answering, with Cancel. Puppeteer stops at once. On OttoMagic the three functions stay replaced, because a script cannot be unregistered one at a time, but they hand every call straight to the real one, so the page behaves as it would untouched. To take them off altogether, ClearInjectedScripts and navigate. Selenium cannot stop: the driver was started with the capability and keeps it until it closes.
IAllowBrowserActionOrAnySelector	GetWindowRectangle (out Rectangle window)
	Where this browser's window is and how big it is, in screen coordinates, with its chrome included. Every engine answers it. Puppeteer asks the browser itself over CDP, which needs no page and works while one is still loading. Selenium and OttoMagic ask the page for its screen position and its outer size. A window that cannot be measured either way comes back empty rather than guessed at.
IAllowBrowserActionOrAnySelector	InjectScript (string script)
	Registers a script (raw JS string) to run on every new document load. Callable before the first .GoTo()/.Get() (active from the first page load) or at any later point (applies to subsequent navigations). Persists until ClearInjectedScripts is called.
IAllowBrowserActionOrAnySelector	InjectScript (GPALFile scriptFile)
	Registers script(s) loaded from scriptFile to run on every new document load - if multiple filenames are specified (e.g. via wildcard), all are loaded and injected as separate scripts. Persists until ClearInjectedScripts is called.
IAllowBrowserActionOrAnySelector	ClearInjectedScripts ()
	Removes all scripts previously registered via InjectScript(string) or InjectScript(GPALFile).
IAllowBrowserActionOrAnySelector	SetRange (int rangeValue)
	Sets the value of a range/slider input element matched by the current selector(s) by scrolling it into view and setting its value to rangeValue .
void	Close (bool killWebDrivers=false)
	Close/terminate the browser. This terminates the fluent browser workflow and nothing can be chained to this command. NOTE: If you are ending your application, pass in true to kill all running web drivers.
void	RemoveCallIfHandlerEverywhere (CallIfDelegate func)
bool	IsEndOfPage ()
	Helper method to check whether the current page is at the bottom.
IAllowBrowserActionOrAnySelector	OpenWindow (GPALUrl URL)
	Opens a new browser tab/window navigated to URL and switches focus to it.
IAllowBrowserActionOrAnySelector	GoToWindow (dynamic urlOrId)
	Switches focus to the browser tab/window matching the given URL or window/tab id.
IAllowBrowserActionOrAnySelector	CloseWindow (dynamic urlOrId=null)
	Closes the current browser tab/window, or the one matching the given URL or window/tab id, and switches focus to the next available window.
IAllowBrowserActionOrAnySelector	Run ()
	Runs the workflows added via WithWorkflow against this browser, in the order they were added. To give each workflow a browser of its own and run several at once, see GPAL.Workflow.
IAllowWorkflowExecution	WithWorkflow (Action< IBrowser > workflow)
	Adds a workflow to run against this browser, used with Run, While and Until(Selector). Workflows run in the order they were added, one after another, and the browser handed to each is this one.
IAllowWorkflowExecution	WhileLoopTimeout (int timeoutMs)
	Sets the maximum amount of time a While/Until loop is allowed to run before it is aborted.
IAllowWorkflowExecution	WhileLoopMaxIterations (int maxIterations)
	Sets the maximum number of iterations a While/Until loop is allowed to run before it is aborted.
IAllowBrowserActionOrAnySelector	While (Func< Browser, bool > predicate)
	Repeats the workflow added via WithWorkflow for as long as the given predicate returns true, subject to WhileLoopTimeout and WhileLoopMaxIterations.
IAllowBrowserActionOrAnySelector	Until (Selector selector)
	Repeats the workflow added via WithWorkflow until the given selector matches an element on the page, subject to WhileLoopTimeout and WhileLoopMaxIterations.
IAllowBrowserActionOrAnySelector	Until (Func< Browser, bool > predicate)
	Repeats the workflow added via WithWorkflow until the given predicate returns true, subject to WhileLoopTimeout and WhileLoopMaxIterations.
IAllowBrowserActionOrAnySelector	GetHydratedData (out NextJsHydrationResult hydrationResult)
	Extracts Next.js hydration data (e.g. NEXT_DATA) embedded in the current page's HTML.
IAllowBrowserActionOrAnySelector	SaveHydratedData (GPALFile hydrationFile)
	Extracts Next.js hydration data (e.g. NEXT_DATA) from the current page and saves it to a file.
IAllowBrowserActionOrAnySelector	GetLLMDigest (out LLMDigestResult digestResult, string ruleSetName=null)
	Converts the current page's HTML into an LLM-optimized markdown digest.
IAllowBrowserActionOrAnySelector	SaveLLMDigest (GPALFile llmDigestFile, string ruleSetName=null)
	Converts the current page's HTML into an LLM-optimized markdown digest and saves it to a file.
IAllowBrowserActionOrAnySelector	GetPageSource (out string pageSource)
	Gets the current page's HTML source, cleaned of escape sequences and control characters.
IAllowBrowserActionOrAnySelector	GetSiteMap (out string sitemapXML)
	Gets the raw XML/source of the current page, intended for use when the current page is itself a sitemap.
IAllowBrowserActionOrAnySelector	ClearResultCache ()
	Clears the cached sitemap / LLM digest / hydration results for this browser, forcing the next Get*‍/Save* to re-walk or re-fetch instead of reusing an earlier result.
IAllowBrowserActionOrAnySelector	GetSiteMapUrls (out List< string > sitemapUrls)
	Discovers and walks the site's sitemap(s) (via robots.txt, the current page, or heuristic detection), extracting all URLs found, then returns to the original page.
IAllowBrowserActionOrAnySelector	SaveSiteMapUrls (GPALFile sitemapUrlsFile)
	Discovers and walks the site's sitemap(s), then saves the extracted URLs to a file. The output format (csv, txt, json, yaml, xml, ...) is chosen from the file extension by the converter, so one call turns a crawl into whatever downstream format you need.
IAllowBrowserActionOrAnySelector	CastTab (string sinkName)
	Casts (mirrors) the current browser tab to the named cast sink (e.g. a Chromecast device). Supported via Puppeteer and Selenium; not available via OttoMagic.
IAllowBrowserActionOrAnySelector	CastDesktop (string sinkName)
	Casts (mirrors) the entire desktop to the named cast sink (e.g. a Chromecast device). Supported via Puppeteer and Selenium; not available via OttoMagic.
IAllowBrowserActionOrAnySelector	StopCasting ()
	Stops any active cast (tab or desktop mirroring) started via CastTab or CastDesktop.
Public Member Functions inherited from GenerallyPositive.Browser.IAllowBrowserSettings
IAllowBrowserSettingsOrGoTo	WithDriverLocation ([Directory(Description="Location of browser driver for this instance. [./ (default)(same dir as exe)]")] string driverPath)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowSizeControl
IAllowAllBrowserAndAllSelector	WithWindowSize (System.Drawing.Rectangle windowSize)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowPersistentCallBack
IAllowBrowserSettingsOrGoTo	PersistentCallIfFound (Browser.CallIfDelegate CallIfFound)
IAllowBrowserSettingsOrGoTo	PersistentCallIfNotFound (Browser.CallIfDelegate CallIfNotFound)
IAllowBrowserSettingsOrGoTo	CallOnFail (Browser.CallOnFailDelegate CallOnFail)
Public Member Functions inherited from GenerallyPositive.Browser.IAllowGetWindowRectangle
IAllowBrowserActionOrAnySelector	GetWindowRectangle (out System.Drawing.Rectangle window)

Properties
int	CurrentTabIdx = 0 [get, set]
	Index of the currently active browser tab/window.
bool	AreRobotsAllowed [get, set]
	True if the current page's robots.txt/meta tags allow automation, as determined by WithRespectRobotMetaTags.
IAllowAfterAnySelector	WithHardware [get]
	Specifies to use hardware emulation when interacting with the Selector just defined with .WithSelector. Use this to override what is defined on the Selector. Selenium is the default method to interact with elements, but sometimes hardware emulation is the only way that works. You can also specify to execute javascript on the page to interact with elements.
IAllowAfterAnySelector	WithJavaScript [get]
	Specifies to execute javascript on the page to interact with the Selector just defined with .WithSelector. Use this to override what is defined on the Selector. This is different than Selenium interaction. Selenium is the default method to interact with elements, but sometimes that doesn't work as expected. You can also specify to use hardware emulation to interact with elements.
IAllowWithPagesAndGridActions	WithInfiniteScroll [get]
	Indicates the current page does not have a Next Page button, but an infinite scroll. GPAL pagination then consists of moving to the bottom and waiting for the DocumentReady before paging again.
IAllowBrowserActionOrAnySelector	Back [get]
	Navigate back one page.
IAllowBrowserActionOrAnySelector	Forward [get]
	Navigate forward one page.
IAllowBrowserActionOrAnySelector	Refresh [get]
	Refresh the current page.
IAllowBrowserActionOrAnySelector	PageDown [get]
	Scroll the current tab window down one page.
IAllowBrowserActionOrAnySelector	PageEnd [get]
	Scroll the current tab window to the bottom of the page.
IAllowBrowserActionOrAnySelector	PageTop [get]
	Scroll the current tab window to the top of the page.
IAllowBrowserActionOrAnySelector	PageUp [get]
	Scroll the current tab window up one page.
IAllowAllBrowserAndAllSelector	Restore [get]
	Restore the browser to window state, unminimize.
IAllowAllBrowserAndAllSelector	FullScreen [get]
	Make the browser window fullscreen, saving the current window size so it can be restored later via Restore.
IAllowAllBrowserAndAllSelector	Maximize [get]
	Maximize the browser to full-screen.
IAllowAllBrowserAndAllSelector	Minimize [get]
	Minimize the browser to the taskbar.
IAllowBrowserActionOrAnySelector	NextTab [get]
	Navigate to the next tab. If at the last tab nothing will happen. NOTE: New window is just another tab. So, if a window is opened, should be able to still use .NextTab.
IAllowBrowserActionOrAnySelector	PreviousTab [get]
	Navigate to the previous tab. If at the first tab nothing will happen.
int	ServerResponseCode [get, set]
	HTTP status code of the most recent page navigation/response.
string	CurrentUrl [get, set]
	The URL of the page currently loaded in the browser.
bool	UseSelenium [get]
	True if this Browser is using the Selenium automation engine.
bool	UsePuppeteer [get]
	True if this Browser is using the Puppeteer automation engine.
bool	UseOttoMagic [get]
	True if this Browser is using the OttoMagic automation engine.
Process	Process [get]
	The OS process hosting the browser, if started and tracked by GPAL.
AutomationEngine	AutomationEngine [get, set]
	The automation engine (OttoMagic, Puppeteer, or Selenium) used by this Browser.
bool?	FileDownloaded [get, set]
	True if the most recent download action successfully downloaded a file. Null if no download has been attempted.
BrowserType	BrowserType [get]
	Return the current browser type.
IWebDriver	BrowserDriver [get, set]
	The browser driver controlling the current Browser. Only available after the first .GoTo NOTE: Only for extended Selenium control access. Be careful.
string	RestApiBaseUrl [get]
	Where this browser's GPALRestAPI is listening, e.g. http://localhost:3117/, taken from the port it announced while starting. Null on a browser not running OttoMagic, which has no REST API of its own.
BrowserSettings	BrowserSettings [get, set]
	The settings backing this Browser, including configuration, state, and engine handles.
PuppeteerCommunicator	PuppeteerCommunicator [get, set]
	Communicator used to send/receive messages to the Puppeteer engine for this Browser.
bool	IsAlive [get]
IPuppeteerClient	PuppeteerClient [get, set]
	The Puppeteer client used to issue commands when this Browser is using the Puppeteer engine.
MagicHelper	MagicHelper [get]
	The MagicHelper used to issue commands when this Browser is using the OttoMagic engine.
IRESTClient	OttoMagicClient [get]
IHiddenDesktop	HiddenDesktop [get]
	The hidden desktop this browser is running on, or null when it is on the desktop you are looking at. Null rather than an empty object, the same way RestApiBaseUrl is null on a browser not running OttoMagic, so a workflow can ask whether there is one by asking for it.
IAllowBrowserActionOrAnySelector	NextWindow [get]
	Switches focus to the next browser tab/window in the window list, wrapping around to the first.
IAllowBrowserActionOrAnySelector	PreviousWindow [get]
	Switches focus to the previous browser tab/window in the window list, wrapping around to the last.
List< string >	RobotsTxt [get, set]
	The lines of the current site's robots.txt, as parsed by WithRespectRobotMetaTags/WithObeyRobotsTxt.
object	JavaScriptResultObj [get, set]
	The result object returned by the most recent ExecuteJavaScriptObj call.
string	JavaScriptResultStr [get, set]
	The result string returned by the most recent ExecuteJavaScriptStr call.
string	BrowserVersion [get, set]
	The version of the browser being automated.

Detailed Description

Browser object that contains the fluent methods to create your Browser workflow.
Instatiated using GPAL.Browser.

Selector inputSearchSelector = (Selector)GPAL.Selector
    .WithName("SearchInput")
    .WithCSS("#gh-ac")
    .WithXPath("//*[@id=\"gh-ac\"]")
    .MatchPlaceholder("Search for anything");
 
Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithWaitOnDocumentReady(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Definition at line 66 of file Browser.cs.

Member Function Documentation

AppendFrom() [1/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.AppendFrom

(

GPALDatabase

inputDatabase

)

Append data from the database to the end of any input Selectors defined in the UOW
One token (one column in the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputDatabase

The GPAL Database definitoin

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4520 of file Browser.cs.

AppendFrom() [2/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.AppendFrom

(

GPALFile

inputFile

)

Append the data from the input file to the end of any input Selectors defined in the UOW
One token (one string [between commas] from the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputFile

The GPAL File definition

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4565 of file Browser.cs.

AppendFrom() [3/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.AppendFrom

(

IGPALGrid< string >

inputGrid

)

Append the data from the input grid to the end of any input Selectors defined in the UOW
One token (one string from the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then this token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputGrid

The input grid of tokens

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4613 of file Browser.cs.

AppendFrom() [4/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.AppendFrom

(

string

text

)

Append the given text to the first input in the UOW. Should probably only be used with one selector at a time.
If .WithAllThatMatch is defined on the current UOW, then this text is entered into {num} inputs that matches the Selector(s) in the current UOW.

Parameters

textToUse

The input text to use

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4653 of file Browser.cs.

AppendTo()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.AppendTo

(

GPALFile

file

)

Append the retrieved grid. The output format and delimiter are determined by the GPALFile (its extension or explicit file settings). Headers are not repeated on append.

Implements GenerallyPositive.Browser.IAllowFileActions.

Definition at line 5810 of file Browser.cs.

CallAfterFetchDelegate()

delegate CallIfStatus GenerallyPositive.Browser.Browser.CallAfterFetchDelegate	(	IBrowser	browser,
		List< string >	results,
		IGPALGrid< string >	tokens,
		int	tokenIdx )

Delegate callback for the CallAfterFetch handler declared on a GPALRequest, invoked after each row of tokens has been fetched, with every page that row produced.
Invoked whenever .Fetch is used, once even when there is no token source.

public static CallIfStatus ProcessSearch(IBrowser myBrowser, List<string> results, IGPALGrid<string> tokens, int tokenIdx)
{
    foreach (string body in results)
        Debug.WriteLine($"[{tokens[tokenIdx][0]}] returned [{body.Length}] characters.");
 
    return CallIfStatus.Continue;
}

Parameters

browser	The GPAL Browser object that issued the requests
results	The response bodies for this row, one per page, in the order requested
tokens	The current GPALGrid<string> of tokens, null when there is no token source
tokenIdx	The current token row index

Returns

-1 if the handler requests the application to exit, otherwise the return value is ignored

CallAfterFillIn()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.CallAfterFillIn

(

Browser.CallAfterFillInDelegate

callAfterFillIn

)

Add a handler to call after a row of tokens is consumed and after all inputs are filled in with data.
Only one CallAfterFillIn handler exists.
Use FillInFrom[Database|File|GPALGrid] to loop thru data in your main workflow and then perform next workflow steps in the CallAfter handler.

Parameters

callAfterFillIn

Your callback

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCallBack.

Definition at line 1963 of file Browser.cs.

CallAfterFillInDelegate()

delegate CallIfStatus GenerallyPositive.Browser.Browser.CallAfterFillInDelegate	(	IBrowser	browser,
		IGPALGrid< string >	tokens,
		int	tokenIdx )

Delegate callback for the CallAfterFillIn EventHandler which will be invoked after each row of tokens is consumed.
Invoked whenever FillInFrom/FilllInFromDatabase/FillInFrom are used.

public static int CallAFterFillIn(Browser myBrowser, GPALGrid<string> tokens, int tokenIdx) // text filled in search box, click 'Search' button
{
    Selector searchButton = (Selector)GPAL.Selector
    .WithName("SearchButton")
    .WithCSS("#gh-btn")
    .WithXPath("//*[@id=\"gh-btn\"]")
    .MatchText("Search");
 
    myBrowser
        .WithSelector(searchButton)
 //                .WithSelector(searchButton).WithHardware     // override selector default of Selenium
 //                .WithSelector(searchButton).WithJavaScript   // override selector default of Selenium
    .LeftClick();
}

Parameters

browser	THe GPAL Browser object being filled in
tokens	The current GPALGrid<string> of tokens
tokenIdx	The current token row index

Returns

-1 if the handler requests the application to exit, otherwise the return value is ignored

CallIfDelegate()

delegate CallIfStatus GenerallyPositive.Browser.Browser.CallIfDelegate	(	IBrowser	browser,
		List< IGPALElement >	foundElements,
		List< IGPALElement >	matchedElements,
		Selector	selector,
		bool	matchedAll )

Delegate callback for the CallIfFound/CallIfNotFound EventHandlers which will be invoked when a selector is found/not found
CallIf handlers may be defined at two levels: At each selector or for a Unit of Work (UOW) [will be invoked for each Selector in the UOW]
A UOW is defined as all Selectors between actions (first action is Goto)
More than one callback handler can be defined and subsequent handlers will only be invoked based upon return code values.

public static int FoundAllCookies(Browser browser, List<GPALElement> foundElements, List<GPALElement> matchedElements, Selector selector, bool matchedAll)
{
    int retVal = 0;
    foreach (GPALElement webElement in foundElements)
    {
        if (true == webElement.Text.ToLower().Contains("accept"))   // "Accept all cookies"
        {
            webElement.Click();
            selector.Browser.RemoveCallIfHandlerEverywhere(FoundAllCookies);
            selector.Remove();
            retVal = 1;
        }
    }
    return retVal;
}

Parameters

browser	The current browser running
foundElements	All found elements
matchedElements	All matched elements. If a 'Match' criteria is set on a Selector, otherwise all found
selector	The Selector used
matchedAll	true - all elements matched in foundElements false - matchedElements out of foundElements

Returns

try the next handler in the chain based upon handler return value
0 = not handled, bubble to next handler
1 = handled and continue with the program
2 = try next selector -1 = terminate program

CallIfFound()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.CallIfFound

(

Browser.CallIfDelegate

callIfFoundDelegate

)

Add a Unit of Work level CallIfFound handler to be called if any defined selectors find/match elements.
This method will be called for every found selector in the current UOW.
CallIf handlers can remove themselves by calling myBrowser.RemoveCallIfHandlerEverywhere(handler)
Selectors may remove themselves from a UOW by using selector.Remove()
More than one callback may be defined and will cascade thru the list depending upon the callback return value.
See: CallIfDelegate.

Parameters

callIfFoundDelegate

Your callback

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCallBack.

Definition at line 1979 of file Browser.cs.

CallIfNotFound()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.CallIfNotFound

(

Browser.CallIfDelegate

callIfNotFound

)

Add a Unit of Work level CallIfNotFound handler to be called if any defined selectors DO NOT find/match elements.
This method will be called for every NOT FOUND selector in the current UOW.
CallIf handlers can remove themselve by calling myBrowser.RemoveCallIfHandlerEverywhere(handler)
Selectors may remove themselves from a UOW by using selector.Remove()
More than one callback may be defined and will cascade thru the list depending upon the callback return value.
See: CallIfDelegate.

Parameters

callIfNotFoundDelegate

Your callback

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCallBack.

Definition at line 1995 of file Browser.cs.

CallOnFail()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.CallOnFail

(

CallOnFailDelegate

callOnFail

)

Definition at line 2069 of file Browser.cs.

CallOnFailDelegate()

delegate CallIfStatus GenerallyPositive.Browser.Browser.CallOnFailDelegate	(	IBrowser	browser,
		GPALFailure	failure,
		string	detail )

Delegate for the CallOnFail handler, invoked when something fails that the workflow, rather than GPAL, is in a position to decide about.
GPAL fails forward: it reports what happened and keeps going, so a handler is how a workflow takes a different decision. Return NotHandled and everything proceeds exactly as it would without a handler, Handled to say the workflow dealt with it, or Terminate to end the run.

Parameters

browser	The browser the failure happened on, which is what tells one workflow from another when the handler is the global one
failure	What failed
detail	What the engine said about it, including the url where that applies

Returns

Terminate to end the run, otherwise whether the handler dealt with it

CaptureCalls() [1/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CaptureCalls

(

bool

capture = true

)

Implements GenerallyPositive.Browser.IAllowFetch.

Definition at line 5509 of file Browser.cs.

CaptureCalls() [2/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CaptureCalls

(

out List< GPALCall >

calls

)

Records what the page asks for and hands back everything recorded so far, so an endpoint can be read off a site rather than guessed at.
Say it before going anywhere and say it again whenever you want what has happened since. Each call hands back its own list, so a workflow reading one is never reading what the browser is still writing.

browser
    .GoTo("https://www.example.com/rooms")
    .CaptureCalls(out List<GPALCall> calls);

Parameters

calls

Receives the calls, empty when nothing was captured

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFetch.

Definition at line 5581 of file Browser.cs.

CaptureCallTemplate()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CaptureCallTemplate

(

out GPALRequest

template

)

Waits for the page to make a call the filter matches, then hands it back as a request ready to issue.
This is how a workflow carries a value it cannot know: a token minted per session, a signed parameter, a header the page's own code adds. Nothing is pasted and nothing goes stale, because the template is taken from the run that is happening.
The last match wins, since a page that calls an endpoint more than once has settled by the last one. Hands back null when nothing matched in time, so the workflow decides what that means.

browser
    .WithCallFilter("/availability-api/multiple-price-from")
    .CaptureCallTemplate(out GPALRequest priceFrom);

Parameters

template

Receives the request the page made, or null when none arrived

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCallTemplate.

Definition at line 5443 of file Browser.cs.

CastDesktop()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CastDesktop

(

string

sinkName

)

Casts (mirrors) the entire desktop to the named cast sink (e.g. a Chromecast device).
Supported via Puppeteer and Selenium; not available via OttoMagic.

Parameters

sinkName

Name of the cast sink to cast to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCasting.

Definition at line 9388 of file Browser.cs.

CastTab()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CastTab

(

string

sinkName

)

Casts (mirrors) the current browser tab to the named cast sink (e.g. a Chromecast device).
Supported via Puppeteer and Selenium; not available via OttoMagic.

Parameters

sinkName

Name of the cast sink to cast to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCasting.

Definition at line 9367 of file Browser.cs.

ClearCapturedCalls()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ClearCapturedCalls

(

)

Forgets everything recorded so far, so what is captured next is what happened next. Recording carries on, and what was already handed back to a workflow is untouched.

browser.ClearCapturedCalls();

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFetch.

Definition at line 5610 of file Browser.cs.

ClearDialogHandling()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ClearDialogHandling

(

)

Stops answering dialogs, so they open and block again the way they would for a person. This is the opposite of WithDialogsAccepted(bool) rather than the false half of it: false is still answering, with Cancel.

Puppeteer stops at once. On OttoMagic the three functions stay replaced, because a script cannot be unregistered one at a time, but they hand every call straight to the real one, so the page behaves as it would untouched. To take them off altogether, ClearInjectedScripts and navigate. Selenium cannot stop: the driver was started with the capability and keeps it until it closes.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowDialogHandling.

Definition at line 6593 of file Browser.cs.

ClearInjectedScripts()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ClearInjectedScripts

(

)

Removes all scripts previously registered via InjectScript(string) or InjectScript(GPALFile).

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowInjectScript.

Definition at line 6842 of file Browser.cs.

ClearResultCache()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ClearResultCache

(

)

Clears the cached sitemap / LLM digest / hydration results for this browser, forcing the next Get*‍/Save* to re-walk or re-fetch instead of reusing an earlier result.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 9196 of file Browser.cs.

Close()

void GenerallyPositive.Browser.Browser.Close

(

bool

killWebDrivers = false

)

Close/terminate the browser.
This terminates the fluent browser workflow and nothing can be chained to this command.
NOTE: If you are ending your application, pass in true to kill all running web drivers.

Parameters

killWebDrivers

True to kill all web drivers False [default] to only close the browser.

Implements GenerallyPositive.Browser.IAllowClose.

Definition at line 7845 of file Browser.cs.

CloseTab()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CloseTab

(

dynamic

URLorTabId = null

)

Close the current in focus, active tab.

Returns

Implements GenerallyPositive.Browser.IAllowTabActions.

Definition at line 3054 of file Browser.cs.

CloseWindow()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.CloseWindow

(

dynamic

urlOrId = null

)

Closes the current browser tab/window, or the one matching the given URL or window/tab id, and switches focus to the next available window.

Parameters

urlOrId

Optional GPALUrl, URL string, or window/tab id identifying the window to close. If null, closes the current window.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWindowActions.

Definition at line 8395 of file Browser.cs.

ContinueAsRESTClient()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ContinueAsRESTClient

(

out IRESTClient

client

)

Carries on without the browser: hands back a RESTClient holding what this browser has, its origin, its cookies, the user agent and accept language it is really sending, and the credential it was given with .WithCredentials.
The browser can be closed on the next line and the client keeps working. What does not come along is the TLS handshake, so a target that fingerprints the transport still needs .Fetch from inside the page.

Parameters

client

Receives the client, ready to be given an endpoint

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 1201 of file Browser.cs.

DragAndDrop() [1/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.DragAndDrop

(

ModifierKeys

modifierKeys

)

Left click the element found for Selector(s) defined in the UOW
One left click for the first element found for each selector.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowDragAndDrop.

Definition at line 6403 of file Browser.cs.

DragAndDrop() [2/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.DragAndDrop

(

Selector

selector = null

)

Drags the element(s) found for selector (or the current selector(s) if none is given) by the selector's DeltaX/DeltaY.

Parameters

selector

Optional selector to add to the current unit of work before dragging

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowDragAndDrop.

Definition at line 6419 of file Browser.cs.

ExecuteJavaScriptObj()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ExecuteJavaScriptObj

(

string

javascript

)

Executes JavaScript in the browser and stores the raw result object in JavaScriptResultObj.

Parameters

javascript

JavaScript to execute

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowExecuteJavaScript.

Definition at line 6437 of file Browser.cs.

ExecuteJavaScriptStr()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ExecuteJavaScriptStr

(

string

javascript

)

Executes JavaScript in the browser and stores the result as a string in JavaScriptResultStr.

Parameters

javascript

JavaScript to execute

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowExecuteJavaScript.

Definition at line 6448 of file Browser.cs.

Fetch()

IAllowWithHeaderOrFileActions GenerallyPositive.Browser.Browser.Fetch

(

GPALRequest

request

)

Implements GenerallyPositive.Browser.IAllowFetch.

Definition at line 5760 of file Browser.cs.

FillInFrom() [1/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.FillInFrom

(

GPALDatabase

inputDatabase

)

FillIn data from the database overwriting text in the input Selector(s) defined in the UOW
One token (one column in the current row) per input/element found. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputDatabase

The GPAL Database definitoin

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4550 of file Browser.cs.

FillInFrom() [2/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.FillInFrom

(

GPALFile

inputFile

)

FillIn data from the file overwriting text in the input Selector(s) defined in the UOW
One token (one string [between commas] from the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputFile

The GPAL File definition

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4581 of file Browser.cs.

FillInFrom() [3/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.FillInFrom

(

IGPALGrid< string >

inputGrid

)

FillIn data from the grid overwriting text in the input Selector(s) defined in the UOW
One token (one string from the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then this token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputGrid

The input grid of tokens

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4627 of file Browser.cs.

FillInFrom() [4/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.FillInFrom

(

string

text

)

Overwrite all text in the first input in the UOW. Should probably only be used with one selector at a time.
If .WithAllThatMatch is defined on the current UOW, then this text is entered into {num} inputs that matches the Selector(s) in the current UOW.

Parameters

textToUse

The input text to use

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4666 of file Browser.cs.

Focus()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Focus

(

Selector

selector

)

Focus the current element found via the Selector. Only the first element per Selector found will be focused.
IF using hardwre emulation (.WithHardware) for this selector, for text inputs, focus is a click in the control. Otherwise, hardware emulation hovers the mouse over the control.
If .WithAllThatMatch is defined on the current UOW, then focus will interate over {num} elements that matches the Selector(s) in the current UOW.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFocus.

Definition at line 4692 of file Browser.cs.

Get()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Get

(

GPALUrl

URL

)

Navigate to the URL specified in headless mode.
If no headless browser is open, one will be launched.
If using an already open browser, navigate in the current tab.
Use .WithNewTab before .Get to navigate on a new tab.

Parameters

URL

Returns

Implements GenerallyPositive.Browser.IAllowGet.

Definition at line 2591 of file Browser.cs.

GetElements()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetElements

(

out List< GPALElement >

elements

)

Implements GenerallyPositive.Browser.IAllowGetElements.

Definition at line 4838 of file Browser.cs.

GetGrid()

IAllowWithHeaderOrFileActions GenerallyPositive.Browser.Browser.GetGrid

(

ref IGPALGrid< string >

returnGrid

)

Retrieve the current UOW selectors data into a <string> of columns and rows to use with GPAL or however you want.
using GenerallyPositive.Common;.

...
.WithSelector(descriptionColumn)
.WithSelector(priceColumn)
.WithSelector(linkColumn)
.WithSelector(imageColumn)
.WithAllThatMatch()
.WithNextPageButton(nextPageButton)
.WithPages(3)   // get three pages of results
.GetGrid(out retGrid);   // get grid for us
 
myBrowser
    .WithGridToSave(retGrid)
    .WithHeader("Description")
    .WithHeader("Price")
    .WithHeader("Link")
    .WithHeader("Image URL")
    .SaveTo(@"c:\ebay.retrieved.columns.txt");   // save to file (.txt => tab-delimited)

Parameters

returnGrid

Output GPALGrid

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowGetGrid.

Definition at line 4899 of file Browser.cs.

GetHydratedData()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetHydratedData

(

out NextJsHydrationResult

hydrationResult

)

Extracts Next.js hydration data (e.g. NEXT_DATA) embedded in the current page's HTML.

Parameters

hydrationResult

Receives the extracted NextJsHydrationResult

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 8837 of file Browser.cs.

GetLLMDigest()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetLLMDigest	(	out LLMDigestResult	digestResult,
		string	ruleSetName = null )

Converts the current page's HTML into an LLM-optimized markdown digest.

Parameters

digestResult	Receives the generated LLMDigestResult
ruleSetName	Optional name of a rule set from LLMDigestRules.yaml to use instead of auto-detecting one from the current page's URL (falls back to "generic" either way).

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 8925 of file Browser.cs.

GetPageSource()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetPageSource

(

out string

pageSource

)

Gets the current page's HTML source, cleaned of escape sequences and control characters.

Parameters

pageSource

Receives the cleaned page source HTML

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 8975 of file Browser.cs.

GetSiteMap()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetSiteMap

(

out string

sitemapXML

)

Gets the raw XML/source of the current page, intended for use when the current page is itself a sitemap.

Parameters

sitemapXML

Receives the page source

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 9174 of file Browser.cs.

GetSiteMapUrls()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetSiteMapUrls

(

out List< string >

sitemapUrls

)

Discovers and walks the site's sitemap(s) (via robots.txt, the current page, or heuristic detection), extracting all URLs found, then returns to the original page.

Parameters

sitemapUrls

Receives the list of URLs extracted from the discovered sitemap(s)

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 9211 of file Browser.cs.

GetStorageData()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetStorageData

(

out string

data

)

Retrieves the data read by the most recent .RunGet storage action.

Parameters

data	Receives the data retrieved from storage

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowStorageOutData.

Definition at line 1474 of file Browser.cs.

GetWindowRectangle()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GetWindowRectangle

(

out Rectangle

window

)

Where this browser's window is and how big it is, in screen coordinates, with its chrome included.

Every engine answers it. Puppeteer asks the browser itself over CDP, which needs no page and works while one is still loading. Selenium and OttoMagic ask the page for its screen position and its outer size. A window that cannot be measured either way comes back empty rather than guessed at.

browser.GetWindowRectangle(out Rectangle window);

Parameters

window

Receives the window rectangle in screen coordinates.

Returns

Fluent interface to write your workflow

Definition at line 6789 of file Browser.cs.

GoTo()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GoTo

(

GPALUrl

URL

)

Navigate to the URL specified.
If no browser is open, one will be launched.
If using an already open browser, navigate in the current tab.
Use .WithNewTab before .GoTo to navigate on a new tab.

Parameters

URL

Returns

Implements GenerallyPositive.Browser.IAllowGoTo.

Definition at line 2623 of file Browser.cs.

GoToTab()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GoToTab

(

dynamic

URLorTabTuple = null

)

Goto the tab with the specified URL If using OttoMagic, you can use the tabid from browser.BrowserSettings.TabIds[tabid] search for matching URL.

The browser window comes to the front when this switches tabs under Puppeteer and Selenium, and does not under OttoMagic. That is the protocol, not a choice.
An extension has two separate calls, chrome.tabs.update({active:true}) to make a tab current and chrome.windows.update({focused:true}) to raise its window, so OttoMagic uses the first and never the second. CDP has no equivalent split: Target.activateTarget (and Page.bringToFront) focus the tab and raise the window as one operation, and Selenium's SwitchTo().Window() is implemented on top of it.
So a windowed Puppeteer or Selenium workflow that switches tabs takes the window over while it runs. Run headless to avoid it entirely.

Parameters

URLorTabTuple

Returns

Implements GenerallyPositive.Browser.IAllowTabActions.

Definition at line 6356 of file Browser.cs.

GoToWindow()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.GoToWindow

(

dynamic

urlOrId

)

Switches focus to the browser tab/window matching the given URL or window/tab id.

Parameters

urlOrId

A GPALUrl, URL string, or window/tab id identifying the window to switch to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWindowActions.

Definition at line 8298 of file Browser.cs.

Hide()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Hide

(

Selector

selector = null

)

Hides the element(s) found for selector (or the current selector(s) if none is given) by setting their CSS display to none.

Parameters

selector

Optional selector to add to the current unit of work before hiding

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowHideElement.

Definition at line 4707 of file Browser.cs.

Hover()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Hover

(

Selector

selector = null

)

Fluent alias for MoveTo(Selector). Moving the mouse to an element is a real input-layer event on every engine, so the browser naturally updates CSS :hover state and fires mouseenter/mouseover/mouseleave - this is what reveals hover-triggered menus and tooltips. There is no separate "hover" operation; Hover exists only because it's the more discoverable name for this intent.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowHover.

Definition at line 4772 of file Browser.cs.

InElement()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.InElement

(

Selector

selector

)

InElement indicates the root element for following withselector element searches which would use a relative selector Example: on ebay, we could use a generic selector to get all descriptions, links, prices and images, but that assumes 1:1 correlation of the globally found items or, we can find all the result spans, then search for the description, link, price and image relative to that containing div/span/element.

Parameters

selector

Returns

Fluent interface to chain more methods

Implements GenerallyPositive.Browser.IAllowInSelector.

Definition at line 1489 of file Browser.cs.

InFrame()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.InFrame

(

Selector

selector

)

Specify that the following .WithSelector(s) are contained in an iFrame specified by the Selector.
Use .InMainDom() to get back to working with the main document.

static Selector captchaIframe = (Selector)GPAL.Selector
    .WithCSS(@"#s0-69-captcha-ui > iframe");
 
static Selector captchaCheck = (Selector)GPAL.Selector
    .WithXPath(@"//*[@id=""checkbox""]")
    .WithHardware;
 
Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.FireFox)
    .WithDriverLocation(@"c:\drivers")
    .WithWaitOnDocumentReady(true)
    .GoTo(@"https://www.ebay.com/splashui/captcha")
    .InFrame(captchaIframe)
    .WithSelector(captchaCheck)
    .LeftClick();

Parameters

selector

iFrame element Selector

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowInSelector.

Definition at line 1619 of file Browser.cs.

InjectScript() [1/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.InjectScript

(

GPALFile

scriptFile

)

Registers script(s) loaded from scriptFile to run on every new document load - if multiple filenames are specified (e.g. via wildcard), all are loaded and injected as separate scripts. Persists until ClearInjectedScripts is called.

Parameters

scriptFile

GPALFile referencing one or more JavaScript files

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowInjectScript.

Definition at line 6830 of file Browser.cs.

InjectScript() [2/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.InjectScript

(

string

script

)

Registers a script (raw JS string) to run on every new document load. Callable before the first .GoTo()/.Get() (active from the first page load) or at any later point (applies to subsequent navigations). Persists until ClearInjectedScripts is called.

Parameters

script

JavaScript source code to run on every new document

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowInjectScript.

Definition at line 6811 of file Browser.cs.

InMainDom()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.InMainDom

(

)

Specify that GPAL is no longer working in an iFram or shadow dom and reset back to the main document.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowInSelector.

Definition at line 1873 of file Browser.cs.

InsertFrom() [1/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.InsertFrom

(

GPALDatabase

inputDatabase

)

Insert the text from the database at the beginning of the input Selector(s) defined in the UOW
One token (one column in the current row) per input/element found. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputDatabase

The GPAL Database definitoin

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4535 of file Browser.cs.

InsertFrom() [2/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.InsertFrom

(

GPALFile

inputFile

)

Insert the data from the file at the beginning of the text in the input Selector(s) defined in the UOW
One token (one string [between commas] from the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then the token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputFile

The GPAL File definition

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4597 of file Browser.cs.

InsertFrom() [3/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.InsertFrom

(

IGPALGrid< string >

inputGrid

)

Insert the data from the grid at the beginning of the text in the input Selector(s) defined in the UOW
One token (one string from the current row) per input. Inputs are filled by tokens in the order they are both declared.
If .WithAllThatMatch is defined on the current UOW, then this token is entered into {num} inputs that matches the corresponding Selector in the current UOW.
If CallAfterFillIn callback is defined, it will be called after each row is consumed and the text is input.

Parameters

inputGrid

The input grid of tokens

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4641 of file Browser.cs.

InsertFrom() [4/4]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.InsertFrom

(

string

textToUse

)

Insert text at the beginning of the first input in the UOW. Should probably only be used with one selector at a time.
Example: If three inputs are defined and three 'InsertFrom' are defined, then the text is assigned to the same ordinal input element found via the Selector(s) If .WithAllThatMatch is defined on the current UOW, then this text is entered into {num} inputs that matches the corresponding Selector(s) in the current UOW.

Parameters

textToUse

The input text to use

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 4680 of file Browser.cs.

InShadowDom()

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.InShadowDom

(

Selector

shadowDomSelector

)

Specify that the following .WithSelectors are contained in an a shadow dom specified by the Selector.
Use .InMainDom() to get back to working with the main document. NOTE: can only use CSS selectors in shadow dom.

static Selector shadowRoot = (Selector)GPAL.Selector
    .WithXPath(@"/html/body/article/p[3]")
    .WithHardware
    .WithSimulateMouse(true);
 
static Selector shadowSpan = (Selector)GPAL.Selector
    .WithCSS(@"span")
    .WithHardware
    .WithSimulateMouse(true);
 
Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .WithWaitOnDocumentReady(true)
    .GoTo(@"https://mdn.github.io/web-components-examples/word-count-web-component/")
    .InShadowDom(shadowRoot)
    .WithSelector(shadowSpan)
    .Hover()
    .WaitFor(5000);

Parameters

shadowDomSelector

Shadow dom element Selector

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowInSelector.

Definition at line 1747 of file Browser.cs.

IsEndOfPage()

bool GenerallyPositive.Browser.Browser.IsEndOfPage

(

)

Helper method to check whether the current page is at the bottom.

while (false == browser.IsEndOfPage())
    _ = browser.PageDown

Returns

true or false

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7998 of file Browser.cs.

LeftClick() [1/3]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.LeftClick

(

)

Left click the element found for Selector(s) defined in the UOW
One left click for the first element found for each selector.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3469 of file Browser.cs.

LeftClick() [2/3]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.LeftClick

(

ModifierKeys

modifierKeys

)

Left click the element found for Selector(s) defined in the UOW
One left click for each element found for selector.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3479 of file Browser.cs.

LeftClick() [3/3]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.LeftClick

(

Selector

selector

)

Left click the element(s) found for Selector parameter, creates a UOW of 1 element
One left click w/ no modiofiers pressed for each element found for the selector.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3542 of file Browser.cs.

LeftClickAndDownload()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.LeftClickAndDownload

(

GPALFile

gPalFileToDownloadTo

)

Left clicks the element(s) found for the current selector(s) and downloads the resulting file to gPalFileToDownloadTo .

Parameters

gPalFileToDownloadTo

GPALFile to download to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3741 of file Browser.cs.

LeftClickAndUpload()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.LeftClickAndUpload

(

GPALFile

gPalFileToUpload

)

Left click the input[type=file] or custom control button Headful - enter filename in open file dialog Headless - selenium and puppeteer can use CDP top populate files, OttoMagic requires the native app to stream the file to the browser...

Parameters

gPalFileToUpload

Returns

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 4108 of file Browser.cs.

LeftDoubleClick()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.LeftDoubleClick

(

)

Left double click the element found for Selector(s) defined in the UOW
One left click for each element found for each selector. Should probably be used with only one Selector in the UOW.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3608 of file Browser.cs.

MiddleClick()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.MiddleClick

(

)

Midle click the element found for Selector(s) defined in the UOW
One middle click for each element found for each selector.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3625 of file Browser.cs.

MoveTo()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.MoveTo

(

Selector

selector = null

)

Moves the mouse to the current element found via the Selector. Only the first element per Selector found will be 'moved to'.
IF using hardwre emulation (.WithHardware) for this selector, the mouse is moved to hover over the control.
If .WithAllThatMatch is defined on the current UOW, then MoveTo will move the mouse over {num} elements that matches the Selector(s) in the current UOW.
How and where on the page an element is moved to differs depending upon the technique: Hardware, OttoMagic, Puppeteer or Selenium all perform a real cursor move (triggering CSS :hover and mouseover/mouseenter/mouseleave). As a last resort, when no real cursor is available (e.g. plain Selenium in headless mode), a synthetic "mouseover" event is dispatched via JavaScript - this only fires JS mouseover listeners and does NOT trigger CSS :hover.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowMoveTo.

Definition at line 4786 of file Browser.cs.

NewTab()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.NewTab

(

GPALUrl

url

)

Used to specify the next GoTo command should open in a new tab. The new tab is then the active tab.
Use .NextTab and .PreviousTab to navigate tabs. NOTE: Applies only once. Use .WithNewTab before each .GoTo to open in a new tab.

    myBrowser
        .WithNewTab("http://www.google.com");
 
// open a new tab in headless mode, then navigate in the new tab
    myBrowser
        .WithNewTab()
        .Get("http://www.google.com");

Implements GenerallyPositive.Browser.IAllowNewTabOrWindow.

Definition at line 3392 of file Browser.cs.

OpenWindow()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.OpenWindow

(

GPALUrl

URL

)

Opens a new browser tab/window navigated to URL and switches focus to it.

Parameters

URL	URL to open in the new window/tab

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowNewTabOrWindow.

Definition at line 8123 of file Browser.cs.

PersistentCallIfFound()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.PersistentCallIfFound

(

CallIfDelegate

persistentCallIfFound

)

Add a persistent CallIfFound handler to be called if any defined persistent selectors find/match elements.
Persistent selectors are always looked for before every action cross-cutting your workflow.
Persistent handlers can remove themselves in the CallIfHandler by calling myApplication.RemoveCallIfHandlerEverywhere(handler)
More than one callback may be defined and will cascade thru the list depending upon the callback return value.
See: CallIfDelegate.

Parameters

persistentCallIfFound

Callback delegate

Returns

Fluent interface to write your workflow

Definition at line 2020 of file Browser.cs.

PersistentCallIfNotFound()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.PersistentCallIfNotFound

(

CallIfDelegate

persistentCallIfNotFound

)

Add a persistent CallIfNotFound handler to be called if any defined persistent selectors DO NOT find/match elements.
Persistent selectors are always looked for before every action cross-cutting your workflow. Persistent handlers can remove themselves in the CallIfHandler by calling myApplication.RemoveCallIfHandlerEverywhere(handler)
More than one callback may be defined and will cascade thru the list depending upon the callback return value.
See: CallIfDelegate.

Parameters

persistentCallIfNotFound

Callback delegate

Returns

Fluent interface to write your workflow

Definition at line 2035 of file Browser.cs.

PressModifierKey()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PressModifierKey

(

ModifierKeys

modifierKeys

)

Press the specified modifer keys (can be ORd)
NOTE: If you SendString a mixed case string, the SHIFT key will be released if it is pressed.

// send CTRL-HOME
    ...
    myBrowser
        .PressModifierKey(ModifierKeys.Control)
        .SendKey(GPAL.VK_HOME);
        .WaitFor(150)
        .ReleaseModifierKey(ModifierKeys.Control)

Parameters

modifierKeys

Enumeration ModifierKeys, can be ORd togther

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 6132 of file Browser.cs.

PrintToPDF()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PrintToPDF

(

GPALFile

gpalFile

)

Prints the current selector's element (or the whole page if no selector is set) to a PDF file.

Parameters

gpalFile

GPALFile to save the PDF to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPrintDomElement.

Definition at line 5954 of file Browser.cs.

ReleaseModifierKey()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ReleaseModifierKey

(

ModifierKeys

modifierKeys

)

Release the specified modifer keys (can be ORd)
NOTE: If you SendString a mixed case string, the SHIFT key will be released if it is pressed.

// send CTRL-HOME
    ...
    myBrowser
        .PressModifierKey(ModifierKeys.Control)
        .SendKey(GPAL.VK_HOME);
        .WaitFor(150)
        .ReleaseModifierKey(ModifierKeys.Control)

Parameters

modifierKeys

Enumeration ModifierKeys, can be ORd togther

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 6202 of file Browser.cs.

RemoveCallIfHandlerEverywhere()

void GenerallyPositive.Browser.Browser.RemoveCallIfHandlerEverywhere

(

CallIfDelegate

func

)

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7971 of file Browser.cs.

RightClick()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.RightClick

(

Selector

selector = null

)

Right click the element found for Selector(s) defined in the UOW
One right click for the first element found for each selector. Should probably be used with only one Selector in the UOW.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3682 of file Browser.cs.

RightClickAndDownload()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.RightClickAndDownload

(

GPALFile

filenames

)

Right click the element(s) found for Selector(s) defined in the UOW, select 'Save as...', wait for the SAVE AS dialog, enter the filename and save the file.
The saved filename is then added to the end of the filename list.
Useful if files are not overwritten.
One right click for the first element found for each selector. Should probably be used with only one Selector in the UOW.
If .WithAllThatMatch is defined on the current UOW, then a right click is performed on {num} elements that matches the corresponding Selector in the current UOW.
.

Parameters

filenameList

List of filename(s) to save

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 4285 of file Browser.cs.

Run()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Run

(

)

Runs the workflows added via WithWorkflow against this browser, in the order they were added. To give each workflow a browser of its own and run several at once, see GPAL.Workflow.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowRun.

Definition at line 8556 of file Browser.cs.

RunDelete()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.RunDelete

(

WebsiteStorageType

storageType

)

Deletes data from browser storage (cookies, local/session storage, IndexedDB) using the domain/path/key configured by the preceding .WithStorage* calls.

Parameters

storageType

Type of storage to delete from

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowStorageAction.

Definition at line 1346 of file Browser.cs.

RunGet()

IAllowStorageOutData GenerallyPositive.Browser.Browser.RunGet

(

WebsiteStorageType

storageType

)

Reads data from browser storage (cookies, local/session storage, IndexedDB) using the domain/path/key configured by the preceding .WithStorage* calls.

Parameters

storageType

Type of storage to read from

Returns

Fluent interface to retrieve the result with .GetStorageData

Implements GenerallyPositive.Browser.IAllowStorageAction.

Definition at line 1318 of file Browser.cs.

RunSet()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.RunSet

(

WebsiteStorageType

storageType

)

Writes data to browser storage (cookies, local/session storage, IndexedDB) using the domain/path/key/data configured by the preceding .WithStorage* calls.

Parameters

storageType

Type of storage to write to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowStorageAction.

Definition at line 1332 of file Browser.cs.

SaveHydratedData()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SaveHydratedData

(

GPALFile

hydrationFile

)

Extracts Next.js hydration data (e.g. NEXT_DATA) from the current page and saves it to a file.

Parameters

hydrationFile

The GPALFile to save the extracted hydration data to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 8908 of file Browser.cs.

SaveLLMDigest()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SaveLLMDigest	(	GPALFile	llmDigestFile,
		string	ruleSetName = null )

Converts the current page's HTML into an LLM-optimized markdown digest and saves it to a file.

Parameters

llmDigestFile	The GPALFile to save the digest to
ruleSetName	Optional name of a rule set from LLMDigestRules.yaml to use instead of auto-detecting one from the current page's URL (falls back to "generic" either way).

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 8962 of file Browser.cs.

SaveSiteMapUrls()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SaveSiteMapUrls

(

GPALFile

sitemapUrlsFile

)

Discovers and walks the site's sitemap(s), then saves the extracted URLs to a file. The output format (csv, txt, json, yaml, xml, ...) is chosen from the file extension by the converter, so one call turns a crawl into whatever downstream format you need.

Parameters

sitemapUrlsFile

The GPALFile to save the sitemap URLs to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSiteMapOperations.

Definition at line 9336 of file Browser.cs.

SaveTo() [1/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SaveTo

(

GPALFile

file

)

Implements GenerallyPositive.Browser.IAllowFileActions.

Definition at line 5793 of file Browser.cs.

SaveTo() [2/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SaveTo

(

ref string

data

)

Hand back what .Fetch retrieved, as a JSON array holding one response body per page requested, so a single page and twenty pages come out in the same shape.

Parameters

data	Receives the JSON array of response bodies

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFileActions.

Definition at line 5778 of file Browser.cs.

ScrollElementHorizontalByPixels()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ScrollElementHorizontalByPixels

(

int

scrollAmountInPixels

)

Scroll the element horizontally by number of pixels.
Negative numbers scroll left. JavaScript only.

Parameters

scrollAmountInPixels

Positive integer scrolls right. Negative integer scolls left.

Returns

Fluent interface to write your element handling workflow

Implements GenerallyPositive.Browser.IAllowScrolling.

Definition at line 6323 of file Browser.cs.

ScrollElementVerticalByPixels()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ScrollElementVerticalByPixels

(

int

scrollAmountInPixels

)

Scroll the element vertically by number of pixels.
Negative numbers scroll up. JavaScript only.

Parameters

scrollAmountInPixels

Positive integer scrolls down. Negative integer scolls down.

Returns

Fluent interface to write your element handling workflow

Implements GenerallyPositive.Browser.IAllowScrolling.

Definition at line 6334 of file Browser.cs.

ScrollWindowByHorizontal()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ScrollWindowByHorizontal

(

int

scrollAmountInPixels

)

Scroll the browser window horizontally the number of pixels.
Negative numbers scroll left. JavaScript only.

Parameters

scrollAmount

Positive integer scrolls right. Negative integer scolls left.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWindowScrollBy.

Definition at line 6289 of file Browser.cs.

ScrollWindowByVertical()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.ScrollWindowByVertical

(

int

scrollAmountInPixels

)

Scroll the browser window horizontally the number of pixels.
Negative numbers scroll up. JavaScript only.

Parameters

scrollAmount

Positive integer scrolls down. Negative integer scolls down.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWindowScrollBy.

Definition at line 6306 of file Browser.cs.

SelectClick()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SelectClick

(

SelectClickType

selectClickType

)

Clicks the option element(s) found for the current selector(s) using the given select-click behavior (e.g. RandomSelect, SequentialSelect).

Parameters

selectClickType

Select-menu click behavior

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3555 of file Browser.cs.

SendKey()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SendKey

(

byte

VKCode

)

Type special characters like Enter, Page Up, Page Down, Tab, etc.
Use GPAL.VK constants for ease of access to commmon keys.
For all Virtual Keycodes, visit:
https://docs.microsoft.com/en-us/windows/win32/inputdev/virtual-key-codes.

// send CTRL-HOME
    ...
    myBrowser
        .PressModifierKey(ModifierKeys.Control)
        .SendKey(GPAL.VK_HOME);
        .WaitFor(150)
        .ReleaseModifierKey(ModifierKeys.Control)

Parameters

VKCode

Virtual Keycode

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 6274 of file Browser.cs.

SendString()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SendString

(

string

textToSend

)

Type in the literal string provided.
NOTE: If you press SHIFT then SendString a mixed-case string, SHIFT will be released.
To send ALL CAPS, press SHIFT then send an all lowercase string.

Parameters

textToSend

Text to type

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 6106 of file Browser.cs.

SetAttribute()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SetAttribute

(

string

value

)

Assigns value to the attribute named by the preceding WithAttribute call, completing the SetAttribute action.

Parameters

value

Value to assign to the attribute

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSetAttributeValue.

Definition at line 4740 of file Browser.cs.

SetRange()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SetRange

(

int

rangeValue

)

Sets the value of a range/slider input element matched by the current selector(s) by scrolling it into view and setting its value to rangeValue .

Parameters

rangeValue

Value to set the range input to

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFillInFrom.

Definition at line 6873 of file Browser.cs.

SetValueFrom()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.SetValueFrom

(

Selector

selector

)

Sets the value of the element(s) matched by the preceding WithSelector call from the value of the element matched by selector , i.e. destElement.value = srcElement.value. Uses OttoMagic, Puppeteer or JavaScript depending on the active engine, and fires "input"/"change" events on the destination so the page reacts to the new value.

Parameters

selector

Selector identifying the source element to read the value from

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowSetValueFromElement.

Definition at line 4756 of file Browser.cs.

StartWorkflow()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.StartWorkflow

(

)

Start a workflow to invoke CallIf handlers (if no other action is being used in the workflow)
A LeftClick, Hover, GetGrid, SaveTo. FillIn and other actions will all start the workflow.
Sometimes your Unit of Work (UOW) consists of finding one repeating element, then chaining to a CallIfFound handler. StartWorkflow will kick off looking for your UOW selectors.
NOTE: Only call this if you have not called another action. Any prior action will start the workflow and this will be ignored if used.
But if you have not called an action, you can use .StartWorkflow to kick off the workflow which will invoke your CallIf handlers.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowStartWorkflow.

Definition at line 4805 of file Browser.cs.

StealthLeftClick()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.StealthLeftClick

(

Selector

selector

)

Stealth (Runtime.disable before) Left click the element(s) found for Selector parameter, creates a UOW of 1 element
One left click w/ no modiofiers pressed for each element found for the selector.
If .WithAllThatMatch is defined on the current UOW, then a left click is performed on {num} elements that matches the corresponding Selector in the current UOW.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowClicks.

Definition at line 3577 of file Browser.cs.

StopCasting()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.StopCasting

(

)

Stops any active cast (tab or desktop mirroring) started via CastTab or CastDesktop.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowCasting.

Definition at line 9407 of file Browser.cs.

ToGPALObject()

IBrowser GenerallyPositive.Browser.Browser.ToGPALObject

(

)

Return a GPAL.Browser object so that GPAL.Browser does not have to be cast.

Returns

A GPAL.Browser object

Browser browser = GPAL.Browser
    .WithBrowserType(BrowserType.FireFox)
    .WithWaitOnDocumentReady(true)
    .WithLoadImages(true)
    .WithOverwriteExistingFile(false)
    .GoTo("https://www.ebay.com/")
    .ToGPALObject();

Implements GenerallyPositive.Browser.IAllowToGPALObject< TResult >.

Definition at line 185 of file Browser.cs.

Until() [1/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Until

(

Func< Browser, bool >

predicate

)

Repeats the workflow added via WithWorkflow until the given predicate returns true, subject to WhileLoopTimeout and WhileLoopMaxIterations.

Parameters

predicate

A function evaluated against the Browser after each iteration; the loop stops once it returns true

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWorkflowExecution.

Definition at line 8662 of file Browser.cs.

Until() [2/2]

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Until

(

Selector

selector

)

Repeats the workflow added via WithWorkflow until the given selector matches an element on the page, subject to WhileLoopTimeout and WhileLoopMaxIterations.

Parameters

selector

The Selector to wait for before stopping the loop

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWorkflowExecution.

Definition at line 8651 of file Browser.cs.

WaitFor() [1/3]

IAllowAfterWaitFor GenerallyPositive.Browser.Browser.WaitFor

(

ElementState

elementState

)

Waitfor an element to eneter the specified state. This is an action.

Parameters

elementState

Returns

Implements GenerallyPositive.Browser.IAllowWaitFor.

Definition at line 5900 of file Browser.cs.

WaitFor() [2/3]

IAllowAfterWaitFor GenerallyPositive.Browser.Browser.WaitFor

(

Selector

waitForSelector

)

Wait for the specified elements(s) defined by withForSelector to be present and defined on-page.

Parameters

waitForSelector

Returns

Implements GenerallyPositive.Browser.IAllowWaitFor.

Definition at line 5873 of file Browser.cs.

WaitFor() [3/3]

IAllowAfterWaitFor GenerallyPositive.Browser.Browser.WaitFor

(

WaitTime

waitForTimeInMs

)

Either wait the amount of time specified or wait UP TO the amount of time specified waiting for elements to be found for the Selector(s) in the current UOW.
If an action has already been called, then this is interpretted as a sleep for the specified miliseconds.
If only selectors have been defined in the current UOW, then this is a delay waiting for the selectors to be present before continuing with the workflow.
Waiting for elements does not guarantee they will be present when the workflow continues. If they are not present, the CallIfNotFound handler will be invoked so you can deal with that.
NOTE: WaitFor is not considered an action, if defines a time to wait for elements to be present before trying to perform actions.

Parameters

timeoutInTicks

WaitTIme - use predefined from WaitTime. or any int (ms)

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWaitFor.

Definition at line 5854 of file Browser.cs.

WaitForWindow()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Browser.Browser.WaitForWindow

(

string

waitForTitle

)

Wait for a Windows window with title to appear on the desktop.
Used in conjunction with .WithWaitForWindowTimeout to set the wait duration in seconds.
.

Parameters

windowTitle

Window title to wait for

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWaitForWindow.

Definition at line 5920 of file Browser.cs.

WaitForWindowRegex()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Browser.Browser.WaitForWindowRegex

(

string

waitForTitleRegex

)

Wait for a Windows window with title that matches the regex pattern to appear on the desktop.
Used in conjunction with .WithWaitForWindowTimeout to set the wait duration in seconds.
.

Parameters

windowTitleRegex

Window title regex to waitfor

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWaitForWindow.

Definition at line 5931 of file Browser.cs.

While()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.While

(

Func< Browser, bool >

predicate

)

Repeats the workflow added via WithWorkflow for as long as the given predicate returns true, subject to WhileLoopTimeout and WhileLoopMaxIterations.

Parameters

predicate

A function evaluated against the Browser before each iteration; the loop continues while it returns true

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWorkflowExecution.

Definition at line 8640 of file Browser.cs.

WhileLoopMaxIterations()

IAllowWorkflowExecution GenerallyPositive.Browser.Browser.WhileLoopMaxIterations

(

int

maxIterations

)

Sets the maximum number of iterations a While/Until loop is allowed to run before it is aborted.

Parameters

maxIterations

Maximum number of iterations. Must be greater than zero, otherwise the existing default is kept.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWorkflowExecution.

Definition at line 8621 of file Browser.cs.

WhileLoopTimeout()

IAllowWorkflowExecution GenerallyPositive.Browser.Browser.WhileLoopTimeout

(

int

timeoutMs

)

Sets the maximum amount of time a While/Until loop is allowed to run before it is aborted.

Parameters

timeoutMs

Timeout in milliseconds. Must be greater than zero, otherwise the existing default is kept.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWorkflowExecution.

Definition at line 8603 of file Browser.cs.

WithAllThatMatch()

IAllowAfterAnySelectorExceptWithAll GenerallyPositive.Browser.Browser.WithAllThatMatch

(

int

rowCount = int::MaxValue

)

Indicates the Selectors refer to/match repeating, multiple elements on the page.
Use after all your .WithSelector statements. Used two ways.
For scraping: This is used to retrieve multiple rows of data from the webpage, up to rowCount.
For input tokens/strings: This will repeat the same input into multiple elements, up to rowCount of lines.
NOTE: if called before any.

Parameters

rowCount

Set total number of entries to retrieve (if this is longer than a page size). If less than the page size, retrieve the 'top rowCount' rows on each page for the number of pages specified using .WithPages(pageCount) int.MaxValue [default] work with all rows.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWithAllThatMatch.

Definition at line 2187 of file Browser.cs.

WithAttribute()

IAllowSetAttributeValue GenerallyPositive.Browser.Browser.WithAttribute

(

string

attribute

)

Names the DOM attribute to set on the current selector(s). Must be followed by SetAttribute(string) to supply the value and complete the action. See IAllowSetAttributeValue.SetAttribute for the distinction between this and SendString/FillIn*.

Parameters

attribute

Name of the attribute to set (e.g. "disabled", "value", "data-foo")

Returns

Fluent interface; must be followed by SetAttribute(value) to complete the action

Implements GenerallyPositive.Browser.IAllowWithAttribute.

Definition at line 4729 of file Browser.cs.

WithAutomationEngine()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithAutomationEngine

(

AutomationEngine

automationEngine

)

Selects which automation engine drives the browser: Selenium, OttoMagic, or one of the Puppeteer connection modes. Firefox only supports Selenium or OttoMagic.

Parameters

automationEngine

Automation engine to use

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowWithAutomationEngine.

Definition at line 771 of file Browser.cs.

WithBlockPopUps()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithBlockPopUps

(

bool

blockPopUp

)

Specifies whether to block popups in the browser.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .WithBlockPopUps(false)
    .GoTo("https://www.ebay.com/")

Parameters

blockPopUp

True [default] to block popups. False allows popups.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 336 of file Browser.cs.

WithBrowserType()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithBrowserType

(

BrowserType

browserType

)

Specify which browser to run the workflow in.
NOTE: Chrome and Edge act mostly the same, Firefox has some behavioral differences.
For all browsers, GPAL handles any differences for you.
Of particular note is topping the browser window with Firefox requires a hardware click.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")

Parameters

browserType

Enumeration BrowserType of Chrome [default], Edge or Firefox.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserType.

Definition at line 488 of file Browser.cs.

WithCallFilter()

IAllowCallTemplate GenerallyPositive.Browser.Browser.WithCallFilter

(

string

urlFragment

)

Save the retrieved grid. The output format and delimiter are determined by the GPALFile (its extension, e.g. .csv/.tsv/.txt/.xlsx/.json, or its explicit file settings).
The single save syntax; the output format and delimiter come from the GPALFile.

Issue an API request from inside the page, so it carries the session this browser has already earned: its cookies, its TLS fingerprint, its header order and any anti-bot clearance. The response body is held for .SaveTo.
Honors .WithPages, replacing the request's .WithPageToken with the page number once per page, and .WithTokensFrom, running the whole set of pages once per row and filling the request's numbered tokens from that row's columns. If the request declares a CallAfterFetch handler, it is called with each row's pages as they arrive.

string json = null;
 
browser
    .GoTo("https://www.harrods.com/")
    .WithTokensFrom(searchTerms)
    .WithPages(20)
    .Fetch(productSearch)
    .SaveTo(ref json);

Parameters

request

The request to issue, built with GPAL.Request

Returns

Fluent interface to write your workflow

Records what the page asks for, so an endpoint can be read off a site rather than guessed at.
Every request the browser makes from here on is kept, method, url, resource type and body, until this is turned off. Hand them back with SaveTo(out List<GPALCall>).

browser
    .CaptureCalls()
    .GoTo("https://www.example.com/rooms")
    .SaveTo(out List<GPALCall> calls);

Parameters

capture

True to record, false to stop

Returns

Fluent interface to write your workflow

Narrows what CaptureCalls(bool) records to calls whose url holds this, so a page that asks for three hundred things contributes the three that matter.
Say it before capturing. Nothing is missed by declaring it late, only unrecorded.

Parameters

urlFragment

Any part of the url to keep, for example "/availability-api/"

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowFetch.

Definition at line 5418 of file Browser.cs.

WithCredentials()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithCredentials

(

ICredentials

credentials

)

Add a handler to be called when something fails on this browser that the workflow is in a position to decide about, a navigation that never loaded a page being the case that exists today.
GPAL fails forward, so without a handler the failure is reported and the run carries on, which for a dead page means the selectors find nothing and the CallIfNotFound handlers fire. A handler is how a workflow takes a different decision: retry the url, go somewhere else, or terminate.
A browser with no handler of its own falls through to GPAL.CallOnFail, so several workflows can share one handler and tell themselves apart by the browser they are handed.

Parameters

callOnFail

Callback delegate

Returns

Fluent interface to write your workflow

Who this browser is, for a site that asks before it will hand anything over.
The credential's WebAuthType decides what happens: Basic, Proxy and Bearer are settled before the first request is made and need nobody watching, Digest is a challenge so the browser answers it as it arrives, and Form means GPAL only holds the credential while the workflow drives the login page with selectors, because a form has no other way in.
Presented once, at the first navigation, and it holds for the session. Nothing about the credential is ever published to the event stream.

Parameters

credentials

Credentials built with GPAL.CredentialsFor

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPersistentCallBack.

Definition at line 2063 of file Browser.cs.

WithDialogsAccepted()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.WithDialogsAccepted

(

bool

accept

)

Answers the alert, confirm and prompt dialogs the page raises instead of letting them open and stop everything until somebody clicks. True is OK, and confirm reads true; false is Cancel, and confirm reads false. Not calling this leaves dialogs alone, so they open and block the way they would for a person.

Selenium and Puppeteer answer them at the browser: the driver does it as a capability and Puppeteer over CDP, and the page's own alert, confirm and prompt are untouched, so nothing about it is visible to the page. OttoMagic cannot do that, because an open dialog stops the page thread the extension talks through, so there GPAL replaces those three functions before the page runs and no dialog is ever raised. That replacement is the one thing here a page could notice, which is why it is only done on the engine that has no other way.

Parameters

accept

True to accept, false to dismiss.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowDialogHandling.

Definition at line 6547 of file Browser.cs.

WithDialogText()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.WithDialogText

(

string

text

)

What a prompt hands back when dialogs are accepted. Left unsaid, the prompt's own default stands.

Parameters

text	The text to answer a prompt with.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowDialogHandling.

Definition at line 6568 of file Browser.cs.

WithDownloadLocation()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithDownloadLocation

(

string

directory

)

Specifies the download location for this browser sessions, overrides the default.

Parameters

directory

The full path to the download folder.

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 317 of file Browser.cs.

WithDownloadTimeoutInSec()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithDownloadTimeoutInSec

(

int

seconds

)

Sets the maximum time to wait for a download to complete.

Parameters

seconds

Timeout in seconds

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 307 of file Browser.cs.

WithDriverLocation()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithDriverLocation

(

string

directory

)

Specifies the location where the browser driver executable is loaded from.
Default location is the directory with the GPAL executable.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")

Parameters

directory

Directory containing the driver

Returns

Fluent interface to specify more Browser settings or GoTo

Definition at line 287 of file Browser.cs.

WithExistingBrowser()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.WithExistingBrowser

(

int

port

)

Specifies the port to use to connect to an existing session from another workflow started with .WithDebugPort
MUST be the same port as used when calling .WithDebugPort().

// open a browser using debug port 6565
Browser browser1 = (Browser)GPAL.Browser
    .WithBrowserType(browserType)
    .WithDriverLocation(gPALInput.Text)
    .WithDebugPort(6565)
    .WithWaitOnDocumentReady(true)
    .GoTo("https://studio.youtube.com");
 
// create an entirely new session connecting to the browser1 session
Browser browser2 = (Browser)GPAL.Browser
    .WithExistingBrowser(6565)
    .WithWaitOnDocumentReady(true)
    .WithSelector(detailsTab).LeftClick();
 
browser1.Close(true);   // no need to close 2, it's the same

Parameters

port	The TCP port number to connect with to control the browser

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowExistingBrowser.

Definition at line 667 of file Browser.cs.

WithGridToSave()

IAllowWithHeaderOrFileActions GenerallyPositive.Browser.Browser.WithGridToSave

(

IGPALGrid< string >

inputGrid

)

Specifies a GPALGrid<string> that will be subsequently saved to disk.
Headers can be specified inline using .WithHeader or, if not specified, will use the Selector name as the column header.
If using the Selector name as the header, the names and order of the headers are from the current UOW and the order the Selectors are defined.
NOTE: Scraping data occurs when .GetGrid(optionalOutGrid) is called. An internal grid is then created in the currentUOW.
This internal grid will be used in any subsequent .SaveTo[CSV|TabbedText|Text] method calls.
In this case, you do not need to specify an input grid using WithGridToSave.

using GenerallyPositive.Common; // acess to GPALGrid
 
public static GPALGrid<string> retGrid;
 
... code to fill in the grid ...
@iverbatim 
myBrowser
    .WithGridToSave(retGrid)
    .WithHeader("Description")
    .WithHeader("Seller")
    .WithHeader("Feedback")
    .SaveTo(@"C:\ebay.retrieved.columns.txt");   // .txt => tab-delimited
@endiverbatim

Parameters

inputGrid

The GPALGrid<string> of data to save

Returns

Implements GenerallyPositive.Browser.IAllowWithGridToSave.

Definition at line 620 of file Browser.cs.

WithHeader()

IAllowWithHeaderOrFileActions GenerallyPositive.Browser.Browser.WithHeader

(

string

header

)

Specify a column header for output. Headers are output in order defined.

Parameters

header

Header text

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWithHeader.

Definition at line 2168 of file Browser.cs.

WithHiddenDesktop() [1/2]

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithHiddenDesktop

(

bool

hiddenDesktop

)

Run the browser on a Win32 desktop object of its own: a real window, real rendering, no headless fingerprint, on a desktop nobody is looking at. The machine stays usable while the workflow runs.
NOTE: naming no desktop gets this browser one of its own that nothing else will be given. Sharing a desktop is what WithHiddenDesktop(string) is for.
NOTE: this is not a Windows virtual desktop (Win+Tab). Those group windows within the one desktop and isolate nothing.
NOTE: SendInput only reaches the desktop the user is on, so a hardware engine cannot drive a browser here. One asked for anyway steps down to the protocol engine of its own family, and the browser says which engine it settled on.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithHiddenDesktop()
    .GoTo("https://www.ebay.com/")

Parameters

hiddenDesktop

True [default] for a desktop of its own. False for the one in front of you.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 362 of file Browser.cs.

WithHiddenDesktop() [2/2]

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithHiddenDesktop

(

string

desktopName

)

Run the browser on the named Win32 desktop object. Browsers naming the same desktop share it, and browsers naming different ones get one each, so three browsers on one desktop and three browsers on three desktops are the same call with different names.
NOTE: everything WithHiddenDesktop(bool) says applies here too, hardware engines included.

// a desktop each, so they can be looked at one at a time
browser.WithHiddenDesktop($"GPAL.Hidden.{row}");

Parameters

desktopName

What to call the desktop this browser runs on.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 388 of file Browser.cs.

WithLoadImages()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithLoadImages

(

bool

loadImages

)

Determine whether to show images on a webpage.
.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .WithLoadImages(false)
    .GoTo("https://www.ebay.com/")

Parameters

loadImages

True to load/render images. False [default] to NOT load/render images.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 527 of file Browser.cs.

WithNavigationGrace()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithNavigationGrace

(

int

graceInMs

)

How long a click waits to see whether it started a navigation, before deciding it stayed on the page.
A click returns as soon as the event is dispatched, so a slow site still reports the old url for a moment. Only clicks that navigate go on to wait for the load, which WithWaitOnDocumentReady controls.
This is paid in full by every click that does not navigate, so it trades run time for not acting on a stale page.

browser
    .WithNavigationGrace(250)
    .WithWaitOnDocumentReady(30_000)
    .GoTo("https://www.ebay.com/");

Parameters

graceInMs

Milliseconds to watch for a navigation. 0 skips the check and clicks return immediately

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 843 of file Browser.cs.

WithNetworkIdleMaxConnections()

IAllowNetworkIdleSettings GenerallyPositive.Browser.Browser.WithNetworkIdleMaxConnections

(

int

maxConnections = 0

)

Specifies the maximum duration to keep network stats before pruning old data.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithNetworkIdleTimeoutMs(500)  // already the default value
    .WithNetworkIdlePruneMs(10_000) // already the default value
    .WithNetworkIdleMaxConnections(0)   // already the default value
    .WithWaitOnIdleConnection(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

networkIdlePruneMs

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowNetworkIdleSettings.

Definition at line 919 of file Browser.cs.

WithNetworkIdlePruneMs()

IAllowNetworkIdleSettings GenerallyPositive.Browser.Browser.WithNetworkIdlePruneMs

(

int

networkIdlePruneMs = 3_000

)

Specifies the maximum duration to keep network stats before pruning old data The time to wait for new connections to count as open. eg, If prune is 3 seconds, if there are 9 connections and another one opens after 3 seconds, it is considered idle.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithNetworkIdleTimeoutMs(500)  // already the default value
    .WithNetworkIdlePruneMs(10_000) // already the default value
    .WithNetworkIdleMaxConnections(0)   // already the default value
    .WithWaitOnIdleConnection(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

networkIdlePruneMs

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowNetworkIdleSettings.

Definition at line 945 of file Browser.cs.

WithNetworkIdleTimeoutMs()

IAllowNetworkIdleSettings GenerallyPositive.Browser.Browser.WithNetworkIdleTimeoutMs

(

int

networkIdleTimeoutMs = 500

)

Specifies max time in milliseconds to wait for the network idle before returning false.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithNetworkIdleTimeoutMs(500)  // already the default value
    .WithNetworkIdlePruneMs(10_000) // already the default value
    .WithNetworkIdleMaxConnections(0)   // already the default value
    .WithWaitOnIdleConnection(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

networkIdleTimeoutMs

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowNetworkIdleSettings.

Definition at line 895 of file Browser.cs.

WithNextPageButton()

IAllowWithPagesAndGridActions GenerallyPositive.Browser.Browser.WithNextPageButton

(

Selector

nextPageButtonselector

)

Specifies the Next Page button used to retrieve multiple pages of data.
Use with .GetPages(numOfPages) to specify how to get those next pages.
.GetGrid or any .SaveTo[CSV|Excel|File] will treat the current UOW as output Selectors from which to retrieve data.
Retrieving data will retrieve only the current page if nothing is specified.
Also useful with .WithAllThatMatch to retrieve repeating results (like on eBay)
See also .WithInfiniteScroll.

Parameters

nextPageButtonselector

Next Page Button selector

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWithNextPageButton.

Definition at line 1899 of file Browser.cs.

WithObeyRobotsTxt()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithObeyRobotsTxt

(

bool

trueFalse = false

)

Set whether to deny navigating to webpage if denied by robots.txt.

Parameters

trueFalse

true or false

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 2566 of file Browser.cs.

WithOpenPDFExternally()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithOpenPDFExternally

(

bool

openPDFExternally

)

Specifies whether the browser will render PDFs or launch an external program.
.

Parameters

openPDFExternally

True [default] to open PDFs external to the browser. False to render in the browser.

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 580 of file Browser.cs.

WithOverwriteExistingFile()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithOverwriteExistingFile

(

bool

overwriteFile

)

Overwrite the destination file locally when downloading.
If set to false, filenames will have a date timestamp appended to make each filename unique.
Used with .LeftClickAndDownload(filename) and .RightClickAndDownload(filename).

myBrowser
    .WithOverwriteExistingFile(true)
    .RightClickAndDownload(fileList);   // NOTE: filename used on save is added to the end of filelist

Parameters

overwriteFile

True to overwrite destination file. False [default] to rename file on save.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 508 of file Browser.cs.

WithPageOrientation()

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.WithPageOrientation

(

PageOrientation

pageOrientation

)

Sets the page orientation (Portrait/Landscape) used by PrintToPDF.

Parameters

pageOrientation

Desired page orientation

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPrintDomElement.

Definition at line 5941 of file Browser.cs.

WithPages()

IAllowGetGridAndFillInFrom GenerallyPositive.Browser.Browser.WithPages

(

int

pageCount

)

Specified the number of pages to retrieve when using GetGrid or any .SaveTo[CSV|Excel|File]
Must also specify the Next Page button [.WithNextPageButton(selector)] or Infinite scroll [.WithInfiniteScroll] to tell GPAL how to retrieve next pages.
.

Parameters

pageCount

Number of pages to retrieve.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWithPages.

Definition at line 1911 of file Browser.cs.

WithPersistentSelector()

IAllowSelectorInFrameBrowserSettingsOrGoto GenerallyPositive.Browser.Browser.WithPersistentSelector

(

Selector

selector

)

Add a persistent selector to the persistent UOW. Persistent selectors are always looked for whenever you perform an action on a UOW, like LeftClick, Hover, Focus, etc.
Use in conjunction with the PersistentCallIf handlers to create workflows to deal with the persistent selector(s).
Selectors may remove themselves from a UOW by using selector.Remove()
Only one persistent Unit of Work exists. All selectors are evaluated in the order they are defined.
Example: For browser, a persistent selector could look for a popup panel like 'Accept all cookies' that displays on all pages and may block processing.. NOTE: persisten selectors are only looked for in content/frame 0 as they are designed to deal with page popups eminating from base content. Use workflows to deal with elements in frames.

Parameters

selector

The GPAL Selector for the persistent element

Returns

A fluent interface to define more persistent selectors

Implements GenerallyPositive.Browser.IAllowWithPersistentSelector.

Definition at line 2118 of file Browser.cs.

WithProfileDataDirectory()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithProfileDataDirectory

(

string

profileDataDirectory

)

Specify the profile directory to use for this browser automation session NOTE: if both Profile User Name and Profile Directory are defined, the specific directory will be used.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithProfileDataDirectory(@"c:\profileDataDirectory")
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithWaitOnDocumentReady(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

profileDirectory

Path to the browser profile to use

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 968 of file Browser.cs.

WithProfileName()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithProfileName

(

string

profileName

)

Specify the profile name to use under the data directory for this browser automation session NOTE: use this if a data directory contains multiple profile directories and you do not want to use the default profile.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithProfileName(profileName)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithWaitOnDocumentReady(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

profileName

Name of the browser profile to use

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 1028 of file Browser.cs.

WithProfileUserName()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithProfileUserName

(

string

profileUserName

)

Specify the operating system login username to find the profile directory to use for this browser automation session NOTE: if both Profile User Name and Profile Directory are defined, the specific directory will be used.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithProfileUserName(@"Ottomatic")
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithWaitOnDocumentReady(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

profileDirectory

Path to the browser profile to use

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 1005 of file Browser.cs.

WithPromptForDownload()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithPromptForDownload

(

bool

promptForDownload

)

Set to true to always display the SAVE AS dialog box when downloading a file.
Very useful with LeftClickAndDownload(filename).
When set, every download will prompt you with the SAVE AS dialog, forcing you to fill in the filename.
For maximum ease You can use .LeftClickAndDownload(filename) or write GPAL code like this (example)
.LeftClick().WaitForWindowRegex("([sSaAvVeE])\w+*).SendString(filename).SendKey(GPAL.VK_ENTER).

myBrowser
    .WithPromptForDownload(true)
    .LeftClickAndDownload(fileList);   // NOTE: filename used on save is added to the end of filelist

Parameters

promptForDownload

True to prompt for download save location. False [default] to save downloads to the default save location.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 570 of file Browser.cs.

WithRespectRobotMetaTags()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithRespectRobotMetaTags

(

bool

trueFalse = false

)

Set whether to respect robots-related meta tags (e.g. noindex/nofollow) on the page.

Parameters

trueFalse

True to respect robot meta tags, false [default] to ignore them

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 2576 of file Browser.cs.

WithRestApiUrl()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithRestApiUrl

(

string

restApiUrl

)

Specifies the TCP port number to start the browser, but also connect to this browser session from a completely different GPAL workflow.
NOTE: Mutually exclusive with Debug Pipe, DebugPipe will take precedence, if specific with DebugPort.

// open a browser using debug port 6565
Browser browser1 = (Browser)GPAL.Browser
    .WithBrowserType(browserType)
    .WithDriverLocation(gPALInput.Text)
    .WithDebugPort(6565)
    .WithWaitOnDocumentReady(true)
    .GoTo("https://studio.youtube.com");
 
// create an entirely new session connecting to the browser1 session
Browser browser2 = (Browser)GPAL.Browser
    .WithExistingBrowser(6565)
    .WithWaitOnDocumentReady(true)
    .WithSelector(detailsTab).LeftClick();
 
browser1.Close(true);   // no need to close 2, it's the same

Parameters

port	The TCP port number to connect with to control the browser

Returns

Fluent interface to specify more Browser settings or GoTo

Drives a browser whose GPALRestAPI is already running, rather than launching one. The address is the base url that GPALRestAPI is serving on, which it reports in its own window, e.g. http://localhost:3117/ for a browser already open here or http://vm2:3117/ for one on another machine that has had its LAN access opened.

The browser is not ours once this is set: GPAL does not start it, does not bring its window to the front, and Close closes the window it was working in rather than killing anything.

IBrowser browser = GPAL.Browser
    .WithAutomationEngine(AutomationEngine.OttoMagic)
    .WithRestApiUrl("http://vm2:3117/")
    .GoTo("https://www.example.com")
    .ToGPALObject();

Parameters

restApiUrl

The base url GPALRestAPI is serving on

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowDebugPort.

Definition at line 717 of file Browser.cs.

WithScrollIntoView()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithScrollIntoView

(

bool

trueFalse = true

)

Scroll each scraped element into view as it is read, so the page visibly follows the workflow.
This is for watching a run, not for correctness: GPAL reads elements whether or not they are on screen. Ignored in headless, where there is nothing to watch, and skipped for GPALElement matches, which have no place on the page to scroll to.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .WithScrollIntoView()
    .GoTo("https://www.ebay.com/")

Parameters

trueFalse

True [default] to scroll each element into view as it is scraped. False to leave the page where it is.

Returns

Fluent interface to specify more Browser settings or GoTo

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 549 of file Browser.cs.

WithSelector() [1/3]

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.WithSelector

(

Func< string >

dataFunction

)

Add literal data to a grid by invoking this function when using .GetGrid.

Parameters

dataFunction

Returns

Implements GenerallyPositive.Browser.IAllowWithData.

Definition at line 1181 of file Browser.cs.

WithSelector() [2/3]

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.WithSelector

(

Selector

selector

)

Add a selector to the current UOW. Selectors make up a Unit of Work (UOW) to perform actions upon.
A UOW is: All selectors defined between actions like GoTo, LeftClick, Hover, Focus, etc.
Use in conjunction with the CallIf handlers to create workflows to deal with found/not found selector(s).
Selectors may remove themselves from a UOW by using selector.Remove()
.

Selector inputSearchSelector = (Selector)GPAL.Selector
    .WithName("SearchInput")
    .WithCSS("#gh-ac")
    .WithXPath("//*[@id=\"gh-ac\"]")
    .MatchPlaceholder("Search for anything");
 
Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithWaitOnDocumentReady(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

selector

The GPAL Selector for the persistent element

Returns

A fluent interface to define more persistent selectors

Implements GenerallyPositive.Browser.IAllowWithSelector.

Definition at line 1108 of file Browser.cs.

WithSelector() [3/3]

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.WithSelector

(

string

literalData

)

Add literal data to a grid when using .GetGrid.

Parameters

literalData

Returns

Implements GenerallyPositive.Browser.IAllowWithData.

Definition at line 1149 of file Browser.cs.

WithStorageData()

IAllowStorageOptions GenerallyPositive.Browser.Browser.WithStorageData

(

string

data

)

Specifies the data value to write for the next storage .RunSet action. Starts a new StorageAction if the previous one was already run.

Parameters

data	Data value to write to storage

Returns

Fluent interface to specify more storage options or run the action

Implements GenerallyPositive.Browser.IAllowStorageData.

Definition at line 1437 of file Browser.cs.

WithStorageDomain()

IAllowStorageOptions GenerallyPositive.Browser.Browser.WithStorageDomain

(

string

domain

)

Specifies the domain to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.

Parameters

domain

Domain to scope the storage action to

Returns

Fluent interface to specify more storage options or run the action

Implements GenerallyPositive.Browser.IAllowStorageOptions.

Definition at line 1361 of file Browser.cs.

WithStorageKey()

IAllowStorageOptions GenerallyPositive.Browser.Browser.WithStorageKey

(

string

key

)

Specifies the key to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.

Parameters

key	Key to scope the storage action to

Returns

Fluent interface to specify more storage options or run the action

Implements GenerallyPositive.Browser.IAllowStorageOptions.

Definition at line 1399 of file Browser.cs.

WithStoragePath()

IAllowStorageOptions GenerallyPositive.Browser.Browser.WithStoragePath

(

string

path

)

Specifies the path to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.

Parameters

path	Path to scope the storage action to

Returns

Fluent interface to specify more storage options or run the action

Implements GenerallyPositive.Browser.IAllowStorageOptions.

Definition at line 1380 of file Browser.cs.

WithStorageStoreName()

IAllowStorageOptions GenerallyPositive.Browser.Browser.WithStorageStoreName

(

string

storeName

)

Specifies the IndexedDB store name to scope the next storage Run* action to. Starts a new StorageAction if the previous one was already run.

Parameters

storeName

IndexedDB store name to scope the storage action to

Returns

Fluent interface to specify more storage options or run the action

Implements GenerallyPositive.Browser.IAllowStorageOptions.

Definition at line 1418 of file Browser.cs.

WithTokensFrom() [1/4]

IAllowWithPagesAndFetch GenerallyPositive.Browser.Browser.WithTokensFrom

(

GPALDatabase

inputDatabase

)

Parameters

inputDatabase

The GPAL Database definition. One column per token, one row per set of requests

Implements GenerallyPositive.Browser.IAllowWithTokensFrom.

Definition at line 1939 of file Browser.cs.

WithTokensFrom() [2/4]

IAllowWithPagesAndFetch GenerallyPositive.Browser.Browser.WithTokensFrom

(

GPALFile

inputFile

)

Parameters

inputFile

The GPAL File definition. CSV values per line, one line per set of requests

Implements GenerallyPositive.Browser.IAllowWithTokensFrom.

Definition at line 1930 of file Browser.cs.

WithTokensFrom() [3/4]

IAllowWithPagesAndFetch GenerallyPositive.Browser.Browser.WithTokensFrom

(

IGPALGrid< string >

inputGrid

)

Supply the values .Fetch drops into the numbered tokens of its request, one row per set of requests.
A column of the row fills the token of the same number, so the first column fills {0}, the second {1}, the same way FillInFrom hands a row of tokens to a row of inputs.

Parameters

inputGrid

The input grid of tokens

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWithTokensFrom.

Definition at line 1923 of file Browser.cs.

WithTokensFrom() [4/4]

IAllowWithPagesAndFetch GenerallyPositive.Browser.Browser.WithTokensFrom

(

string

tokens

)

Parameters

tokens

A single row of tokens, written as comma separated values

Implements GenerallyPositive.Browser.IAllowWithTokensFrom.

Definition at line 1948 of file Browser.cs.

WithUseDebugPipe()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUseDebugPipe

(

bool

trueFalse = false

)

Use CDP protocol over pipes, should this impply CDP because selenium doesn't support pipe, so this is all us? NOTE: Mutually exclusive with Debug Pipe, DebugPipe will take precedence, if specific with DebugPort NOTE: Firefox does not support CDP pipes.

Parameters

trueFalse

Returns

Implements GenerallyPositive.Browser.IAllowDebugPort.

Definition at line 794 of file Browser.cs.

WithUseDebugPort()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUseDebugPort

(

int

port = 0xdead

)

Implements GenerallyPositive.Browser.IAllowDebugPort.

Definition at line 737 of file Browser.cs.

WithUseDirectDownload()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUseDirectDownload

(

bool

trueFalse

)

For use with .RightClickAndDownload, use websockets to directly download what the webelement references.

Parameters

trueFalse

False [default - open context, choose save as]

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 297 of file Browser.cs.

WithUserAgentFromBrowser()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUserAgentFromBrowser

(

bool

userAgentFromBrowser = true

)

Launch a browser purely to read its own user agent, instead of working one out without one.
Headless browsers announce themselves in their user agent, so GPAL has always started a browser, read the real string, and taken the word Headless back out of it. That costs a browser launch on every headless start, and it is only worth paying when nothing better is known.
Off by default, in which case the user agent comes from WithUseUserAgent if it was set, then the userAgent in gpal.yaml, then the per-browser template in gpal.yaml with the installed version filled in, which needs no browser and is what GPAL's own requests already use.

Parameters

userAgentFromBrowser

True to launch a browser to read its user agent

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 1078 of file Browser.cs.

WithUserDefinedFilter()

IAllowStorageOptions GenerallyPositive.Browser.Browser.WithUserDefinedFilter

(

string

userDefined

)

Specifies a user-defined filter string passed through to the storage action implementation. Starts a new StorageAction if the previous one was already run.

Parameters

userDefined

User-defined filter value

Returns

Fluent interface to specify more storage options or run the action

Implements GenerallyPositive.Browser.IAllowStorageOptions.

Definition at line 1456 of file Browser.cs.

WithUseReferrer()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUseReferrer

(

string

referrer = ""

)

Set the refererrer to use with any Goto or Get for the rest of the browser sessions. Will only clear if you clear it explicitly with an empty string or no parameter.

Parameters

referrer

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 1051 of file Browser.cs.

WithUseStealth()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUseStealth

(

StealthType

steathType

)

Use stealth operations to block bot detection use Runtime.disable before clicking login button Add persistent script the runs before all others to inject anti-CDP detection script.

Parameters

trueFalse

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 1040 of file Browser.cs.

WithUseUserAgent()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithUseUserAgent

(

string

userAgent = ""

)

Set the user agent to use with any Goto or Get for the rest of the browser sessions. Will only clear if you clear it explicitly with an empty string or no parameter.

Parameters

userAgent

Returns

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 1062 of file Browser.cs.

WithWaitForWindowTimeout()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Browser.Browser.WithWaitForWindowTimeout

(

int

waitTimeInSeconds

)

Define the time in seconds to WaitForWindow/Regex.

Parameters

waitTimeInSeconds

Wait time in seconds

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWaitForWindow.

Definition at line 2006 of file Browser.cs.

WithWaitOnDocumentReady()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithWaitOnDocumentReady

(

int

timeoutInMs

)

Specifies GPAL will wait for a true in the browser DocumentReady flag before trying to locate elements.
Mutally excludes WithWaitOnNetworkIdle - setting this true will set WithWaitOnNetworkIdle to false.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithWaitOnDocumentReady(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

trueFalse

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowBrowserSettings.

Definition at line 819 of file Browser.cs.

WithWaitOnIdleConnection()

IAllowBrowserSettingsOrGoTo GenerallyPositive.Browser.Browser.WithWaitOnIdleConnection

(

bool

trueFalse = true

)

Specifies GPAL will wait for network to be idle on current page before trying to locate elements.
Mutally excludes WithWaitOnDocumentReady - setting this true will set WithWaitOnDocumentReady to false.

Browser myBrowser = (Browser)GPAL.Browser
    .WithBrowserType(BrowserType.Chrome)
    .WithDriverLocation(@"c:\drivers")
    .GoTo("https://www.ebay.com/")
    .WithNetworkIdleTimeoutMs(500)  // already the default value
    .WithNetworkIdlePruneMs(10_000) // already the default value
    .WithNetworkIdleMaxConnections(0)   // already the default value
    .WithWaitOnNetworkIdle(true)
    .WithSelector(inputSearchSelector)
    .FillInFrom("Find me");

Parameters

maxConnections

Returns

Fluent interface to specify more Browser settings

Implements GenerallyPositive.Browser.IAllowNetworkIdleSettings.

Definition at line 869 of file Browser.cs.

WithWindowSize()

IAllowAllBrowserAndAllSelector GenerallyPositive.Browser.Browser.WithWindowSize

(

Rectangle

windowSize

)

Set the default window size for when the browser opens. As well, exiting fullscreen will return to this size. IF NOT SET: 'Normal' to restore the window will restore the window to the Size before enterinng fullscreen.

Parameters

windowSize

Cannot be less than 100 in either dimension, nor larger than screen size

Returns

Fluent interface to write your workflow

Definition at line 2204 of file Browser.cs.

WithWorkflow()

IAllowWorkflowExecution GenerallyPositive.Browser.Browser.WithWorkflow

(

Action< IBrowser >

workflow

)

Adds a workflow to run against this browser, used with Run, While and Until(Selector). Workflows run in the order they were added, one after another, and the browser handed to each is this one.

The list is what While and Until(Selector) repeat, which is what makes it worth having: a page of results and a Next button is one workflow run until the button is gone.

To run several workflows at once, each with a browser of its own and possibly a different browser or engine, use GPAL.Workflow. This browser runs its workflows sequentially and always has.

Page through search results, gathering each page, until the Next button is no longer there:

browser
    .GoTo("https://www.example.com/search?q=laptop")
    .WithWorkflow(b =>
    {
        b.WithSelector(GPAL.CssSelector(".result-title"))
         .WithAllThatMatch()
         .GetElements(out List<GPALElement> found);
 
        results.AddRange(found);
 
        b.WithSelector(GPAL.CssSelector("a.next")).LeftClick();
    })
    .Until(b => 0 == b.CurrentUOW.WebSelectorFoundResults.Count);

Parameters

workflow

The workflow to run. The browser passed in is this browser.

Returns

Fluent interface to add another workflow, or to run them

Implements GenerallyPositive.Browser.IAllowWorkflow.

Definition at line 8593 of file Browser.cs.

Property Documentation

AreRobotsAllowed

bool GenerallyPositive.Browser.Browser.AreRobotsAllowed

getset

True if the current page's robots.txt/meta tags allow automation, as determined by WithRespectRobotMetaTags.

Definition at line 235 of file Browser.cs.

AutomationEngine

AutomationEngine GenerallyPositive.Browser.Browser.AutomationEngine

getset

The automation engine (OttoMagic, Puppeteer, or Selenium) used by this Browser.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6962 of file Browser.cs.

Back

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Back

get

Navigate back one page.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2281 of file Browser.cs.

BrowserDriver

IWebDriver GenerallyPositive.Browser.Browser.BrowserDriver

getset

The browser driver controlling the current Browser.
Only available after the first .GoTo
NOTE: Only for extended Selenium control access. Be careful.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7021 of file Browser.cs.

BrowserSettings

BrowserSettings GenerallyPositive.Browser.Browser.BrowserSettings

getset

The settings backing this Browser, including configuration, state, and engine handles.

Definition at line 7047 of file Browser.cs.

BrowserType

BrowserType GenerallyPositive.Browser.Browser.BrowserType

get

Return the current browser type.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6986 of file Browser.cs.

BrowserVersion

string GenerallyPositive.Browser.Browser.BrowserVersion

getset

The version of the browser being automated.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 8697 of file Browser.cs.

CurrentTabIdx

int GenerallyPositive.Browser.Browser.CurrentTabIdx = 0

getset

Index of the currently active browser tab/window.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 222 of file Browser.cs.

CurrentUrl

string GenerallyPositive.Browser.Browser.CurrentUrl

getset

The URL of the page currently loaded in the browser.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6926 of file Browser.cs.

FileDownloaded

bool? GenerallyPositive.Browser.Browser.FileDownloaded

getset

True if the most recent download action successfully downloaded a file. Null if no download has been attempted.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6970 of file Browser.cs.

Forward

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Forward

get

Navigate forward one page.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2302 of file Browser.cs.

FullScreen

IAllowAllBrowserAndAllSelector GenerallyPositive.Browser.Browser.FullScreen

get

Make the browser window fullscreen, saving the current window size so it can be restored later via Restore.

Implements GenerallyPositive.Browser.IAllowSizeControl.

Definition at line 2458 of file Browser.cs.

HiddenDesktop

IHiddenDesktop GenerallyPositive.Browser.Browser.HiddenDesktop

get

The hidden desktop this browser is running on, or null when it is on the desktop you are looking at. Null rather than an empty object, the same way RestApiBaseUrl is null on a browser not running OttoMagic, so a workflow can ask whether there is one by asking for it.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7120 of file Browser.cs.

IsAlive

bool GenerallyPositive.Browser.Browser.IsAlive

get

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7078 of file Browser.cs.

JavaScriptResultObj

object GenerallyPositive.Browser.Browser.JavaScriptResultObj

getset

The result object returned by the most recent ExecuteJavaScriptObj call.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 8681 of file Browser.cs.

JavaScriptResultStr

string GenerallyPositive.Browser.Browser.JavaScriptResultStr

getset

The result string returned by the most recent ExecuteJavaScriptStr call.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 8689 of file Browser.cs.

MagicHelper

MagicHelper GenerallyPositive.Browser.Browser.MagicHelper

get

The MagicHelper used to issue commands when this Browser is using the OttoMagic engine.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7108 of file Browser.cs.

Maximize

IAllowAllBrowserAndAllSelector GenerallyPositive.Browser.Browser.Maximize

get

Maximize the browser to full-screen.

Implements GenerallyPositive.Browser.IAllowSizeControl.

Definition at line 2491 of file Browser.cs.

Minimize

IAllowAllBrowserAndAllSelector GenerallyPositive.Browser.Browser.Minimize

get

Minimize the browser to the taskbar.

Implements GenerallyPositive.Browser.IAllowSizeControl.

Definition at line 2527 of file Browser.cs.

NextTab

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.NextTab

get

Navigate to the next tab. If at the last tab nothing will happen. NOTE: New window is just another tab. So, if a window is opened, should be able to still use .NextTab.

The browser window comes to the front when this switches tabs under Puppeteer and Selenium, and does not under OttoMagic. That is the protocol, not a choice.
An extension has two separate calls, chrome.tabs.update({active:true}) to make a tab current and chrome.windows.update({focused:true}) to raise its window, so OttoMagic uses the first and never the second. CDP has no equivalent split: Target.activateTarget (and Page.bringToFront) focus the tab and raise the window as one operation, and Selenium's SwitchTo().Window() is implemented on top of it.
So a windowed Puppeteer or Selenium workflow that switches tabs takes the window over while it runs. Run headless to avoid it entirely.

Returns

Implements GenerallyPositive.Browser.IAllowTabActions.

Definition at line 3319 of file Browser.cs.

NextWindow

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.NextWindow

get

Switches focus to the next browser tab/window in the window list, wrapping around to the first.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWindowActions.

Definition at line 8057 of file Browser.cs.

OttoMagicClient

IRESTClient GenerallyPositive.Browser.Browser.OttoMagicClient

get

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7113 of file Browser.cs.

PageDown

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PageDown

get

Scroll the current tab window down one page.

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2347 of file Browser.cs.

PageEnd

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PageEnd

get

Scroll the current tab window to the bottom of the page.

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2366 of file Browser.cs.

PageTop

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PageTop

get

Scroll the current tab window to the top of the page.

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2385 of file Browser.cs.

PageUp

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PageUp

get

Scroll the current tab window up one page.

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2404 of file Browser.cs.

PreviousTab

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PreviousTab

get

Navigate to the previous tab. If at the first tab nothing will happen.

The browser window comes to the front when this switches tabs under Puppeteer and Selenium, and does not under OttoMagic. That is the protocol, not a choice.
An extension has two separate calls, chrome.tabs.update({active:true}) to make a tab current and chrome.windows.update({focused:true}) to raise its window, so OttoMagic uses the first and never the second. CDP has no equivalent split: Target.activateTarget (and Page.bringToFront) focus the tab and raise the window as one operation, and Selenium's SwitchTo().Window() is implemented on top of it.
So a windowed Puppeteer or Selenium workflow that switches tabs takes the window over while it runs. Run headless to avoid it entirely.

Returns

Implements GenerallyPositive.Browser.IAllowTabActions.

Definition at line 3412 of file Browser.cs.

PreviousWindow

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.PreviousWindow

get

Switches focus to the previous browser tab/window in the window list, wrapping around to the last.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowWindowActions.

Definition at line 8224 of file Browser.cs.

Process

Process GenerallyPositive.Browser.Browser.Process

get

The OS process hosting the browser, if started and tracked by GPAL.

Definition at line 6955 of file Browser.cs.

PuppeteerClient

IPuppeteerClient GenerallyPositive.Browser.Browser.PuppeteerClient

getset

The Puppeteer client used to issue commands when this Browser is using the Puppeteer engine.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7100 of file Browser.cs.

PuppeteerCommunicator

PuppeteerCommunicator GenerallyPositive.Browser.Browser.PuppeteerCommunicator

getset

Communicator used to send/receive messages to the Puppeteer engine for this Browser.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7072 of file Browser.cs.

Refresh

IAllowBrowserActionOrAnySelector GenerallyPositive.Browser.Browser.Refresh

get

Refresh the current page.

Returns

Fluent interface to write your workflow

Implements GenerallyPositive.Browser.IAllowPageControl.

Definition at line 2323 of file Browser.cs.

RestApiBaseUrl

string GenerallyPositive.Browser.Browser.RestApiBaseUrl

get

Where this browser's GPALRestAPI is listening, e.g. http://localhost:3117/, taken from the port it announced while starting. Null on a browser not running OttoMagic, which has no REST API of its own.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 7037 of file Browser.cs.

Restore

IAllowAllBrowserAndAllSelector GenerallyPositive.Browser.Browser.Restore

get

Restore the browser to window state, unminimize.

Implements GenerallyPositive.Browser.IAllowSizeControl.

Definition at line 2423 of file Browser.cs.

RobotsTxt

List<string> GenerallyPositive.Browser.Browser.RobotsTxt

getset

The lines of the current site's robots.txt, as parsed by WithRespectRobotMetaTags/WithObeyRobotsTxt.

Definition at line 8673 of file Browser.cs.

ServerResponseCode

int GenerallyPositive.Browser.Browser.ServerResponseCode

getset

HTTP status code of the most recent page navigation/response.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6917 of file Browser.cs.

UseOttoMagic

bool GenerallyPositive.Browser.Browser.UseOttoMagic

get

True if this Browser is using the OttoMagic automation engine.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6948 of file Browser.cs.

UsePuppeteer

bool GenerallyPositive.Browser.Browser.UsePuppeteer

get

True if this Browser is using the Puppeteer automation engine.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6941 of file Browser.cs.

UseSelenium

bool GenerallyPositive.Browser.Browser.UseSelenium

get

True if this Browser is using the Selenium automation engine.

Implements GenerallyPositive.Browser.IBrowser.

Definition at line 6934 of file Browser.cs.

WithHardware

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.WithHardware

get

Specifies to use hardware emulation when interacting with the Selector just defined with .WithSelector. Use this to override what is defined on the Selector.
Selenium is the default method to interact with elements, but sometimes hardware emulation is the only way that works.
You can also specify to execute javascript on the page to interact with elements.

Implements GenerallyPositive.Browser.IAllowWithHardware.

Definition at line 2240 of file Browser.cs.

WithInfiniteScroll

IAllowWithPagesAndGridActions GenerallyPositive.Browser.Browser.WithInfiniteScroll

get

Indicates the current page does not have a Next Page button, but an infinite scroll.
GPAL pagination then consists of moving to the bottom and waiting for the DocumentReady before paging again.

Implements GenerallyPositive.Browser.IAllowWithInfiniteScroll.

Definition at line 2268 of file Browser.cs.

WithJavaScript

IAllowAfterAnySelector GenerallyPositive.Browser.Browser.WithJavaScript

get

Specifies to execute javascript on the page to interact with the Selector just defined with .WithSelector. Use this to override what is defined on the Selector.
This is different than Selenium interaction. Selenium is the default method to interact with elements, but sometimes that doesn't work as expected.
You can also specify to use hardware emulation to interact with elements.

Implements GenerallyPositive.Browser.IAllowWithJavaScript.

Definition at line 2255 of file Browser.cs.

---

The documentation for this class was generated from the following file:

• Browser/Browser.cs