Abrir

Abre um aplicativo da área de trabalho ou uma página do navegador da Web para serem usados na automação de interface gráfica.

Essa API é usada chamando o serviço UIAutomation, com base no seguinte formato: uiAutomation.API(). Por exemplo, uiAutomation.Open().

Definição

Namespace: UiPath.UIAutomationNext.API.Contracts

Assembly: UiPath.UIAutomationNext.API.Contracts (na dll UiPath.UIAutomationNext.API.Contracts)

Sobrecarregas

Sobrecarga	Description
Open(String, TargetAppOptions, String, String)	Abre um aplicativo de área de trabalho específico ou uma página da Web para usar na automação de interface gráfica, identificado pelo nome da tela no Repositório de Objetos.
Open(TargetAppModel, TargetAppOptions)	Abre um aplicativo de área de trabalho específico ou uma página da Web para usar na automação de interface gráfica, identificado pelo objeto TargetAppModel .
Open(String, String, String, NAppOpenMode, NWindowResize, NInteractionMode)	Abre um aplicativo de área de trabalho específico ou uma página da Web para usar na automação de interface gráfica, identificado pelo nome da tela no Repositório de Objetos, juntamente com outras personalizações do aplicativo ou da página da Web.

Open(String, TargetAppOptions, String, String)

Abre um aplicativo de área de trabalho específico ou uma página da Web para usar na automação de interface gráfica, identificado pelo nome da tela no Repositório de Objetos.

Open(
    string screenName,  
    TargetAppOptions targetAppOptions, 
    [string appName],
    [string appVersion])

screeName String : o nome da tela em que você deseja focar, como uma String gravada dentro do Repositório de objetos.

targetAppOptions : opções e configurações adicionais para anexar ao aplicativo ou à página da web:

* `Timeout Double` - Specify a number
  of seconds for which to wait for the activity to be executed before
  throwing an error. The default value is 30 seconds. When indicating
  a window in a Remote Desktop environment, the Timeout default
  setting is set to 60 seconds.
* `InteractionMode
  NInteractionMode`:
  + `HardwareEvents` - Uses the hardware
    driver to perform the action. This is the slowest API, it
    cannot work in the background, but it is compatible with all
    desktop apps.
  + `Simulate` - Simulates the action using
    accessibility APIs. Recommended in browser automation, Java
    apps, or SAP. More reliable than Hardware Events. Sends all
    text in a single action. Works even if the target
    application is not in focus. Please test if your target
    application UI element supports this.
  + `DebuggerApi` - Performs actions using
    debugger APIs. Works only for Chromium elements. Sends all
    text in one go. Works even if target app is not in focus.
    For more details, check out this [page](https://docs.uipath.com/studio/docs/chromium-api).
  + `WindowMessages` - Sends the mouse and
    keyboard input through Win32 messages. Recommended for
    desktop apps. Usually more reliable than Hardware Events.
    Sends all text in a single action. Works even if target app
    is not in focus. Please test if your target application UI
    element supports this.
  + `Background` - Runs actions in the
    background. Tries to use either Simulate or Chromium API
    where possible, while complex APIs (image, native text)
    run as usual, in the foreground. It is highly recommended to
    use this API with the [Verify Execution](https://docs.uipath.com/activities/other/latest/user-guide/project-settings-ui-automation)
    feature.
* `OpenMode NAppOpenMode` - choose when
  to open the app:
  + `Never` (never open the
    application)
  + `IfNotOpen` (open only if the
    application is closed, this is the default selection, only
    works if `FilePath` or `URL`
    are provided)
  + `Always` (open another instance of the
    application even if one is already open, only works if
    `FilePath` or `URL` are
    provided)
* `WindowResize NWindowResize` - choose
  the size of the window:
  + `None`
  + `Maximize`
  + `Restore`
  + `Minimize`
* `UserDataFolderMode
  BrowserUserDataFolderMode` - The
  `UserDataFolderMode` you want to set. It is used
  to start the browser with a specific user data folder.
  + `Automatic` - Picture In Picture mode
    uses a different folder than the default mode, automatically
    generated if `UserDataFolderPath` is not
    set.
  + `DefaultFolder` - Uses the default
    browser folder, no matter if it runs in the main or PIP
    session.
  + `CustomFolder` - Uses the folder
    specified in `UserDataFolderPath` or an auto
    generated path if `UserDataFolderPath` is not
    set.
* `UserDataFolderPath String` - The
  user data folder that the browser uses. Defaults to
  `%LocalAppData%\UiPath\PIP Browser
  Profiles\BrowserType` if not set.
* `IsIncognito Boolean` - input
  `True` if you want to open the browser in
  incognito mode. By default it's set to `False`.
* `WebDriverMode NWebDriverMode` -
  Indicates how the WebDriver is used when opening a new browser
  session. The following options are available:
  + `Disabled` - Disables the use of
    WebDriver.
  + `WithGUI` - The GUI of the browser is
    displayed.
  + `Headless` - The browser is launched
    silently, with no GUI.

appName String : o nome do aplicativo ao qual anexar. Esse parâmetro é aplicável para aplicativos de desktop.

appVersion String : a versão do aplicativo ao qual anexar. Esse parâmetro é aplicável para aplicativos de desktop.

Open(TargetAppModel, TargetAppOptions)

Abre um aplicativo de área de trabalho específico ou uma página da Web para usar na automação de interface gráfica, identificado pelo objeto TargetAppModel .

Open(
    TargetAppModel targetApp,
    [TargetAppOptions targetAppOptions])

targetApp TargetAppModel : o aplicativo de destino ou página da web ao qual anexar. É um objeto do tipo TargetAppModel , que fornece informações sobre o aplicativo:

* `Selector` - An XML fragment that stores the
  attributes of a user interface element.
* `FilePath` - If the application is not a web
  browser, specifies the full path of the executable file to
  open.
* `Arguments` - If the application is not a web
  browser, you can specify parameters to pass to the target
  application at startup.
* `Url`
  - If the application is a web browser, specifies the URL of the web
  page to open.
* `Title` - The title of the application or
  browser.

targetAppOptions : opções e configurações adicionais para anexar ao aplicativo ou à página da web:

* `Timeout Double` - Specify a number of seconds
  for which to wait for the activity to be executed before throwing an
  error. The default value is 30 seconds. When indicating a window in
  a Remote Desktop environment, the Timeout default setting is set to
  60 seconds.
* `InteractionMode NInteractionMode`:
  + `HardwareEvents` - Uses the hardware driver
    to perform the action. This is the slowest API, it cannot
    work in the background, but it is compatible with all
    desktop apps.
  + `Simulate` - Simulates the action using
    accessibility APIs. Recommended in browser automation, Java
    apps, or SAP. More reliable than Hardware Events. Sends all
    text in a single action. Works even if the target
    application is not in focus. Please test if your target
    application UI element supports this.
  + `DebuggerApi` - Performs actions using
    debugger APIs. Works only for Chromium elements. Sends all
    text in one go. Works even if target app is not in focus.
    For more details, check out this [page](https://docs.uipath.com/studio/docs/chromium-api).
  + `WindowMessages` - Sends the mouse and
    keyboard input through Win32 messages. Recommended for
    desktop apps. Usually more reliable than Hardware Events.
    Sends all text in a single action. Works even if target app
    is not in focus. Please test if your target application UI
    element supports this.
  + `Background` - Runs actions in the
    background. Tries to use either Simulate or Chromium API
    where possible, while complex APIs (image, native text)
    run as usual, in the foreground. It is highly recommended to
    use this API with the [Verify Execution](https://docs.uipath.com/activities/other/latest/user-guide/project-settings-ui-automation)
    feature.
* `OpenMode NAppOpenMode` - choose when to open
  the app:
  + `Never` (never open the application)
  + `IfNotOpen` (open only if the application is
    closed, this is the default selection, only works if
    `FilePath` or `URL` are
    provided)
  + `Always` (open another instance of the
    application even if one is already open, only works if
    `FilePath` or `URL` are
    provided)
* `WindowResize NWindowResize` - choose the size
  of the window:
  + `None`
  + `Maximize`
  + `Restore`
  + `Minimize`
* `UserDataFolderMode BrowserUserDataFolderMode`
  - The `UserDataFolderMode` you want to set. It is
  used to start the browser with a specific user data folder.
  + `Automatic` - Picture In Picture mode uses a
    different folder than the default mode, automatically
    generated if `UserDataFolderPath` is not
    set.
  + `DefaultFolder` - Uses the default browser
    folder, no matter if it runs in the main or PIP
    session.
  + `CustomFolder` - Uses the folder specified in
    `UserDataFolderPath` or an auto generated
    path if `UserDataFolderPath` is not set.
* `UserDataFolderPath String` - The user data
  folder that the browser uses. Defaults to
  `%LocalAppData%\UiPath\PIP Browser
  Profiles\BrowserType` if not set.
* `IsIncognito Boolean` - input
  `True` if you want to open the browser in
  incognito mode. By default it's set to `False`.
* `WebDriverMode NWebDriverMode` - Indicates how
  the WebDriver is used when opening a new browser session. The
  following options are available:
  + `Disabled` - Disables the use of
    WebDriver.
  + `WithGUI` - The GUI of the browser is
    displayed.
  + `Headless` - The browser is launched
    silently, with no GUI.

Open(String, String, String, NAppOpenMode, NWindowResize, NInteractionMode)

Abre um aplicativo de área de trabalho específico ou uma página da Web para usar na automação de interface gráfica, identificado pelo nome da tela no Repositório de Objetos, juntamente com outras personalizações do aplicativo ou da página da Web.

Open(
    string screenName,
    [string appName],
    [string appVersion],
    [NAppOpenMode openMode],
    [NWindowResize windowResize],
    [NInteractionMode interactionMode])

screeName String : o nome da tela em que você deseja focar, como uma String gravada dentro do Repositório de objetos.

appName String : o nome do aplicativo ao qual anexar. Esse parâmetro é aplicável para aplicativos de desktop.

appVersion String : a versão do aplicativo ao qual anexar. Esse parâmetro é aplicável para aplicativos de desktop.

openMode NAppOpenMode : selecionar quando abrir o aplicativo de destino para a execução da automação:

* `Never` (never open the application)
* `IfNotOpen` (open only if the application is closed,
  this is the default selection, only works if the
  `Url` parameter is configured)
* `Always` - (open another instance of the application
  even if one is already open, only works if the `Url`
  parameter is configured).

NWindowResize : escolha o tamanho da janela:

* `None`
* `Maximize`
* `Restore`
* `Minimize`

NInteractionMode : escolha qual API o Robô deve usar para interagir com o aplicativo de destino:

* `HardwareEvents` - Uses the hardware driver to
  perform the action. This is the slowest API, it cannot work in
  the background, but it is compatible with all desktop apps.
* `Simulate` - Simulates the action using accessibility
  APIs. Recommended in browser automation, Java apps, or SAP. More
  reliable than Hardware Events. Sends all text in a single action.
  Works even if the target application is not in focus. Please test if
  your target application UI element supports this.
* `DebuggerApi` - Performs actions using debugger APIs.
  Works only for Chromium elements. Sends all text in one go. Works
  even if target app is not in focus. For more details, check out this
  [page](https://docs.uipath.com/studio/docs/chromium-api).
* `WindowMessages` - Sends the mouse and keyboard input
  through Win32 messages. Recommended for desktop apps. Usually more
  reliable than Hardware Events. Sends all text in a single action.
  Works even if target app is not in focus. Please test if your target
  application UI element supports this.
* `Background` - Runs actions in the background. Tries
  to use either Simulate or Chromium API where possible, while complex
  APIs (image, native text) run as usual, in the foreground. It is
  highly recommended to use this API with the [Verify Execution](https://docs.uipath.com/activities/other/latest/user-guide/project-settings-ui-automation)
  feature.

Execução do WebDriverMode como sem periféricos

Para operar WebDriverMode em uma configuração sem periféricos, essas etapas podem servir como um guia.

Comece definindo uma variável para sua tela. Use a função uiAutomation.Openpara abrir um novo aplicativo no navegador de sua escolha - nesta instância, Edge. Depois disso, use a classe Options na sobrecarga para especificar certas opções do navegador. Entre essas opções, defina webDriverModecomo NWebDriverMode.Headless.

O código correspondente fica assim:

var screen = uiAutomation.Open(Descriptors.NewApplication.Edge, Options.AppOpen().WithBrowserOptions(webDriverMode: NWebDriverMode.Headless));

Esse código funciona para configurar seu WebDriver no modo Headless, habilitando a automação do navegador sem que o navegador esteja visivelmente aberto.