Ouvrir

Ouvre une application de bureau ou une page de navigateur Web à utiliser dans UI Automation.

Cette API est utilisée en appelant le service UiAutomation, selon le format suivant : uiAutomation.API(). Par exemple, uiAutomation.Open().

Définition

Espace de noms : UiPath.UIAutomationNext.API.Contracts

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

Surcharges

Surcharge	Description
Open(String, TargetAppOptions, String, String)	Ouvre une application de bureau ou une page Web spécifique à utiliser dans UI Automation, identifiée par le nom d'écran du référentiel d'objets.
Open(TargetAppModel, TargetAppOptions)	Ouvre une application de bureau ou une page Web spécifique à utiliser dans UI Automation, identifiée par l'objet TargetAppModel .
Open(String, String, String, NAppOpenMode, NWindowResize, NInteractionMode)	Ouvre une application de bureau ou une page Web spécifique à utiliser dans UI Automation, identifiée par le nom d'écran du référentiel d'objets, ainsi que d'autres personnalisations de l'application ou de la page Web.

Open(String, TargetAppOptions, String, String)

Ouvre une application de bureau ou une page Web spécifique à utiliser dans UI Automation, identifiée par le nom d'écran du référentiel d'objets.

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

screeName Chaîne de caractères (string)

Le nom de l’écran sur lequel vous souhaitez vous concentrer, sous la forme d’une chaîne enregistrée dans le référentiel d’objets.

targetAppOptions

Options et paramètres supplémentaires pour la connexion à l'application ou à la page Web :

• Timeout Double - Spécifiez le nombre de secondes pendant lesquelles attendre l'exécution de l'activité avant de générer une erreur. La valeur par défaut est 30 secondes. Lorsque vous indiquez une fenêtre dans un environnement Bureau à distance, le paramètre par défaut Délai d'attente est défini sur 60 secondes.
• InteractionMode NInteractionMode :
  • HardwareEvents : utilise le pilote matériel pour effectuer les Actions. Il s'agit de l'API la plus lente : elle ne peut pas fonctionner en arrière-plan, mais est compatible avec toutes les applications de bureau.
  • Simulate : simule les Actions à l'aide des API d'accessibilité. Recommandé dans l'automatisation du navigateur, les applications Java ou SAP. Plus fiable que les événements matériels. Envoie tout le texte dans une seule Actions. Fonctionne même si l’application cible n’est pas au point. Veuillez tester si l’élément d’IU de votre application cible prend cela en charge.
  • DebuggerApi - Effectue des Actions à l'aide des API Debugger. Fonctionne uniquement pour les éléments Chromium. Envoie tout le texte en une seule fois. Fonctionne même si l’application cible n’est pas au point. Pour en savoir plus, consultez cette page.
  • WindowMessages - Envoie l'entrée de la souris et du clavier via des messages Win32. Recommandé pour les applications de bureau. Généralement plus fiable que les événements matériels. Envoie tout le texte dans une seule Actions. Fonctionne même si l’application cible n’est pas au point. Veuillez tester si l’élément d’IU de votre application cible prend cela en charge.
  • Background : exécute des Actions en arrière-plan. Essaie d'utiliser l'API Simulate ou Chromium dans la mesure du possible, tandis que les API complexes (image, texte natif) s'exécutent comme d'habitude, au premier plan. Il est fortement recommandé d'utiliser cette API avec la fonctionnalité Vérifier l'exécution .
• OpenMode NAppOpenMode - choisissez quand ouvrir l'application :
  • Never (n'ouvrez jamais l'application)
  • IfNotOpen (ne s'ouvre que si l'application est fermée, il s'agit de la sélection par défaut, ne fonctionne que si FilePath ou URL sont fournis)
  • Always (ouvrir une autre instance de l'application même si une est déjà ouverte, ne fonctionne que si FilePath ou URL sont fournis)
• WindowResize NWindowResize - choisissez la taille de la fenêtre :
  • Aucun (None)
  • Agrandir
  • Restaurer
  • Minimize
• UserDataFolderMode BrowserUserDataFolderMode : le UserDataFolderMode que vous souhaitez définir. Il est utilisé pour démarrer le navigateur avec un dossier de données utilisateur spécifique.
  • Automatic : le mode incrustation d'image utilise un dossier différent de celui du mode par défaut, généré automatiquement si UserDataFolderPath n'est pas défini.
  • DefaultFolder - Utilise le dossier du navigateur par défaut, peu importe qu'il soit exécuté dans la session principale ou dans la session PIP.
  • CustomFolder : utilise le dossier spécifié dans UserDataFolderPath ou un chemin d'accès généré automatiquement si UserDataFolderPath n'est pas défini.
• UserDataFolderPath String : le dossier de données utilisateur utilisé par le navigateur. La valeur par défaut est %LocalAppData%\UiPath\PIP Browser Profiles\BrowserType si elle n'est pas définie.
• IsIncognito Boolean : saisissez True si vous souhaitez ouvrir le navigateur en mode navigation privée. Par défaut, il est défini sur False.
• WebDriverMode NWebDriverMode : indique comment WebDriver est utilisé lors de l'ouverture d'une nouvelle session de navigateur. Les options suivantes sont disponibles :
  • Disabled : désactive l'utilisation de WebDriver.
  • WithGUI : l'interface graphique du navigateur s'affiche.
  • Headless : le navigateur est lancé en mode silencieux, sans interface graphique.

appName Chaîne de caractères (string)

Le nom de l’application à laquelle se connecter. Ce paramètre s'applique aux applications de bureau.

appVersion Chaîne de caractères (string)

La version de l’application à laquelle se connecter. Ce paramètre s'applique aux applications de bureau.

Open(TargetAppModel, TargetAppOptions)

Ouvre une application de bureau ou une page Web spécifique à utiliser dans UI Automation, identifiée par l'objet TargetAppModel .

Open(
    TargetAppModel targetApp,
    [TargetAppOptions targetAppOptions])

targetApp ModèleApplicationCible

L’application cible ou la page Web à laquelle se connecter. Il s'agit d'un objet de type TargetAppModel qui fournit des informations sur l'application :

• Selector - Fragment XML qui stocke les attributs d'un élément d'interface utilisateur.
• FilePath : si l'application n'est pas un navigateur Web, indique le chemin complet du fichier exécutable à ouvrir.
• Arguments - Si l'application n'est pas un navigateur Web, vous pouvez spécifier les paramètres à transmettre à l'application cible au démarrage.
• Url : si l'application est un navigateur Web, cette option spécifie l'URL de la page Web à ouvrir.
• Title : le titre de l'application ou du navigateur.

targetAppOptions

Options et paramètres supplémentaires pour la connexion à l'application ou à la page Web :

• Timeout Double - Spécifiez le nombre de secondes pendant lesquelles attendre l'exécution de l'activité avant de générer une erreur. La valeur par défaut est 30 secondes. Lorsque vous indiquez une fenêtre dans un environnement Bureau à distance, le paramètre par défaut Délai d'attente est défini sur 60 secondes.
• InteractionMode NInteractionMode :
  • HardwareEvents : utilise le pilote matériel pour effectuer les Actions. Il s'agit de l'API la plus lente : elle ne peut pas fonctionner en arrière-plan, mais est compatible avec toutes les applications de bureau.
  • Simulate : simule les Actions à l'aide des API d'accessibilité. Recommandé dans l'automatisation du navigateur, les applications Java ou SAP. Plus fiable que les événements matériels. Envoie tout le texte dans une seule Actions. Fonctionne même si l’application cible n’est pas au point. Veuillez tester si l’élément d’IU de votre application cible prend cela en charge.
  • DebuggerApi - Effectue des Actions à l'aide des API Debugger. Fonctionne uniquement pour les éléments Chromium. Envoie tout le texte en une seule fois. Fonctionne même si l’application cible n’est pas au point. Pour en savoir plus, consultez cette page.
  • WindowMessages - Envoie l'entrée de la souris et du clavier via des messages Win32. Recommandé pour les applications de bureau. Généralement plus fiable que les événements matériels. Envoie tout le texte dans une seule Actions. Fonctionne même si l’application cible n’est pas au point. Veuillez tester si l’élément d’IU de votre application cible prend cela en charge.
  • Background : exécute des Actions en arrière-plan. Essaie d'utiliser l'API Simulate ou Chromium dans la mesure du possible, tandis que les API complexes (image, texte natif) s'exécutent comme d'habitude, au premier plan. Il est fortement recommandé d'utiliser cette API avec la fonctionnalité Vérifier l'exécution .
• OpenMode NAppOpenMode - choisissez quand ouvrir l'application :
  • Never (n'ouvrez jamais l'application)
  • IfNotOpen (ne s'ouvre que si l'application est fermée, il s'agit de la sélection par défaut, ne fonctionne que si FilePath ou URL sont fournis)
  • Always (ouvrir une autre instance de l'application même si une est déjà ouverte, ne fonctionne que si FilePath ou URL sont fournis)
• WindowResize NWindowResize - choisissez la taille de la fenêtre :
  • Aucun (None)
  • Agrandir
  • Restaurer
  • Minimize
• UserDataFolderMode BrowserUserDataFolderMode : le UserDataFolderMode que vous souhaitez définir. Il est utilisé pour démarrer le navigateur avec un dossier de données utilisateur spécifique.
  • Automatic : le mode incrustation d'image utilise un dossier différent de celui du mode par défaut, généré automatiquement si UserDataFolderPath n'est pas défini.
  • DefaultFolder - Utilise le dossier du navigateur par défaut, peu importe qu'il soit exécuté dans la session principale ou dans la session PIP.
  • CustomFolder : utilise le dossier spécifié dans UserDataFolderPath ou un chemin d'accès généré automatiquement si UserDataFolderPath n'est pas défini.
• UserDataFolderPath String : le dossier de données utilisateur utilisé par le navigateur. La valeur par défaut est %LocalAppData%\UiPath\PIP Browser Profiles\BrowserType si elle n'est pas définie.
• IsIncognito Boolean : saisissez True si vous souhaitez ouvrir le navigateur en mode navigation privée. Par défaut, il est défini sur False.
• WebDriverMode NWebDriverMode : indique comment WebDriver est utilisé lors de l'ouverture d'une nouvelle session de navigateur. Les options suivantes sont disponibles :
  • Disabled : désactive l'utilisation de WebDriver.
  • WithGUI : l'interface graphique du navigateur s'affiche.
  • Headless : le navigateur est lancé en mode silencieux, sans interface graphique.

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

Ouvre une application de bureau ou une page Web spécifique à utiliser dans UI Automation, identifiée par le nom d'écran du référentiel d'objets, ainsi que d'autres personnalisations de l'application ou de la page Web.

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

screeName Chaîne de caractères (string)

Le nom de l’écran sur lequel vous souhaitez vous concentrer, sous la forme d’une chaîne enregistrée dans le référentiel d’objets.

appName Chaîne de caractères (string)

Le nom de l’application à laquelle se connecter. Ce paramètre s'applique aux applications de bureau.

appVersion Chaîne de caractères (string)

La version de l’application à laquelle se connecter. Ce paramètre s'applique aux applications de bureau.

openMode NAppOpenMode

Sélectionnez quand ouvrir l’application cible pour l’exécution de l’automatisation :

• Never (n'ouvrez jamais l'application)
• IfNotOpen (ne s'ouvre que si l'application est fermée, il s'agit de la sélection par défaut, ne fonctionne que si le paramètre Url est configuré)
• Always : (ouvrir une autre instance de l'application même si une est déjà ouverte, ne fonctionne que si le paramètre Url est configuré).

NWindowResize

Choisissez la taille de la fenêtre :

• Aucun (None)
• Agrandir
• Restaurer
• Minimize

NInteractionMode

Choisissez l'API que le Robot doit utiliser pour interagir avec l'application cible :

• HardwareEvents : utilise le pilote matériel pour effectuer les Actions. Il s'agit de l'API la plus lente : elle ne peut pas fonctionner en arrière-plan, mais est compatible avec toutes les applications de bureau.
• Simulate : simule les Actions à l'aide des API d'accessibilité. Recommandé dans l'automatisation du navigateur, les applications Java ou SAP. Plus fiable que les événements matériels. Envoie tout le texte dans une seule Actions. Fonctionne même si l’application cible n’est pas au point. Veuillez tester si l’élément d’IU de votre application cible prend cela en charge.
• DebuggerApi - Effectue des Actions à l'aide des API Debugger. Fonctionne uniquement pour les éléments Chromium. Envoie tout le texte en une seule fois. Fonctionne même si l’application cible n’est pas au point. Pour en savoir plus, consultez cette page.
• WindowMessages - Envoie l'entrée de la souris et du clavier via des messages Win32. Recommandé pour les applications de bureau. Généralement plus fiable que les événements matériels. Envoie tout le texte dans une seule Actions. Fonctionne même si l’application cible n’est pas au point. Veuillez tester si l’élément d’IU de votre application cible prend cela en charge.
• Background : exécute des Actions en arrière-plan. Essaie d'utiliser l'API Simulate ou Chromium dans la mesure du possible, tandis que les API complexes (image, texte natif) s'exécutent comme d'habitude, au premier plan. Il est fortement recommandé d'utiliser cette API avec la fonctionnalité Vérifier l'exécution .

Exécution de WebDriverMode sans affichage

Pour utiliser WebDriverMode dans une configuration sans affichage, ces étapes peuvent servir de guide.

Commencez par définir une variable pour votre écran. Utilisez la fonction uiAutomation.Open pour ouvrir une nouvelle application dans le navigateur de votre choix (Edge dans cette instance). Puis, utilisez la classe Options dans la surcharge pour spécifier certaines options de navigateur. Parmi ces options, définissez webDriverMode sur NWebDriverMode.Headless.

Le code correspondant ressemble à ce qui suit :

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

Ce code définit WebDriver en mode sans affichage, permettant l’automatisation du navigateur sans que le navigateur soit visiblement ouvert.