Class GPAL.GPALEventArgs

Used to pass objects of interest when publishing an Information or Exception Channel message
NOTE: Properties are contextual to where the Information/Exception is published.
Only objects relevant to that context will be passed as an event argument, the rest will be null.
In this way, the programmer can examine aspects when the message is published and utilize those for logging or debugging or fault-tolerance handling.
Every event will have a GPALObject as applicable to the context publishing the message.

Inheritance

System.Object

System.EventArgs

GPAL.GPALEventArgs

Inherited Members

System.EventArgs.Empty

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: GenerallyPositive

Assembly: GPAL.dll

Syntax

public class GPALEventArgs : EventArgs

Properties

AutomationElement

The current AutomationElement

Declaration

public AutomationElement AutomationElement { get; set; }

Property Value

Type	Description
System.Windows.Automation.AutomationElement

AutomationElements

List of AutomationElements returned for the given Application Selector

Declaration

public List<GPALAutomationElement> AutomationElements { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GPALAutomationElement>

BrowserDriver

The browser driver instantiated and used to connect to the browser.

Declaration

public IWebDriver BrowserDriver { get; set; }

Property Value

Type	Description
OpenQA.Selenium.IWebDriver

CurrentUOW

The Current Unit of Work for the GPALObject supplied.
GPALObject (depending upon context) might also be the CurrentUOW, in which case it will also be here.

Declaration

public UnitOfWork CurrentUOW { get; set; }

Property Value

Type	Description
UnitOfWork

Data

Any type of data that does not fite in the above, converter data, for example

Declaration

public dynamic Data { get; set; }

Property Value

Type	Description
System.Object

DateTimeStamp

The date/time this event is published

Declaration

public DateTime DateTimeStamp { get; set; }

Property Value

Type	Description
System.DateTime

ExceptionRaised

The Exception being published on the Exception channel.

Declaration

public Exception ExceptionRaised { get; set; }

Property Value

Type	Description
System.Exception

GPALElement

The current web element

Declaration

public GPALElement GPALElement { get; set; }

Property Value

Type	Description
GPALElement

GPALEventType

Declaration

public Enums.GPALEventType GPALEventType { get; set; }

Property Value

Type	Description
Enums.GPALEventType

GPALObject

Current context's Application, Browser, GPALForm, UnitOfWork object

Declaration

public dynamic GPALObject { get; set; }

Property Value

Type	Description
System.Object

GPALObjectType

GPALObjectType enumeration: None, Application, Browser, GPALForm, UnitOfWork

Declaration

public Enums.GPALObjectType GPALObjectType { get; set; }

Property Value

Type	Description
Enums.GPALObjectType

Message

The Message being published to the Information/Exception channel.

Declaration

public string Message { get; set; }

Property Value

Type	Description
System.String

ScreenShot

Every message is accompanied by an automatic screenshot in case this additional information provides some insight as to what GPAL is currently doing.

Declaration

public Image ScreenShot { get; set; }

Property Value

Type	Description
System.Drawing.Image

Selector

The current Selector being used

Declaration

public Selector Selector { get; set; }

Property Value

Type	Description
Selector

SelectorPathEntry

The SelectorPathEntry is the current path (css, xpath, text, image, etc) being evaluated/used to find/handle an element A selector may have multiple selector paths in order to evaluate/handle an element

Declaration

public SelectorSettings.SelectorPathEntry SelectorPathEntry { get; set; }

Property Value

Type	Description
SelectorSettings.SelectorPathEntry

SqlCommand

SqlCommand which threw an exception

Declaration

public SqlCommand SqlCommand { get; set; }

Property Value

Type	Description
System.Data.SqlClient.SqlCommand

TokenList

List of Grids associated with GPALFile

Declaration

public List<IGPALGrid<string>> TokenList { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<IGPALGrid<System.String>>

Tokens

GPALGrid [rows/columns] of tokens being used to fill input

Declaration

public IGPALGrid<string> Tokens { get; set; }

Property Value

Type	Description
IGPALGrid<System.String>

WebElements

List of WebElements returned for the given Browser Selector

Declaration

public List<GPALElement> WebElements { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GPALElement>