Namespace: UiPath.Studio.Activities.Api.Wizards
Classes and Interfaces
IWizardExecutionContext Interface
UiPath.Studio.Activities.Api.Wizards.IWizardExecutionContext
Execution context for a wizard. Requires feature WizardsV3
Public Member Functions
GetInsertionContainer() |
---|
|
Initialize() |
---|
|
IWizardsService Interface
UiPath.Studio.Activities.Api.Wizards.IWizardsService
Add wizards to Studio.
Public Member Functions
Register() |
---|
void |
WizardBase Class
Class Reference: UiPath.Studio.Activities.Api.Wizards.WizardBase
A wizard implementation.
Properties
Properties | Summary |
---|---|
| Executes a wizard and returns the resulted activity. |
| Executes a wizard in realtime, allowing it to directly manipulate the workflow it is called on. Takes precedence over UiPath.Studio.Activities.Api.Wizards.WizardBase.RunWizard, if both are implemented then only this one is run. The context can be used to retrieve an initially empty target container, part of the workflow, which it can manipulate freely in real-time. The return value indicates whether or not the provided container should be kept as part of the workflow. In case the container should be discarded, any operations done on the workflow outside of the container should be cleaned up by the wizard. Requires feature WizardsV3 |
WizardCollection Class
Class Reference: UiPath.Studio.Activities.Api.Wizards.WizardCollection
Returns a multi-tree of wizard definitions. Each entry is a button on the ribbon. Children for each entry are menu items.
Properties
Properties | Summary |
---|---|
| Returns a forest of wizard definitions. Their order will define how they appear in the ribbon. |
WizardDefinition Class
Class Reference: UiPath.Studio.Activities.Api.Wizards.WizardDefinition
Summary of a wizard's Ui properties.
Properties
Properties | Summary |
---|---|
string | Translated display name. |
string | Location of the icon resource in the providing assembly. |
string | Translated tooltip. |
| This wizard's shortcut. |
| Returns sub-wizards or null if none available. |
| The wizard instance for this definition or null. |
bool | If true, Studio minimizes before calling RunWizard, and restore when RunWizard returns The default value is True. Requires feature WizardsV2 |
string | If null or empty, Studio adds the wizard. If using a product code, Studio adds the wizard if the license contains that code. If using other string, Studio adds the wizard if it knows the string. Anything else, no wizard is added. Requires feature WizardsV3 |
Updated 11 months ago