RPA.Assistant
Create a button and execute the function as a callback when pressed.
Arguments
| Argument | Type | Default value |
|---|---|---|
| label | str | null |
| function | Callable, str | null |
| args | null | |
| location | VerticalLocation | Left |
| kwargs | null |
| param label: | Text for the button |
|---|---|
| param function: | Python function or Robot Keyword name, that will get *args and **kwargs passed into it |
Usage
Add a checkbox element
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| label | str | null |
| default | bool | False |
| param name: | Name of result field |
|---|---|
| param label: | Label text for checkbox |
| param default: | Default checked state |
Adds a checkbox that indicates a true or false value. The selection will be available in the name field of the result, and the label text will be shown next to the checkbox.
The boolean default value will define the initial checked state of the element.
Usage
Add a date input element.
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| default | date, str, None | None |
| label | str, None | None |
| param name: | Name of the result field |
|---|---|
| param default: | The default set date |
| param label: | Label for the date input field |
Displays a date input. The selection the user makes will be available as a date object in the name field of the result. The default argument can be a pre-set date as object or string in "YYYY-MM-DD" format, otherwise the current date is used.
Usage
Add a drop-down element
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| options | List[str], str | null |
| default | str, None | None |
| label | str, None | None |
| param name: | Name of result field |
|---|---|
| param options: | List of drop-down options |
| param default: | The default selection |
| param label: | Label for input field |
Creates a drop-down menu with the given options. The selection the user makes will be available in the name field of the result.
The default argument can be one of the defined options, and the dialog automatically selects that option for the input.
A custom label text can also be added.
Usage
Add a file element, which links to a local file
Arguments
| Argument | Type | Default value |
|---|---|---|
| path | str | null |
| label | str, None | None |
| param path: | The path to the file |
|---|---|
| param label: | A custom label text for the file |
Adds a button which opens a local file with the corresponding default application. Can be used for instance to display generated files from the robot to the end-user.
Optionally a custom label can be given for the button text. By default uses the filename of the linked file.
Usage
Add a file input element
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| label | str, None | None |
| source | str, None | None |
| file_type | str, None | None |
| multiple | bool | False |
| param name: | Name of result field |
|---|---|
| param label: | Label for input field |
| param source: | Default source directory |
| param file_type: | Accepted file types |
| param multiple: | Allow selecting multiple files |
Adds a native file selection dialog for inputting one or more files. The list of selected files will be available in the name field of the result.
By default opens up in the user's home directory, but it can be set to a custom path with the source argument.
The argument file_type restricts the possible file extensions that the user can select. The format of the argument is as follows: pdf,png,svg. For instance, an argument to limit options to Excel files could be: xls,xlsx.
To allow selecting more than one file, the multiple argument can be enabled.
Usage
Add multiple file elements according to the given file pattern
Arguments
| Argument | Type | Default value |
|---|---|---|
| pattern | str | null |
| param pattern: | File matching pattern |
|---|
See the keyword Add file for information about the inserted element itself.
The keyword uses Unix-style glob patterns for finding matching files, and the supported pattern expressions are as follow:
| Pattern | Meaning |
|---|---|
| * | Match everything |
| ? | Match any single character |
| [seq] | Match any character in seq |
| [!seq] | Match any character not in seq |
| ** | Match all files, directories, and subdirectories |
If a filename has any of these special characters, they can be escaped by wrapping them with square brackets.
Usage
Add an icon from a large gallery of icons.
Arguments
| Argument | Type | Default value |
|---|---|---|
| icon | str | null |
| color | str, None | None |
| size | int, None | 24 |
| param icon: | Corresponding flet icon name. Check https://gallery.flet.dev/icons-browser/ for a list of icons. Write the name in lower_case |
|---|---|
| param color: | Color for the icon. Default depends on icon. Allowed values are colors from https://github.com/flet-dev/flet/blob/035b00104f782498d084c2fd7ee96132a542ab7f/sdk/python/packages/flet-core/src/flet_core/colors.py#L37 or ARGB/RGB (#FFXXYYZZ or #XXYYZZ). |
| param size: | Integer size for the icon. |
Usage
Add a centered heading text element
Arguments
| Argument | Type | Default value |
|---|---|---|
| heading | str | null |
| size | Size | Medium |
| param heading: | The text content for the heading |
|---|---|
| param size: | The size of the heading |
Supported size values are Small, Medium, and Large. By default uses the value Medium.
Usage
Add an icon element from RPA.Assistant's short icon list.
Arguments
| Argument | Type | Default value |
|---|---|---|
| variant | Icon | null |
| size | int | 48 |
| param variant: | The icon type |
|---|---|
| param size: | The size of the icon |
Adds an icon which can be used to indicate status or the type of dialog being presented.
The currently supported icon types are:
| Name | Description |
|---|---|
| Success | A green check mark |
| Warning | An orange warning triangle |
| Failure | A red cross or X mark |
The size of the icon can also be changed, to a given height/width of pixels.
Usage
Add an image element, from a local file or remote URL
Arguments
| Argument | Type | Default value |
|---|---|---|
| url_or_path | str | null |
| width | int, None | None |
| height | int, None | None |
| param url_or_path: | The location of the image |
|---|---|
| param width: | The static width of the image, in pixels |
| param height: | The static height of the image, in pixels |
Adds an inline image to the dialog, which can either point to a local file path on the executing machine or to a remote URL. If it's a local file path it has to be absolute path.
By default the image is resized to fit the width of the dialog window, but the width and/or height can be explicitly defined to a custom value. If only one of the dimensions is given, the other is automatically changed to maintain the correct aspect ratio.
Usage
System Message: ERROR/3 (<string>, line 27)
Error in "code-block" directive: maximum 1 argument(s) allowed, 17 supplied.
Add an external URL link element
Arguments
| Argument | Type | Default value |
|---|---|---|
| url | str | null |
| label | str, None | None |
| param url: | The URL for the link |
|---|---|
| param label: | A custom label text for the link |
Adds a clickable link element, which opens the user's default browser to the given url. Optionally a label can be given which is shown as the link text, instead of the raw URL.
Usage
Add a loading bar.
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| width | int | 16 |
| bar_height | int | 16 |
| color | str, None | None |
| tooltip | str, None | None |
| value | float, None | None |
| param name: | Name of the element |
|---|---|
| param width: | Width of the bar |
| param bar_height: | Height of the bar |
| param color: | Color of the bar's stroke. Allowed values are colors from [https://github.com/flet-dev/flet/blob/035b00104f782498d084c2fd7ee96132a542ab7f/sdk/python/packages/flet-core/src/flet_core/colors.py#L37|Flet Documentation] (in the format black12, red500) or ARGB/RGB (#FFXXYYZZ or #XXYYZZ).XXYYZZ |
| param tooltip: | Tooltip to be displayed on mouse hover. |
| param value: | Between 0.0 and 1.0 if you want to manually control it's completion. Use None for indeterminate progress indicator. |
Add a loading spinner.
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| width | int | 16 |
| height | int | 16 |
| stroke_width | int | 2 |
| color | str, None | None |
| tooltip | str, None | None |
| value | float, None | None |
| param name: | Name of the element |
|---|---|
| param width: | Width of the spinner |
| param height: | Height of the spinner |
| param stroke_width: | Width of the spinner's stroke |
| param color: | Color of the spinner's stroke. Allowed values are colors from [https://github.com/flet-dev/flet/blob/035b00104f782498d084c2fd7ee96132a542ab7f/sdk/python/packages/flet-core/src/flet_core/colors.py#L37|Flet Documentation] (in the format black12, red500) or ARGB/RGB (#FFXXYYZZ or #XXYYZZ).XXYYZZ |
| param tooltip: | Tooltip to be displayed on mouse hover. |
| param value: | Between 0.0 and 1.0 if you want to manually control it's completion. If None it will spin endlessy. |
Create a button that leads to the next UI page, calling the passed keyword or function, and passing current form results as first positional argument to it.
Arguments
| Argument | Type | Default value |
|---|---|---|
| label | str | null |
| function | Callable, str | null |
| param label: | Text for the button |
|---|---|
| param function: | Python function or Robot Keyword name, that will take form results as its first argument |
Usage
Add a password input element
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| label | str, None | None |
| placeholder | str, None | None |
| param name: | Name of result field |
|---|---|
| param label: | Label for field |
| param placeholder: | Placeholder text in input field |
Adds a text field that hides the user's input. The entered content will be available in the name field of the result.
For customizing the look of the input, the label text can be given to add a descriptive label and the placholder text can be given to act as an example of the input value.
Usage
Add radio button elements
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| options | List[str], str | null |
| default | str, None | None |
| label | str, None | None |
| param name: | Name of result field |
|---|---|
| param options: | List of drop-down options |
| param default: | The default selection |
| param label: | Label for input field |
Creates a set of radio buttons with the given options. The selection the user makes will be available in the name field of the result.
The default argument can be one of the defined options, and the dialog automatically selects that option for the input.
A custom label text can also be added.
Usage
Add a slider input.
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| slider_min | int, float | 0 |
| slider_max | int, float | 100 |
| thumb_text | {value} | |
| steps | int, None | None |
| default | int, float, None | None |
| decimals | int, None | 1 |
| param name: | Name of result field |
|---|---|
| param slider_min: | Minimum value of the slider |
| param slider_max: | Maximum value of the slider |
| param thumb_label: | Text to display when the slider is being slided. Use the placeholder {value} for the number. (thumb text {value%} will display values: 0%, 100%) |
| param steps: | Amount of steps for the slider. If None, the slider will be continuous. For integer output, specify a steps value where all the steps will be integers, or implement rounding when retrieving the result. |
| param default: | Default value for the slider. Must be between min and max. |
| param decimals: | How many decimals should the value have and show. |
Add custom submit buttons
Arguments
| Argument | Type | Default value |
|---|---|---|
| buttons | List[str], str | null |
| default | str, None | None |
| param buttons: | Submit button options |
|---|---|
| param default: | The primary button |
The result field will always be called submit and will contain the pressed button text as a value.
If one of the custom options should be the preferred option, the default argument controls which one is highlighted with an accent color.
Usage
Add a text paragraph element, for larger bodies of text
Arguments
| Argument | Type | Default value |
|---|---|---|
| text | str | null |
| size | Size | Medium |
| param text: | The text content for the paragraph |
|---|---|
| param size: | The size of the text |
Supported size values are Small, Medium, and Large. By default uses the value Medium.
Usage
Add a text input element
Arguments
| Argument | Type | Default value |
|---|---|---|
| name | str | null |
| label | str, None | None |
| placeholder | str, None | None |
| validation | Callable, str, None | None |
| default | str, None | None |
| required | bool | False |
| minimum_rows | int, None | None |
| maximum_rows | int, None | None |
| param name: | Name of result field |
|---|---|
| param label: | Label for field |
| param placeholder: | Placeholder text in input field |
| param validation: | Validation function for the input field |
| param default: | Default value if the field wasn't completed |
| param required: | If true, will display an error if not completed |
| param minimum_rows: | Minimum number of rows to display for the input field |
| param maximum_rows: | Maximum number of rows to display for the input field, the input content can be longer but a scrollbar will appear |
Adds a text field that can be filled by the user. The entered content will be available in the name field of the result.
For customizing the look of the input, the label text can be given to add a descriptive label and the placholder text can be given to act as an example of the input value.
The default value will be assigned to the input field if the user doesn't complete it. If provided, the placeholder won't be shown. This is None by default. Also, if a default value is provided and the user deletes it, None will be the corresponding value in the results dictionary.
Usage
Validation example:
Same as Run Dialog it will create a dialog from all the defined elements and block until the user has handled it. It will also add by default a submit and close buttons.
Arguments
| Argument | Type | Default value |
|---|---|---|
| timeout | int | 180 |
| options | Any | null |
| param timeout: | Time to wait for dialog to complete, in seconds |
|---|---|
| param options: | Options for the dialog |
Returns a result object with all input values.
For more information about possible options for opening the dialog, see the documentation for the keyword Run Dialog.
Usage
Clear dialog and results while it is running.
Closes previously opened Column.
Raises LayoutError if called with no Column open, or if another layout element was opened more recently than a Column.
Close previously opened container.
Raises LayoutError if called with no Row open, or if another layout element was opened more recently than a row.
Close previously opened row.
Raises LayoutError if called with no Row open, or if another layout element was opened more recently than a row.
Close previously opened Stack.
Raises LayoutError if called with no Stack open, or if another layout element was opened more recently than a Stack.
Open a Column layout container. Following Add <element> calls will add items into that Column until Close Column is called.
Open a single element container. The following Add <element> calls adds an element inside the container. Can be used for styling elements.
Arguments
| Argument | Type | Default value |
|---|---|---|
| margin | int, None | 5 |
| padding | int, None | None |
| width | int, None | None |
| height | int, None | None |
| background_color | str, None | None |
| location | Location, Tuple[int, int], None | None |
| param margin: | How much margin to add around the container. RPA.Assistant adds by default a container of margin 5 around all elements, to have a smaller margin use containers with smaller margin value for elements. |
|---|---|
| param padding: | How much padding to add around the content of the container. |
| param width: | Width of the container. |
| param height: | Height of the container. |
| param bgcolor: | Background color for the container. Default depends on icon. Allowed values are colors from [https://github.com/flet-dev/flet/blob/035b00104f782498d084c2fd7ee96132a542ab7f/sdk/python/packages/flet-core/src/flet_core/colors.py#L37|Flet Documentation] (in the format black12, red500) or ARGB/RGB (#FFXXYYZZ or #XXYYZZ).XXYYZZ |
| param location: | Where to place the container (A Location value or tuple of ints). Only works inside a Stack layout element. To use any Center___ or ___Center locations you must define width and height to the element. |
Open a row layout container. Following Add <element> calls will add items into that row until Close Row is called.
Create a "Stack" layout element. Stack can be used to position elements absolutely and to have overlapping elements in your layout. Use Container's top and left arguments to position the elements in a stack.
Arguments
| Argument | Type | Default value |
|---|---|---|
| width | int, None | None |
| height | int, None | None |
Can be used to update UI elements when adding elements while dialog is running
Create a dialog from all the defined elements and block until the user has handled it.
Arguments
| Argument | Type | Default value |
|---|---|---|
| timeout | int | 180 |
| title | str | Assistant |
| height | int, typing_extensions.Literal['AUTO'][AUTO] | AUTO |
| width | int | 480 |
| on_top | bool | False |
| location | WindowLocation, Tuple[int, int], None | None |
| param timeout: | Time to wait for dialog to complete, in seconds |
|---|---|
| param title: | Title of dialog |
| param height: | Height of dialog (in pixels or 'AUTO') |
| param width: | Width of dialog (in pixels) |
| param on_top: | Show dialog always on top of other windows |
| param location: | Where to place the dialog (options are Center, TopLeft, or a tuple of ints) |
If the location argument is None it will let the operating system place the window.
Returns a result object with all input values.
When the dialog closes elements are cleared.