Skip to main content

OCRNativeActivity Class

Definition​

  • Namespace: UiPath.OCR.Contracts.Activities
  • Assembly: UiPath.OCR.Contracts

Description​

An abstract class that must be implemented in order to construct a NativeActivity from the Workflow Foundation framework.

Members​

Methods​

  • BeforeExecute(System.Activities.NativeActivityContext) System.Collections.Generic.Dictionary<string, object> - Overrides this method to compute and provide all the activity input arguments, other than the Image argument and returns activity input arguments as a dictionary where the key is the argument name and the value is the argument value.
    note

    At design time, when no context is available, the method's parameters are null. In this case, the activity arguments can't be read, so you may want to provide default values for them.

  • Execute(System.Activities.NativeActivityContext) void Execute(System.Activities.NativeActivityContext - This method can be overridden to implement the activity code. It is called by the workflow runtime to execute the activity. It also provides access to tracking, variables, and arguments.
  • OCRNativeActivity.OCRNativeActivity() - Activity constructor.
  • OnSuccess(System.Activities.NativeActivityContext, UiPath.OCR.Contracts.DataContracts.OCRResult) void OnSuccess(System.Activities.NativeActivityContext context, UiPath.OCR.Contracts.DataContracts.OCRResult result) - This method is called after computing the OCR result. It can be used to set output arguments or any other final operations.
  • PerformOCRAsync(System.Drawing.Image, System.Collections.Generic.Dictionary<string, object>, System.Threading.CancellationToken) - Processes an image and returns the extracted text information. The Options parameter is a dictionary of activity arguments having as key the argument name and as value the argument value.

Properties​

  • ExtractWords - Gets or sets if the words should be extracted.
  • Image System.Activities.InArgument<System.Drawing.Image>
    • Image to be processed.
  • Language System.Activities.InArgument<string> - The language used by the OCR engine to extract the string from the UI element.
  • Output System.Activities.OutArgument<UiPath.OCR.Contracts.OcrActivityResult>
    • The activity output. Legacy, obsolete argument.
  • Text System.Activities.OutArgument<string> - The extracted string.

Code Sample​

[DisplayName("Sample OCRNativeActivity")]
internal class SampleOCRNativeActivity : OCRNativeActivity
    {
        public InArgument<string> CustomInput { get; set; }

        public OutArgument<string> CustomOutput { get; set; }

        public override Task<OCRResult> PerformOCRAsync(Image image, Dictionary<string, object> options, CancellationToken ct)
        {
            string customInput = options[nameof(CustomInput)] as string;
            string text = $"Text from {nameof(SampleOCRNativeActivity)} with custom input: {customInput}";
            return Task.FromResult(OCRResultHelper.FromText(text));
        }

        protected override void OnSuccess(NativeActivityContext context, OCRResult result)
        {
            CustomOutput.Set(context, $"Custom output: '{result.Text}' has {result.Words.Length} words.");
        }

        protected override Dictionary<string, object> BeforeExecute(NativeActivityContext context)
        {
            return new Dictionary<string, object>
            {
                { nameof(CustomInput), CustomInput.Get(context) }
            };
        }
    }