GPAL - Generally Positive Automation Library v1.0
GPAL The Fluent Automation LIbrary
Loading...
Searching...
No Matches
GenerallyPositive.Application.IApplication Interface Reference
Inheritance diagram for GenerallyPositive.Application.IApplication:
GenerallyPositive.Application.IAllowWithGridToSave GenerallyPositive.Application.IAllowGetGridAndFillInFrom GenerallyPositive.Application.IAllowWithPagesAndGridActions GenerallyPositive.Application.IAllowWithHeaderOrFileActions GenerallyPositive.Application.IAllowApplicationSettings GenerallyPositive.Application.IAllowApplicationSettingsOrOpen GenerallyPositive.Application.IAllowApplicationOpenOrParameters GenerallyPositive.Application.IAllowAllExceptParameters GenerallyPositive.Application.IAllowAfterAnySelectorExceptWithAll GenerallyPositive.Application.IAllowPersistence GenerallyPositive.Application.IAllowAfterWaitForAndSizeControl GenerallyPositive.Application.IAllowSizeControl GenerallyPositive.Application.IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IAllowAllApplicationAndAllSelector GenerallyPositive.Application.IAllowAllActionAndAnySelector GenerallyPositive.Application.Application

Public Member Functions

IAllowAfterAnySelectorExceptWithAll WithAllThatMatch (int rowCount=int.MaxValue)
IAllowSelectorActionOrAnySelector AppendFrom (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector AppendFrom (IGPALFile inputFile)
IAllowSelectorActionOrAnySelector AppendFrom (IGPALGrid< string > inputGrid)
IAllowSelectorActionOrAnySelector AppendFrom (string textToUse)
IAllowAfterAnySelector CallAfterFillIn (Application.CallAfterFillInDelegate callAfterFillIn)
IAllowAfterAnySelector CallIfFound (Application.CallIfDelegate callIfFoundDelegate)
IAllowAfterAnySelector CallIfNotFound (Application.CallIfDelegate callIfNotFoundDelegate)
void Close ()
IAllowAllActionAndAnySelector CloseTab (string URL)
IAllowSelectorActionOrAnySelector FillInFrom (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector FillInFrom (IGPALFile inputFile)
IAllowSelectorActionOrAnySelector FillInFrom (IGPALGrid< string > inputGrid)
IAllowSelectorActionOrAnySelector FillInFrom (string textToUse)
IAllowSelectorActionOrAnySelector Focus ()
IAllowSelectorActionOrAnySelector Hover ()
IAllowSelectorActionOrAnySelector InsertFromDatabase (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector InsertFromFile (IGPALFile inputFile)
IAllowSelectorActionOrAnySelector InsertFromGrid (IGPALGrid< string > inputGrid)
IAllowSelectorActionOrAnySelector InsertFrom (string textToUse)
IAllowSelectorActionOrAnySelector LeftClick (Enums.ModifierKeys modifierKeys)
IAllowSelectorActionOrAnySelector LeftClickAndDownload (string filename)
IAllowSelectorActionOrAnySelector LeftDoubleClick ()
IAllowSelectorActionOrAnySelector MoveTo ()
IAllowAllActionAndAnySelector NextTab ()
IAllowAllApplicationAndAllSelector Open (string applicationPath)
IAllowPersistentCallBack PersistentCallIfFound (Application.CallIfDelegate persistentCallIfFound)
IAllowPersistentCallBack PersistentCallIfNotFound (Application.CallIfDelegate persistentCallIfNotFound)
IAllowAllActionAndAnySelector PreviousTab ()
void RemoveCallIfHandlerEverywhere (Application.CallIfDelegate func)
IAllowSelectorActionOrAnySelector RightClick ()
IAllowAfterWaitForAndSizeControl WaitFor (int timeoutInTicks)
IAllowAfterWaitForAndSizeControl WaitForWindow (string windowTitle)
IAllowAfterWaitForAndSizeControl WaitForWindowRegex (string _)
IAllowPersistence WithPersistentSelector (Selector selector)
IAllowAfterAnySelector WithSelector (Selector selector)
IAllowAfterWaitForAndSizeControl WithWaitForWindowTimeout (int waitTimeInSeconds)
Public Member Functions inherited from GenerallyPositive.Application.IAllowTabActions
IAllowAllActionAndAnySelector SwitchToTab (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Application.IAllowSizeControl
IAllowAllApplicationAndAllSelector ResizeWindow (int width, int height)
IAllowAllApplicationAndAllSelector MoveWindow (int x, int y)
Public Member Functions inherited from GenerallyPositive.Application.IAllowClicks
IAllowSelectorActionOrAnySelector LeftClick (Selector selector=null)
IAllowSelectorActionOrAnySelector LeftClick (ModifierKeys modifierKeys)
IAllowSelectorActionOrAnySelector LeftDoubleClick (Selector selector=null)
IAllowSelectorActionOrAnySelector MiddleClick (Selector selector=null)
IAllowSelectorActionOrAnySelector RightClick (Selector selector=null)
IAllowSelectorActionOrAnySelector DragAndDrop (Selector selector=null)
IAllowSelectorActionOrAnySelector DragAndDrop (ModifierKeys modifierKeys)
Public Member Functions inherited from GenerallyPositive.Application.IAllowFillInFrom
IAllowSelectorActionOrAnySelector FillInFrom (GPALFile inputFile)
IAllowSelectorActionOrAnySelector AppendFrom (GPALFile inputFile)
IAllowSelectorActionOrAnySelector InsertFrom (GPALFile inputFile)
IAllowSelectorActionOrAnySelector InsertFrom (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector InsertFrom (IGPALGrid< string > inputGrid)
Public Member Functions inherited from GenerallyPositive.Application.IAllowFocus
IAllowSelectorActionOrAnySelector Focus (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Application.IAllowHover
IAllowSelectorActionOrAnySelector Hover (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Application.IAllowMoveTo
IAllowSelectorActionOrAnySelector MoveTo (Selector selector=null)
Public Member Functions inherited from GenerallyPositive.Application.IAllowScrolling
IAllowSelectorActionOrAnySelector ScrollHorizontalSmall (int iterations)
IAllowSelectorActionOrAnySelector ScrollHorizontalLarge (int iterations)
IAllowSelectorActionOrAnySelector ScrollHorizontalPercent (int percent)
IAllowSelectorActionOrAnySelector ScrollVerticalSmall (int iterations)
IAllowSelectorActionOrAnySelector ScrollVerticalLarge (int iterations)
IAllowSelectorActionOrAnySelector ScrollVerticalPercent (int percent)
Public Member Functions inherited from GenerallyPositive.Application.IAllowKeyboardActions
IAllowSelectorActionOrAnySelector SendString (string textToSend)
 Simulates typing via hardware key events, one character at a time. Honors GPAL.TypingDelay (see GPAL.WithTypingDelay): 0 sends the string with no inter-character pacing, greater than 0 sleeps that many milliseconds between characters.
IAllowSelectorActionOrAnySelector SendKey (byte VKCode)
IAllowSelectorActionOrAnySelector PressModifierKey (ModifierKeys modifierKeys)
IAllowSelectorActionOrAnySelector ReleaseModifierKey (ModifierKeys modifierKeys)
Public Member Functions inherited from GenerallyPositive.Application.IAllowSetRange
IAllowAllActionAndAnySelector SetRange (double rangeValue)
Public Member Functions inherited from GenerallyPositive.Application.IAllowToGPALObject< TResult >
TResult ToGPALObject ()
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithNextPageButton
IAllowWithPagesAndGridActions WithNextPageButton (Selector selector)
Public Member Functions inherited from GenerallyPositive.Application.IAllowGetGrid
IAllowWithHeaderOrFileActions GetGrid (ref IGPALGrid< string > returnGrid)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithPages
IAllowGetGridAndFillInFrom WithPages (int numberOfPages)
Public Member Functions inherited from GenerallyPositive.Application.IAllowApplicationSettings
IAllowApplicationSettingsOrOpen WithName (string name)
IAllowApplicationSettingsOrOpen WithParameter (string parameter)
IAllowApplicationSettingsOrOpen WithUseHardware (bool trueFalse)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithHeader
IAllowWithHeaderOrFileActions WithHeader (string header)
Public Member Functions inherited from GenerallyPositive.Application.IAllowFileActions
IAllowAllActionAndAnySelector SaveTo ([GPALFile(Description="")] GPALFile file)
IAllowAllActionAndAnySelector AppendTo ([GPALFile(Description="")] GPALFile file)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithGridToSave
IAllowWithHeaderOrFileActions WithGridToSave (IGPALGrid< string > _)

Properties

UnitOfWork CurrentUOW [get, set]
object ManagedRootAutomationElement [get, set]
IAllowAllApplicationAndAllSelector Maximize [get]
IAllowAllApplicationAndAllSelector Minimize [get]
string Name [get, set]
 A name you provide to be used when publishing events.
Use .WithName to provide your own friendly name. If not supplied GPAL will assign the name application1, application2, etc
This get is intended for debugging only.
Process Process [get, set]
IAllowAllApplicationAndAllSelector Restore [get]
AutomationElement RootAutomationElement [get, set]
 The starting AutomationElement for the application. All xpath searches start from this AutomationElement.
System.Diagnostics.Process Process [get]
string ApplicationPath [get]
 The path of the program you Opened.
This get is intended for debugging only.
Properties inherited from GenerallyPositive.Application.IAllowWithInfiniteScroll
IAllowWithPagesAndGridActions WithInfiniteScroll [get]

Detailed Description

Definition at line 27 of file IApplication.cs.

Member Function Documentation

◆ AppendFrom() [1/3]

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.AppendFrom ( GPALDatabase inputDatabase)

◆ AppendFrom() [2/3]

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.AppendFrom ( IGPALGrid< string > inputGrid)

◆ AppendFrom() [3/3]

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.AppendFrom ( string textToUse)

◆ CallAfterFillIn()

IAllowAfterAnySelector GenerallyPositive.Application.IApplication.CallAfterFillIn ( Application.CallAfterFillInDelegate callAfterFillIn)

◆ CallIfFound()

IAllowAfterAnySelector GenerallyPositive.Application.IApplication.CallIfFound ( Application.CallIfDelegate callIfFoundDelegate)

◆ CallIfNotFound()

IAllowAfterAnySelector GenerallyPositive.Application.IApplication.CallIfNotFound ( Application.CallIfDelegate callIfNotFoundDelegate)

◆ Close()

void GenerallyPositive.Application.IApplication.Close ( )

◆ FillInFrom() [1/3]

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.FillInFrom ( GPALDatabase inputDatabase)

◆ FillInFrom() [2/3]

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.FillInFrom ( IGPALGrid< string > inputGrid)

◆ FillInFrom() [3/3]

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.FillInFrom ( string textToUse)

◆ InsertFrom()

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.InsertFrom ( string textToUse)

◆ LeftClick()

IAllowSelectorActionOrAnySelector GenerallyPositive.Application.IApplication.LeftClick ( Enums.ModifierKeys modifierKeys)

◆ Open()

IAllowAllApplicationAndAllSelector GenerallyPositive.Application.IApplication.Open ( string applicationPath)

◆ PersistentCallIfFound()

IAllowPersistentCallBack GenerallyPositive.Application.IApplication.PersistentCallIfFound ( Application.CallIfDelegate persistentCallIfFound)

◆ PersistentCallIfNotFound()

IAllowPersistentCallBack GenerallyPositive.Application.IApplication.PersistentCallIfNotFound ( Application.CallIfDelegate persistentCallIfNotFound)

◆ RemoveCallIfHandlerEverywhere()

void GenerallyPositive.Application.IApplication.RemoveCallIfHandlerEverywhere ( Application.CallIfDelegate func)

◆ WaitFor()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Application.IApplication.WaitFor ( int timeoutInTicks)

◆ WaitForWindow()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Application.IApplication.WaitForWindow ( string windowTitle)

◆ WaitForWindowRegex()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Application.IApplication.WaitForWindowRegex ( string _)

◆ WithAllThatMatch()

IAllowAfterAnySelectorExceptWithAll GenerallyPositive.Application.IApplication.WithAllThatMatch ( int rowCount = int.MaxValue)

◆ WithPersistentSelector()

IAllowPersistence GenerallyPositive.Application.IApplication.WithPersistentSelector ( Selector selector)

◆ WithSelector()

IAllowAfterAnySelector GenerallyPositive.Application.IApplication.WithSelector ( Selector selector)

◆ WithWaitForWindowTimeout()

IAllowAfterWaitForAndSizeControl GenerallyPositive.Application.IApplication.WithWaitForWindowTimeout ( int waitTimeInSeconds)

Property Documentation

◆ ApplicationPath

string GenerallyPositive.Application.IApplication.ApplicationPath
get

The path of the program you Opened.
This get is intended for debugging only.

Returns
The path you supplied.

Implemented in GenerallyPositive.Application.Application.

Definition at line 388 of file Interfaces.cs.

◆ CurrentUOW

UnitOfWork GenerallyPositive.Application.IApplication.CurrentUOW
getset

Definition at line 29 of file IApplication.cs.

◆ ManagedRootAutomationElement

object GenerallyPositive.Application.IApplication.ManagedRootAutomationElement
getset

Implemented in GenerallyPositive.Application.Application.

Definition at line 30 of file IApplication.cs.

◆ Maximize

IAllowAllApplicationAndAllSelector GenerallyPositive.Application.IApplication.Maximize
get

◆ Minimize

IAllowAllApplicationAndAllSelector GenerallyPositive.Application.IApplication.Minimize
get

◆ Name

string GenerallyPositive.Application.IApplication.Name
getset

A name you provide to be used when publishing events.
Use .WithName to provide your own friendly name. If not supplied GPAL will assign the name application1, application2, etc
This get is intended for debugging only.

Returns
The name you supplied.

Implemented in GenerallyPositive.Application.Application.

Definition at line 33 of file IApplication.cs.

◆ Process [1/2]

Process GenerallyPositive.Application.IApplication.Process
getset

Implemented in GenerallyPositive.Application.Application.

Definition at line 34 of file IApplication.cs.

◆ Process [2/2]

System.Diagnostics.Process GenerallyPositive.Application.IApplication.Process
get

Implemented in GenerallyPositive.Application.Application.

Definition at line 370 of file Interfaces.cs.

◆ Restore

IAllowAllApplicationAndAllSelector GenerallyPositive.Application.IApplication.Restore
get

◆ RootAutomationElement

AutomationElement GenerallyPositive.Application.IApplication.RootAutomationElement
getset

The starting AutomationElement for the application. All xpath searches start from this AutomationElement.

Implemented in GenerallyPositive.Application.Application.

Definition at line 36 of file IApplication.cs.


The documentation for this interface was generated from the following files: