Scraperion.xml
<?xml version="1.0"?>
<doc> <assembly> <name>Scraperion</name> </assembly> <members> <member name="T:Scraperion.ConnectWebScraper"> <summary> <para type="synopsis">This cmdlet creates a WebScrapper object.</para> <para type="description">This cmdlet creates a WebScrapper object and connects a chromium instance to it.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Credential"> <summary> <para type="description">Credentials to use to connect to page.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Width"> <summary> <para type="description">Width of web page in pixels.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Height"> <summary> <para type="description">Height of web page in pixels.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Url"> <summary> <para type="description">Initial url to connect to.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.ShowUI"> <summary> <para type="description">Pass switch to show chromium browser window. Useful for debugging.</para> </summary> </member> <member name="P:Scraperion.ConnectWebScraper.Agent"> <summary> <para type="description">Browser agent to use when browsing pages.</para> </summary> </member> <member name="M:Scraperion.ConnectWebScraper.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.ConvertFromImageToText"> <summary> <para type="synopsis">Converts image to Text</para> <para type="description">Runs OCR over the image and returns the text returend.</para> </summary> </member> <member name="P:Scraperion.ConvertFromImageToText.Image"> <summary> <para type="description">Image to run ocr over.</para> </summary> </member> <member name="M:Scraperion.ConvertFromImageToText.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.DisconnectWebScraper"> <summary> <para type="synopsis">Disconnects Web scrapper</para> <para type="description">Disconnects from chromium and closes it.</para> </summary> </member> <member name="P:Scraperion.DisconnectWebScraper.Scraper"> <summary> <para type="description">Instance of web scrapper to close.</para> </summary> </member> <member name="M:Scraperion.DisconnectWebScraper.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.FrmImage"> <inheritdoc /> <summary> Class used to preview image files by Show-Image cmdlet. </summary> </member> <member name="M:Scraperion.FrmImage.#ctor(System.Drawing.Image)"> <inheritdoc /> <summary> Constructor </summary> <param name="img">Image to preview.</param> </member> <member name="F:Scraperion.FrmImage.components"> <summary> Required designer variable. </summary> </member> <member name="M:Scraperion.FrmImage.Dispose(System.Boolean)"> <summary> Clean up any resources being used. </summary> <param name="disposing">true if managed resources should be disposed; otherwise, false.</param> </member> <member name="M:Scraperion.FrmImage.InitializeComponent"> <summary> Required method for Designer support - do not modify the contents of this method with the code editor. </summary> </member> <member name="T:Scraperion.GetImage"> <summary> <para type="synopsis">Retrives an image</para> <para type="description">Retrives an image ready for use with screen scrapping cmdlets.</para> </summary> </member> <member name="P:Scraperion.GetImage.Path"> <summary> <para type="description">Path to image to load. Can be most common image formats png, bmp, jpg, etc</para> </summary> </member> <member name="P:Scraperion.GetImage.Screen"> <summary> <para type="description">Use this switch to grab a screenshot of the screen.</para> </summary> </member> <member name="P:Scraperion.GetImage.X"> <summary> <para type="description">X coordinates to being capture from</para> </summary> </member> <member name="P:Scraperion.GetImage.Y"> <summary> <para type="description">Y coordinates to being capture from</para> </summary> </member> <member name="P:Scraperion.GetImage.Width"> <summary> <para type="description">Width of capture.</para> </summary> </member> <member name="P:Scraperion.GetImage.Height"> <summary> <para type="description">Height of capture.</para> </summary> </member> <member name="P:Scraperion.GetImage.Image"> <summary> <para type="description">Another image to do capture from, use X, Y, Width and Hight to select a subsection of image.</para> </summary> </member> <member name="M:Scraperion.GetImage.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.GetWebScraperSnapshot"> <summary> <para type="synopsis">Captures a screenshot of current page.</para> <para type="description">Captures a screenshot of the current page.</para> </summary> </member> <member name="P:Scraperion.GetWebScraperSnapshot.Scraper"> <summary> <para type="description">Scrapper object to take screenshot from.</para> </summary> </member> <member name="P:Scraperion.GetWebScraperSnapshot.Pdf"> <summary> <para type="description">Creates a pdf of the target page instead.</para> </summary> </member> <member name="P:Scraperion.GetWebScraperSnapshot.Path"> <summary> <para type="description">Optional path to store the image or pdf.</para> </summary> </member> <member name="M:Scraperion.GetWebScraperSnapshot.ProcessRecord"> <summary> Main cmdlet logic. </summary> </member> <member name="T:Scraperion.InvokeWebScraperExpression"> <summary> <para type="synopsis">Invokes a javascript command</para> <para type="description">Invokes a javascript command in the browser and returns json of what was executed.</para> </summary> </member> <member name="P:Scraperion.InvokeWebScraperExpression.Scraper"> <summary> <para type="description">Scrapper to invoke javascript on.</para> </summary> </member> <member name="P:Scraperion.InvokeWebScraperExpression.Expression"> <summary> <para type="description">Expression to execute.</para> </summary> </member> <member name="M:Scraperion.InvokeWebScraperExpression.ProcessRecord"> <summary> Powershell cmdlet logic </summary> </member> <member name="T:Scraperion.MoveMouse"> <summary> <para type="synopsis">Moves the mouse on the screen.</para> <para type="description">Moves the mouse to target location on the screen.</para> </summary> </member> <member name="P:Scraperion.MoveMouse.X"> <summary> <para type="description">X coordinate to move mouse to on screen</para> </summary> </member> <member name="P:Scraperion.MoveMouse.Y"> <summary> <para type="description">Y coordinate to move mouse to on screen</para> </summary> </member> <member name="M:Scraperion.MoveMouse.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.MoveWebScraperMouse"> <summary> <para type="synopsis">Simulates moving the mouse to a location on the web page.</para> <para type="description">Simulates moving the mouse to a location on the web page.</para> </summary> </member> <member name="P:Scraperion.MoveWebScraperMouse.Scraper"> <summary> <para type="description">Web scrapper object to move mouse on.</para> </summary> </member> <member name="P:Scraperion.MoveWebScraperMouse.X"> <summary> <para type="description">X coordinate to move mouse to on page</para> </summary> </member> <member name="P:Scraperion.MoveWebScraperMouse.Y"> <summary> <para type="description">Y coordinate to move mouse to on page</para> </summary> </member> <member name="M:Scraperion.MoveWebScraperMouse.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SelectImage"> <summary> <para type="synopsis">Finds an image on the screen and clicks it.</para> <para type="description">Finds an image on the screen and clicks it.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Image"> <summary> <para type="description">Image to search for on the screen.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Button"> <summary> <para type="description">Mouse button to use.</para> </summary> </member> <member name="P:Scraperion.SelectImage.XOffset"> <summary> <para type="description">Offset to click on image when found in X axis.</para> </summary> </member> <member name="P:Scraperion.SelectImage.YOffset"> <summary> <para type="description">Offset to click on image when found in Y axis.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Click"> <summary> <para type="description">Click on target image (mouse down then mouse up).</para> </summary> </member> <member name="P:Scraperion.SelectImage.Up"> <summary> <para type="description">Mouse up on target.</para> </summary> </member> <member name="P:Scraperion.SelectImage.Down"> <summary> <para type="description">Mouse down on target.</para> </summary> </member> <member name="M:Scraperion.SelectImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendKeys"> <summary> <para type="synopsis">Send keys to focused application.</para> <para type="description">Simulates key presses on target application. This uses the standard .net send keys syntax. Enter is {ENTER} etc.</para> <para type="description">For more information see https://docs.microsoft.com/en-us/dotnet/framework/winforms/how-to-simulate-mouse-and-keyboard-events-in-code </para> </summary> </member> <member name="P:Scraperion.SendKeys.Text"> <summary> <para type="description">Text top type in .net Standard send keys syntax.</para> </summary> </member> <member name="P:Scraperion.SendKeys.SecureText"> <summary> <para type="description">Decode a secure string and send that instead. Useful for sending passwords.</para> </summary> </member> <member name="P:Scraperion.SendKeys.Credential"> <summary> <para type="description">Sends the contents of a PSCredential object. Will press tab between username and password.</para> </summary> </member> <member name="M:Scraperion.SendKeys.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendMouse"> <summary> <para type="synopsis">Simulate mouse click.</para> <para type="description">Similar to send keys but for the mouse.</para> </summary> </member> <member name="P:Scraperion.SendMouse.Button"> <summary> <para type="description">Button to simulate.</para> </summary> </member> <member name="P:Scraperion.SendMouse.Click"> <summary> <para type="description">Simulate a mouse click (mouse down then mouse up).</para> </summary> </member> <member name="P:Scraperion.SendMouse.Up"> <summary> <para type="description">Simulates a mouse down.</para> </summary> </member> <member name="P:Scraperion.SendMouse.Down"> <summary> <para type="description">Simulates a mouse up.</para> </summary> </member> <member name="M:Scraperion.SendMouse.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendWebScraperKeys"> <summary> <para type="synopsis">Send key presses to browser.</para> <para type="description">Simulate key presses in browser window.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.Scraper"> <summary> <para type="description">Scraper object to send the key presses to.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.Text"> <summary> <para type="description">Text to send to browser window.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.SecureText"> <summary> <para type="description">Decode a secure string and send that instead. Useful for sending passwords.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperKeys.Credential"> <summary> <para type="description">Sends the contents of a PSCredential object. Will press tab between username and password.</para> </summary> </member> <member name="M:Scraperion.SendWebScraperKeys.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SendWebScraperMouse"> <summary> <para type="synopsis">Sends simulated mouse or tap event to target on page.</para> <para type="description">Simulates a finger press or mouse event on target on page.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Scraper"> <summary> <para type="description">Scraper object to simulat event on.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Button"> <summary> <para type="description">Mouse button to simulate.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Click"> <summary> <para type="description">Simulate a mouse click (mouse down then mouse up).</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Up"> <summary> <para type="description">Simulates a mouse up event.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Down"> <summary> <para type="description">Simulates a mouse down event.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Target"> <summary> <para type="description">Target to apply mouse event to. Use Target selector to specify.</para> </summary> </member> <member name="P:Scraperion.SendWebScraperMouse.Tap"> <summary> <para type="description">Javascript selector to select object to click on. For more details see https://www.w3schools.com/jsref/met_document_queryselector.asp </para> </summary> </member> <member name="M:Scraperion.SendWebScraperMouse.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.SetWebScraperFocus"> <summary> <para type="synopsis">Set element to have focus in web page.</para> <para type="description">Set element in chromium to have focus.</para> </summary> </member> <member name="P:Scraperion.SetWebScraperFocus.Scraper"> <summary> <para type="description">Scraper to set focus on.</para> </summary> </member> <member name="P:Scraperion.SetWebScraperFocus.Target"> <summary> <para type="description">Target to select using javascript selector. For more info see: https://www.w3schools.com/jsref/met_document_queryselector.asp </para> </summary> </member> <member name="M:Scraperion.SetWebScraperFocus.ProcessRecord"> <summary> Powershell logic </summary> </member> <member name="T:Scraperion.ShowImage"> <summary> <para type="synopsis">Shows image</para> <para type="description">Opens a preview window for an image object. Useful for debugging.</para> </summary> </member> <member name="P:Scraperion.ShowImage.Image"> <summary> <para type="description">Image object to preview</para> </summary> </member> <member name="M:Scraperion.ShowImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.Startup"> <summary> Contains code that runs when module is loaded. DPI awareness code needs to be called before any image preview code is done to make screen coordinates work properly. </summary> </member> <member name="M:Scraperion.Startup.OnImport"> <summary> Module startup code </summary> </member> <member name="T:Scraperion.TestImage"> <summary> <para type="synopsis">Return if target image appears on the screen or not.</para> <para type="description">Test if image appears on the screen or not.</para> </summary> </member> <member name="P:Scraperion.TestImage.Image"> <summary> <para type="description">Image to test the existance of.</para> </summary> </member> <member name="P:Scraperion.TestImage.SearchInImage"> <summary> <para type="description">Image to search in. If left blank screen is used instead.</para> </summary> </member> <member name="M:Scraperion.TestImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.WaitImage"> <summary> <para type="synopsis">Wait for image to appear on screen.</para> <para type="description">Wait for image to appear on screen.</para> </summary> </member> <member name="P:Scraperion.WaitImage.Image"> <summary> <para type="description">Image to wait for.</para> </summary> </member> <member name="M:Scraperion.WaitImage.ProcessRecord"> <summary> Powershell logic. </summary> </member> <member name="T:Scraperion.WaitWebScraperExpression"> <summary> <para type="synopsis">Wait for web scrapper expression to be true.</para> <para type="description">Wait for web scrapper expression to be true.</para> </summary> </member> <member name="P:Scraperion.WaitWebScraperExpression.Scraper"> <summary> <para type="description">Scraper to wait on expression to be true.</para> </summary> </member> <member name="P:Scraperion.WaitWebScraperExpression.Expression"> <summary> <para type="description">Javascript expression to test.</para> </summary> </member> <member name="M:Scraperion.WaitWebScraperExpression.ProcessRecord"> <summary> Powershell logic. </summary> </member> </members> </doc> |