UiPath.Studio.Analyzer.Models

在本节中，您可以找到有关如何使用 UiPath.Studio.Analyzer.Models 构建活动的更多信息。

ArgumentDirection

表示参数方向的枚举。

属性

值	描述
取消设置	默认值。
输入	表示数据流入活动或项目的参数。
输出	表示数据从活动或项目中流出的参数。
输入输出	一个参数，表示传入和传出活动或项目的数据流。
属性	当前未使用。

IActivityContext

表示工作流中任何活动的上下文。

属性

类型	名称	描述
IReadOnlyCollection<IVariableModel>	变量	此活动可见的变量。
IReadOnlyCollection<IArgumentModel>	DelegateArguments	其中的委派参数对此活动可见。 需要 Studio 2020.4 或更高版本。
IReadOnlyCollection<IArgumentModel>	WorkflowArguments	此活动可见的参数。
IProjectSummary	项目	包含此活动的项目的相关信息。

IActivityModel

表示工作流中的活动。

继承

IInspectionObject > IActivityModel

属性

类型	名称	描述
字符串	类型	活动的程序集限定类型名称。
IReadOnlyCollection<IVariableModel>	变量	此活动中定义的变量。
IReadOnlyCollection<IArgumentModel>	DelegateArguments	此活动中定义的委派参数。 需要 Studio 2020.4 或更高版本。
IReadOnlyCollection<IArgumentModel>	参数	此活动中定义的参数。
IReadOnlyCollection<IArgumentModel>	InternalArguments	此活动中定义的不可浏览参数（将BrowsableAttribute 设置为 false）。
IReadOnlyCollection<IPropertyModel>	属性	此活动的属性。
IReadOnlyCollection<IPropertyModel>	InternalProperties	此活动的不可浏览属性 (BrowsableAttribute 设置为 false)。
IReadOnlyCollection<IActivityModel>	子项	此活动的子活动集合。
IActivityModel	父项	此活动的父活动。
IActivityContext	上下文	此活动的上下文。
IReadOnlyCollection<string>	ObjectReferences	此活动在对象库中使用的引用。
Bool	SupportsObjectReferences	如果设置为 True，则此活动支持使用对象库。
字符串	ToolboxName	在工具箱中注册的活动名称。 需要 Studio 2020.10 或更高版本。
字符串	AnnotationText	注释的文本。 需要 Studio 2021.4 或更高版本。
IPackageBindingModel	PackageBinding	此活动的关联包绑定。

IArgumentModel

表示参数。

继承

IMemberModel > IVariableModel > IArgumentModel

属性

类型	名称	描述
ArgumentDirection	方向	此参数的方向。

ICaseModel

表示“切换”活动中的用例活动。

继承

IInspectionObject > ICaseModel

属性

类型	名称	描述
IActivityModel	活动	与此案例关联的活动。
字符串	CaseExpression	触发此案例的表达式。
IReadOnlyCollection<IVariableModel>	变量	此活动中定义的变量。
IReadOnlyCollection<IArgumentModel>	参数	此活动中定义的参数。
IReadOnlyCollection<IPropertyModel>	属性	此活动的属性。
IReadOnlyCollection<IActivityModel>	子项	此活动的子活动集合。
IActivityModel	父项	此活动的父活动。
IActivityContext	上下文	此活动的上下文。

IConnection

表示两个流程图节点之间的连接。

属性

类型	名称	描述
字符串	密钥类型	连接密钥的程序集限定名称。
字符串	KeyExpression	此连接的键值。
IFlowNodeModel	节点	此连接的来源或目标。

IDependency

表示项目依赖项。

继承

IInspectionObject > IFileModel

属性

类型	名称	描述
字符串	名称	依赖项的名称。
IReadOnlyCollection<string>	程序集	引用的程序集的列表。

IExpressionContainer

注意： 此功能是在 UiPath.Studio.Activities.Api v21.4 中引入的。

表示包含表达式的工作流元素。

继承

IInspectionObject > IWorkflowElement > IExpressionContainer

属性

类型	名称	描述
IEnumerable<IExpressionModel>	GetExpressions()	返回此工作流元素中的所有表达式模型，例如变量默认值、参数默认值、属性参数表达式、条件等。
IEnumerable<IExpressionContainer>	GetChildExpressionContainers()	返回可以作为表达式容器的所有子项，例如活动、节点、状态、转换。

IExpressionModel

注意： 此功能是在 UiPath.Studio.Activities.Api v21.4 中引入的。

表示根据表达式类型填充的表达式模型（DefaultValue 表示变量和工作流参数， DefinedExpression 表示活动参数）。

继承

IMemberModel > IExpressionModel

属性

类型	名称	描述
字符串	默认值	此变量或参数的默认值。

IFileModel

表示文件。

继承

IInspectionObject > IFileModel

属性

类型	名称	描述
字符串	RelativePath	文件的相对路径，包括扩展名。

IFlowchartModel

表示流程图。

继承

IInspectionObject > IActivityModel > IFlowchartModel

属性

类型	名称	描述
IReadOnlyCollection<IFlowNodeModel>	Nodes	此流程图中的 IFlowNodeModel 集合。
IFlowNodeModel	StartNode	此流程图中的开始节点。

IFlowNodeModel

表示流程图中的节点。

继承

IInspectionObject > IWorkflowElement > IExpressionContainer > IFlowNodeModel

属性

类型	名称	描述
IActivityModel	ChildActivity	此节点中定义的活动。
IReadOnlyCollection<IConnection>	OutConnections	此节点的传出连接。
IReadOnlyCollection<IConnection>	InConnections	此节点的传入连接。
IMemberModel	表达式	为决定下一步而评估的表达式。
IFlowChartModel	所有者	此节点的流程图所有者。

IIfElseModel

表示“IF 条件”活动。

继承

IInspectionObject > IActivityModel > IIfElseModel

属性

类型	名称	描述
IActivityModel	ThenBlock	在 Then 块中定义的活动。
IActivityModel	ElseBlock	在 Else 块中定义的活动。

IInspectionObject

表示工作流分析器检查的对象。

属性

类型	名称	描述
字符串	显示名称	向用户显示的对象的名称。

IMemberModel

表示另一个模型的成员。

属性

类型	名称	描述
字符串	显示名称	向用户显示的成员名称。
字符串	类型	此用户的程序集限定名称。
字符串	DefinedExpression	此成员的表达式或值。
bool?	HasLiteralExpression	Returns true if the defined expression is a Literal<string>. Requires Studio 2022.4 or later.

备注

如果表达式是Literal<string> ，则系统会使用双引号将其转义，例如""This is a plain string"" 。

IObjectBrowserSummary

注意： 此功能是在 UiPath.Studio.Activities.Api v22.4 中引入的。

有关项目中对象存储库集成的信息。

属性

类型	名称	描述
IReadOnlyCollection<IDependency>	ClientDependencies	注册对象存储库功能的项目依赖项。
Bool	HasObjectsInLocalSource	如果在项目本地对象存储库中定义了至少一个对象，则返回 true 。

IPackageReference

表示项目包引用。

继承

IInspectionObject > IFileModel > IDependency > IPackageReference

属性

类型	名称	描述
字符串	版本	包的版本。

IPickBranchModel

表示“ IPickModel” 活动的分支。

继承

IVariableContainer, IExpressionContainer > IPickBranchModel

属性

类型	名称	描述
IActivityModel	触发器	触发此分支的活动。
IActivityModel	操作	在此分支中执行的活动。
IActivityModel	父项	父 级选取 活动。

备注

如果表达式是Literal<string> ，则系统会使用双引号将其转义，例如""This is a plain string"" 。

IPickModel

表示“选取分支”活动。

继承

IInspectionModel > IActivityModel > IPickModel

属性

类型	名称	描述
IEnumerable<IPickBranchModel>	PickBranches	此“选取分支”活动中定义的“ IPickBranchModel ”集合。

IProjectModel

表示完整的项目表示，包括包含的工作流解析模型。 系统将对此模型运行项目分析。

继承

IInspectionObject > IProjectSummary > IProjectModel

属性

类型	名称	描述
IWorkflowModel	EntryPoint	项目的入口点工作流。
IWorkflowModel	ExceptionHandlerWorkflow	项目中的异常处理工作流。
IReadOnlyCollection<IWorkflowModel>	Workflows	项目中的工作流。

IProjectSummary

表示有关项目的部分信息。 与 IProjectModel不同，IProjectSummary 仅保存在解析所包含的工作流文件之前可用的信息。 它对于工作流分析和项目定义分析非常有用。

继承

IInspectionObject > IProjectSummary

属性

类型	名称	描述
字符串	目录	项目目录。 需要 Studio 2021.4 或更高版本。
IReadOnlyCollection<string>	FileNames	此项目中工作流文件的名称。
IReadOnlyCollection<IDependency>	依赖项	此项目的依赖项。
字符串	ProjectOutputType	此项目的输出类型
字符串	ProjectProfileType	此项目的配置文件类型。
字符串	ExpressionLanguage	此项目的表达式语言
Bool	RequiresUserInteraction	指示项目是否需要用户交互。
Bool	支持暂留	指示项目是否支持暂留。
Bool	HasModernBehavior	指示项目是否使用新式设计体验。 需要 Studio 2022.4 或更高版本。
字符串	EntryPointName	项目的入口点工作流名称。
字符串	ProjectFilePath	project.json 文件的文件路径。
字符串	ExceptionHandlerWorkflowName	此项目的异常处理工作流名称。
IReadOnlyCollection<string>	入口点	项目中的入口点列表。 需要 Studio 2020.10 或更高版本。
IReadOnlyCollection<string>	IgnoredFiles	项目中从发布中忽略的文件列表。 需要 Studio 2020.10 或更高版本。
IReadOnlyCollection<string>	测试用例	项目中的测试用例列表。 需要 Studio 2021.4 或更高版本。
IReadOnlyCollection<string>	文件模板	项目中的文件模板列表。 需要 Studio 2021.10 或更高版本。 注意： 此属性已弃用。 请改用 模板 。
IReadOnlyCollection<string>	模板	项目中所有模板的列表。 需要 Studio 2022.4 或更高版本。
IObjectBrowserSummary	ObjectBrowserSummary	项目中对象存储库信息摘要。 需要 Studio 2022.4 或更高版本。

IPropertyModel

表示模型的属性。

继承

IMemberModel > IPropertyModel

属性

类型	名称	描述
IReadOnlyCollection<IPropertyModel>	属性	此属性的属性。
IReadOnlyCollection<IPropertyModel>	InternalProperties	此属性的不可浏览属性集合 (可浏览的属性设置为 false)。 无法深入解析不可浏览的属性。
IReadOnlyCollection<IArgumentModel>	参数	此属性的参数。
IReadOnlyCollection<IArgumentModel>	InternalArguments	此属性的不可浏览参数集合 (可浏览属性设置为 false)。

IStateMachineModel

表示“状态机”活动。

继承

IInspectionObject > IActivityModel > IStateMachineModel

属性

类型	名称	描述
IReadOnlyCollection<IStateModel>	状态	此状态机活动中的 IStateModel 集合。
IStateModel	InitialState	此状态机活动的起点。

IStateModel

表示“ IStateMachineModel ”活动中的“状态”。

继承

IInspectionObject, IVariableContainer, IExpressionContainer > IStateModel

属性

类型	名称	描述
IActivityContext	上下文	此状态的继承上下文。
IReadOnlyCollection<ITransition>	Transitions	此状态下可用的传出转换。
IActivityModel	条目	状态的输入 Actions 。
IActivityModel	退出	状态的退出 Actions 。
IStateMachineModel	所有者	包含此状态的“状态机”活动。
Bool	IsFinal	如果 true，则表示此状态为最终状态。
IReadOnlyCollection<IVariableModel>	变量	在此状态中定义的变量集合。

ISwitchModel

表示“切换”活动。

继承

IInspectionObject > IActivityModel > ISwitchModel

属性

类型	名称	描述
IActivityModel	默认	与此活动的“默认”块关联的活动。 值可以为 null。
IEnumerable<ICaseModel>	case 子句	此活动中的“ ICaseModel ”集合。

ITemplateModel

注意： 此功能是在 UiPath.Studio.Activities.Api v22.4 中引入的。

包含有关特定文件模板的信息。

属性

类型	名称	描述
字符串	路径	模板的路径。
TemplateType	类型	模板的类型 (执行、测试用例、通用)。
字符串	DataVariation	数据变体的路径。

ITransition

表示从状态机中的 IStateModel 进行的转换。

继承

IInspectionObject, IVariableContainer, IExpressionContainer > ITransition

属性

类型	名称	描述
IStateModel	来源	转移的来源州。
IStateModel	目标	此转换导致的状态。
IActivityModel	操作	进行转换时要执行的活动。
IActivityModel	条件	用于决定是否在触发器活动完成后进行转换的条件。
IActivityModel	触发器	此转换的触发器活动。

ITryCatchModel

表示“Try Catch 异常处理”活动。

继承

IInspectionObject > IActivityModel > ITryCatchModel

属性

类型	名称	描述
IActivityModel	TryBlock	与此活动的 Try 块关联的活动。 值可以为 null。
IEnumerable<ICatchBlockModel>	捕获内容	此活动中的集合。
IActivityModel	FinallyBlock	与 Finally 块关联的活动。

IVariableContainer

注意： 此功能是在 UiPath.Studio.Activities.Api v21.4 中引入的。

表示包含变量的工作流元素。

继承

IInspectionObject > IWorkflowElement > IVariableContainer

属性

类型	名称	描述
IReadOnlyCollection<IVariableModel>	变量	变量集合。
IEnumerable<IVariableContainer>	GetChildVariableContainers()	获取支持变量列表的子项。

IVariableModel

表示变量。

继承

IMemberModel > IVariableModel

属性

类型	名称	描述
字符串	默认值	此变量的默认值。

IWebServiceRerefence

表示项目中的网页服务引用。

继承

IInspectionObject > IFileModel > IDependency > IWebServiceRerefence

属性

类型	名称	描述
字符串	WebDocumentUri	网页文档地址。
字符串	WebServiceType	网页服务的类型。

IWorkflowElement

注意： 此功能是在 UiPath.Studio.Activities.Api v21.4 中引入的。

表示工作流元素。

继承

IInspectionObject > IWorkflowElement

属性

类型	名称	描述
字符串	ID	生成的工作流 ID。 可以为 null。
字符串	类型	工作流元素的类型
IWorkflowElement	ImmediateParent	工作流元素的直属父项。 它可以是IFlowNodeModel 、 IStateModel 、 IPickBranchModel 、 ITransition和IActivityModel 。
IEnumerable<IWorkflowElement>	GetChildren()	直接的第一级子项（不仅限于 IActivityModel）。

IWorkflowModel

表示项目中的工作流文件。

继承

IInspectionObject > IFileModel > IWorkflowModel

属性

类型	名称	描述
IActivityModel	根	工作流的根活动。 值可以为 null。
IReadOnlyCollection<IArgumentModel>	参数	工作流的参数。
IReadOnlyCollection<string>	导入的命名空间	工作流的导入命名空间。
IProjectSummary	项目	此工作流所属的项目。
IReadOnlyCollection<string>	程序集	工作流的程序集。 需要 Studio 2021.4 或更高版本。