活动文件

重要提示： 本文档指的是 UiPath Activity Creator for Visual Studio 的已弃用版本。 请在 此处查看新文档。

简介

每个活动都以活动类文件开头，该类文件定义了活动的输入、输出和执行逻辑。 为了更好地理解这是如何完成的，请在“活动”项目中打开“ ChildActivity.cs ”文件，并逐节浏览该文件。 这是一个简单的活动，它将两个数字相加并输出它们的总和。

using System;
using System.Activities;
using System.Threading;
using System.Threading.Tasks;
using MyCompany.MyProduct.Activities.Properties;
using UiPath.Shared.Activities;
namespace MyCompany.MyProduct.Activities
{
    [LocalizedDisplayName(nameof(Resources.ChildActivityDisplayName))]
    [LocalizedDescription(nameof(Resources.ChildActivityDescription))]
    public class ChildActivity : AsyncTaskCodeActivity
    {
        #region Properties
        [LocalizedDisplayName(nameof(Resources.ChildActivityFirstNumberDisplayName))]
        [LocalizedDescription(nameof(Resources.ChildActivityFirstNumberDescription))]
        [LocalizedCategory(nameof(Resources.Input))]
        public InArgument<int> FirstNumber { get; set; }
        [LocalizedDisplayName(nameof(Resources.ChildActivitySecondNumberDisplayName))]
        [LocalizedDescription(nameof(Resources.ChildActivitySecondNumberDescription))]
        [LocalizedCategory(nameof(Resources.Input))]
        public InArgument<int> SecondNumber { get; set; }
        [LocalizedDisplayName(nameof(Resources.ChildActivitySumDisplayName))]
        [LocalizedDescription(nameof(Resources.ChildActivitySumDescription))]
        [LocalizedCategory(nameof(Resources.Output))]
        public OutArgument<string> Sum { get; set; }
        #endregion
          
        #region Constructors
          
        public ChildActivity()
        {
              Constraints.Add(ActivityConstraints.HasParentType<ChildActivity, ParentScope>(Resources.ValidationMessage));
        }
      
        #endregion
          
        #region Protected Methods
        protected override void CacheMetadata(CodeActivityMetadata metadata)
        {
              if (FirstNumber == null) metadata.AddValidationError(string.Format(Resources.MetadataValidationError, nameof(FirstNumber)));
              if (SecondNumber == null) metadata.AddValidationError(string.Format(Resources.MetadataValidationError, nameof(SecondNumber)));
              base.CacheMetadata(metadata);
        }
        protected override async Task<Action<AsyncCodeActivityContext>> ExecuteAsync(AsyncCodeActivityContext context, CancellationToken cancellationToken)
        {
              var property = context.DataContext.GetProperties()[ParentScope.ApplicationTag];
              var app = property.GetValue(context.DataContext) as Application;
           
              var firstValue = FirstNumber.Get(context);
              var secondValue = SecondNumber.Get(context);
        
              var sum = app.Sum(firstValue, secondValue);
              return ctx =>
              {
                  Sum.Set(ctx, sum);
              };
       }
        #endregion
    }
}

导入和命名空间

文件以标准样板文件开头。 它会导入一些命名空间，然后声明此活动本身将位于 MyCompany.MyProduct.Activities 命名空间中。

using System;
using System.Activities;
using System.Threading;
using System.Threading.Tasks;
using MyCompany.MyProduct.Activities.Properties;
using UiPath.Shared.Activities;
namespace MyCompany.MyProduct.Activities
{

类定义

所有标准活动类（例如示例子活动）都扩展了 AsyncTaskCodeActivity ，它提供了在设计时验证属性和运行时执行逻辑的方法，可以在解决方案中包含的共享文件夹中找到它们。 此外，扩展 AsyncTaskCodeActivity 的所有活动都可以异步运行，从而允许它们与 UiPath Studio 中的“并行”和“并行 遍历循环”活动一起使用。

[LocalizedDisplayName(nameof(Resources.ChildActivityDisplayName))]
[LocalizedDescription(nameof(Resources.ChildActivityDescription))]
public class ChildActivity : AsyncTaskCodeActivity
{

在“ChildActivity”类定义上方，您会看到两个属性，即LocalizedDisplayName 和 LocalizedDescription 。 这些可用于设置 UiPath Studio 活动窗格中显示的活动的名称和工具提示说明。 在此示例中，属性引用每个属性的本地化版本（例如 Resources.ChildActivityDisplayName ），但也可以使用简单的字符串。 有关本地化的更多信息，请参阅此处。

属性

接下来是活动的属性，这些属性显示在 UiPath Studio 的“属性”窗格中。 与顶层活动一样，每个属性都有一个显示名称和说明，但还包括一个“类别” 属性，以帮助对相关活动进行分组。 请注意， FirstNumber 和 SecondNumber 在“输入”类别中的显示方式，而 Sum 则出现在“输出”类别下。

[LocalizedDisplayName(nameof(Resources.ChildActivityFirstNumberDisplayName))]
[LocalizedDescription(nameof(Resources.ChildActivityFirstNumberDescription))]
[LocalizedCategory(nameof(Resources.Input))]
public InArgument<int> FirstNumber { get; set; }
[LocalizedDisplayName(nameof(Resources.ChildActivitySecondNumberDisplayName))]
[LocalizedDescription(nameof(Resources.ChildActivitySecondNumberDescription))]
[LocalizedCategory(nameof(Resources.Input))]
public InArgument<int> SecondNumber { get; set; }
[LocalizedDisplayName(nameof(Resources.ChildActivitySumDisplayName))]
[LocalizedDescription(nameof(Resources.ChildActivitySumDescription))]
[LocalizedCategory(nameof(Resources.Output))]
public OutArgument<int> Sum { get; set; }

属性可以声明为 InArgument 、 InOutArgument或 OutArgument 类型，并且必须指明其预期类型（例如 string、int 等)。

构造函数

public ChildActivity()
{
     FirstNumber = 10;
     Constraints.Add(ActivityConstraints.HasParentType<ChildActivity, ParentScope>(Resources.ValidationMessage));
}

构造函数用于设置属性的默认值和约束。

• 在上面的示例中， FirstNumber 属性的默认值是 10，该值显示在“属性”窗格中。
  
  

  

  
  

• 此外，系统还对活动本身施加了一个约束，要求将其置于“父作用域” 范围内。 如果不是，则会显示验证错误。

  
  

  

  
  

CacheMetadata

缓存元数据 提供对活动属性、委派和/或子活动的验证。 在此示例中，我们检查是否已为两个输入属性FirstNumber 和 SecondNumber提供值，如果未提供任何一个，则引发验证错误。 在处理验证错误之前，工作流将不会运行。

protected override void CacheMetadata(CodeActivityMetadata metadata)
{
    if (FirstNumber == null) metadata.AddValidationError(string.Format(Resources.MetadataValidationError, nameof(FirstNumber)));
    if (SecondNumber == null) metadata.AddValidationError(string.Format(Resources.MetadataValidationError, nameof(SecondNumber)));
    base.CacheMetadata(metadata);
}

ExecuteAsync

ExecuteAsync 是保存活动执行逻辑的位置。

• 该方法的前两行查询活动上下文（或子活动及其周围元素的当前状态），以从“父作用域”中检索 Application 对象（如果该对象周围有对象）。 请注意，由于在上面的构造函数中添加了约束，如果此活动不在“父级作用域”中，则永远不会允许运行。
• 接下来的行获取 FirstNumber 和 SecondNumber 属性的当前值，并将其保存到局部变量中。
• 最后几行对输入的数字执行“求和”运算，并将 Sum 属性设置为此值。 由于 Sum 是输出属性，因此工作流中的后续活动可能会使用此值。

  protected override async Task<Action<AsyncCodeActivityContext>> ExecuteAsync(AsyncCodeActivityContext context, CancellationToken cancellationToken)
  {
      var property = context.DataContext.GetProperties()[ParentScope.ApplicationTag];
      var app = property.GetValue(context.DataContext) as Application;
             
      var firstValue = FirstNumber.Get(context);
      var secondValue = SecondNumber.Get(context);
          
      var sum = app.Sum(firstValue, secondValue);
      return ctx =>
      {
          Sum.Set(ctx, sum);
      };
  }

  重要提示：

  请注意，ExecuteAsync 方法返回 Task<Action<AsyncCodeActivityContext>> 对象。

  系统将返回 Task ，以便此活动可以异步运行。

  此任务将返回 Action ，以便在任何异步操作完成后执行复杂的函数。 在上面的示例中，此函数只是设置 Sum的值。

  最后， Action 接受 AsyncCodeActivityContext 参数，因此在异步操作完成后运行的任何此类函数都可以使用此活动的上下文。 否则，上下文可能会丢失，并且 Sum 将无法轻松修改。