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

bool IsEndOfPage ()
Public Member Functions inherited from GenerallyPositive.Application.IAllowClose
void Close ()
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.IAllowWithSelector
IAllowSelectorActionOrAnySelector WithSelector (Selector selector)
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.IAllowFileDialog
IAllowSelectorActionOrAnySelector LeftClickAndOpen (GPALFile file)
IAllowSelectorActionOrAnySelector LeftClickAndSave (GPALFile file)
IAllowSelectorActionOrAnySelector AnswerFileDialog (GPALFile file)
Public Member Functions inherited from GenerallyPositive.Application.IAllowFillInFrom
IAllowSelectorActionOrAnySelector FillInFrom (string textToUse)
IAllowSelectorActionOrAnySelector AppendFrom (string textToUse)
IAllowSelectorActionOrAnySelector InsertFrom (string textToUse)
IAllowSelectorActionOrAnySelector FillInFrom (GPALFile inputFile)
IAllowSelectorActionOrAnySelector AppendFrom (GPALFile inputFile)
IAllowSelectorActionOrAnySelector InsertFrom (GPALFile inputFile)
IAllowSelectorActionOrAnySelector FillInFrom (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector AppendFrom (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector InsertFrom (GPALDatabase inputDatabase)
IAllowSelectorActionOrAnySelector FillInFrom (IGPALGrid< string > inputGrid)
IAllowSelectorActionOrAnySelector AppendFrom (IGPALGrid< string > inputGrid)
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.IAllowWaitFor
IAllowAfterWaitForAndSizeControl WaitFor (int waitForTimeInTicks)
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.IAllowWaitForWindow
IAllowAfterWaitForAndSizeControl WaitForWindow (string windowName)
IAllowAfterWaitForAndSizeControl WaitForWindowRegex (string windowNameRegex)
IAllowAfterWaitForAndSizeControl WithWaitForWindowTimeout (int waitTimeInSeconds)
Public Member Functions inherited from GenerallyPositive.Application.IAllowCallBack
IAllowAfterAnySelector CallIfFound (Application.CallIfDelegate CallIfFound)
IAllowAfterAnySelector CallIfNotFound (Application.CallIfDelegate CallIfNotFound)
IAllowAfterAnySelector CallAfterFillIn (Application.CallAfterFillInDelegate CallAfterFillIn)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithAllThatMatch
IAllowAfterAnySelectorExceptWithAll WithAllThatMatch (int rowCount)
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)
IAllowApplicationSettingsOrOpen WithNewInstance (bool trueFalse)
IAllowApplicationSettingsOrOpen WithHiddenDesktop (bool hiddenDesktop)
IAllowApplicationSettingsOrOpen WithHiddenDesktop (string desktopName)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithPersistentSelector
IAllowPersistence WithPersistentSelector (Selector selector)
Public Member Functions inherited from GenerallyPositive.Application.IAllowPersistentCallBack
IAllowPersistentCallBack PersistentCallIfFound (Application.CallIfDelegate CallIfFound)
IAllowPersistentCallBack PersistentCallIfNotFound (Application.CallIfDelegate CallIfNotFound)
Public Member Functions inherited from GenerallyPositive.Application.IAllowApplicationOpen
IAllowAllExceptParameters Open ([Directory()] string ApplicationPath)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithHeader
IAllowWithHeaderOrFileActions WithHeader (string header)
Public Member Functions inherited from GenerallyPositive.Application.IAllowFileActions
IAllowAllActionAndAnySelector SaveTo ([GPALFile(Description="The file to write")] GPALFile file)
IAllowAllActionAndAnySelector AppendTo ([GPALFile(Description="The file to add to")] GPALFile file)
Public Member Functions inherited from GenerallyPositive.Application.IAllowWithGridToSave
IAllowWithHeaderOrFileActions WithGridToSave (IGPALGrid< string > _)

Properties

System.Diagnostics.Process Process [get]
object ManagedRootAutomationElement [get]
AutomationElement RootAutomationElement [get]
 The starting AutomationElement for the application. All xpath searches start from this AutomationElement.
string Name [get]
 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.
string ApplicationPath [get]
 The path of the program you Opened.
This get is intended for debugging only.
GenerallyPositive.Browser.IHiddenDesktop HiddenDesktop [get]
 The hidden desktop this program runs on, or null when it is on the desktop you are looking at.
IReadOnlyList< string > ColumnNames [get]
 The column names the last GetGrid read off the control itself, from a TablePattern or from the header the control draws above its rows.
Empty when the control named none, which is when a saved file falls back to generated names.
Properties inherited from GenerallyPositive.Application.IAllowSizeControl
IAllowAllApplicationAndAllSelector Maximize [get]
IAllowAllApplicationAndAllSelector Minimize [get]
IAllowAllApplicationAndAllSelector Restore [get]
Properties inherited from GenerallyPositive.Application.IAllowWithInfiniteScroll
IAllowWithPagesAndGridActions WithInfiniteScroll [get]

Detailed Description

Definition at line 372 of file Interfaces.cs.

Member Function Documentation

◆ IsEndOfPage()

bool GenerallyPositive.Application.IApplication.IsEndOfPage ( )

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 408 of file Interfaces.cs.

◆ ColumnNames

IReadOnlyList<string> GenerallyPositive.Application.IApplication.ColumnNames
get

The column names the last GetGrid read off the control itself, from a TablePattern or from the header the control draws above its rows.
Empty when the control named none, which is when a saved file falls back to generated names.

Returns
The names in column order.

Implemented in GenerallyPositive.Application.Application.

Definition at line 421 of file Interfaces.cs.

◆ HiddenDesktop

GenerallyPositive.Browser.IHiddenDesktop GenerallyPositive.Application.IApplication.HiddenDesktop
get

The hidden desktop this program runs on, or null when it is on the desktop you are looking at.

Returns
The desktop, to peek at or to name.

Implemented in GenerallyPositive.Application.Application.

Definition at line 413 of file Interfaces.cs.

◆ ManagedRootAutomationElement

object GenerallyPositive.Application.IApplication.ManagedRootAutomationElement
get

Implemented in GenerallyPositive.Application.Application.

Definition at line 389 of file Interfaces.cs.

◆ Name

string GenerallyPositive.Application.IApplication.Name
get

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 402 of file Interfaces.cs.

◆ Process

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

Implemented in GenerallyPositive.Application.Application.

Definition at line 388 of file Interfaces.cs.

◆ RootAutomationElement

AutomationElement GenerallyPositive.Application.IApplication.RootAutomationElement
get

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

Implemented in GenerallyPositive.Application.Application.

Definition at line 393 of file Interfaces.cs.


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