activities
latest
false
- Overview
- Document Processing Contracts
- Release notes
- About the Document Processing Contracts
- Box Class
- IPersistedActivity interface
- PrettyBoxConverter Class
- IClassifierActivity Interface
- IClassifierCapabilitiesProvider Interface
- ClassifierDocumentType Class
- ClassifierResult Class
- ClassifierCodeActivity Class
- ClassifierNativeActivity Class
- ClassifierAsyncCodeActivity Class
- ClassifierDocumentTypeCapability Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- ICapabilitiesProvider Interface
- IExtractorActivity Interface
- ExtractorPayload Class
- DocumentActionPriority Enum
- DocumentActionData Class
- DocumentActionStatus Enum
- DocumentActionType Enum
- DocumentClassificationActionData Class
- DocumentValidationActionData Class
- UserData Class
- Document Class
- DocumentSplittingResult Class
- DomExtensions Class
- Page Class
- PageSection Class
- Polygon Class
- PolygonConverter Class
- Metadata Class
- WordGroup Class
- Word Class
- ProcessingSource Enum
- ResultsTableCell Class
- ResultsTableValue Class
- ResultsTableColumnInfo Class
- ResultsTable Class
- Rotation Enum
- SectionType Enum
- WordGroupType Enum
- IDocumentTextProjection Interface
- ClassificationResult Class
- ExtractionResult Class
- ResultsDocument Class
- ResultsDocumentBounds Class
- ResultsDataPoint Class
- ResultsValue Class
- ResultsContentReference Class
- ResultsValueTokens Class
- ResultsDerivedField Class
- ResultsDataSource Enum
- ResultConstants Class
- SimpleFieldValue Class
- TableFieldValue Class
- DocumentGroup Class
- DocumentTaxonomy Class
- DocumentType Class
- Field Class
- FieldType Enum
- LanguageInfo Class
- MetadataEntry Class
- TextType Enum
- TypeField Class
- ITrackingActivity Interface
- ITrainableActivity Interface
- ITrainableClassifierActivity Interface
- ITrainableExtractorActivity Interface
- TrainableClassifierAsyncCodeActivity Class
- TrainableClassifierCodeActivity Class
- TrainableClassifierNativeActivity Class
- TrainableExtractorAsyncCodeActivity Class
- TrainableExtractorCodeActivity Class
- TrainableExtractorNativeActivity Class
- Document Understanding Digitizer
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Set PDF Password
- Merge PDFs
- Get PDF Page Count
- Extract PDF Text
- Extract PDF Images
- Extract PDF Page Range
- Extract Document Data
- Create Validation Task and Wait
- Wait for Validation Task and Resume
- Create Validation Task
- Classify Document
- Create Classification Validation Task
- Create Classification Validation Task and Wait
- Wait for Classification Validation Task and Resume
- Intelligent OCR
- Release notes
- About the IntelligentOCR activity package
- Project compatibility
- Configuring Authentication
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- Wait For Document Classification Action And Resume
- Train Classifiers Scope
- Keyword Based Classifier Trainer
- Intelligent Keyword Classifier Trainer
- Data Extraction Scope
- Document Understanding Project Extractor
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Present Validation Station
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- ML Services
- OCR
- OCR Contracts
- Release notes
- About the OCR Contracts
- Project compatibility
- IOCRActivity Interface
- OCRAsyncCodeActivity Class
- OCRCodeActivity Class
- OCRNativeActivity Class
- Character Class
- OCRResult Class
- Word Class
- FontStyles Enum
- OCRRotation Enum
- OCRCapabilities Class
- OCRScrapeBase Class
- OCRScrapeFactory Class
- ScrapeControlBase Class
- ScrapeEngineUsages Enum
- ScrapeEngineBase
- ScrapeEngineFactory Class
- ScrapeEngineProvider Class
- OmniPage
- PDF
- [Unlisted] Abbyy
- [Unlisted] Abbyy Embedded
OCRScrapeBase Class
Document Understanding Activities
Last updated Nov 26, 2024
OCRScrapeBase Class
An abstract class that defines the behavior of an
IOCRActivity
in a screen scraping operation.
Constructors
OCRScrapeBase(UiPath.OCR.Contracts.Activities.IOCRActivity)
- Initializes a new instance of the OCR scrape engine. The constructor argument is an Activity that implements theIOCRActivity
.
Methods
CreateOcrEngineActivity(System.Activities.InArgument<System.Drawing.Image>)
- Returns a new OCR Activity object with the specified Image set as an InArgument.GetScrapeArguments()
System.Collections.Generic.Dictionary<string, object>
- Collects all theUiPath.OCR.Contracts.Activities.IOCRActivity
arguments from the scrape control. These arguments is used to run theUiPath.OCR.Contracts.Activities.IOCRActivity
,PerformOCR
method and to fill the activity arguments when the activity is created to be used in a workflow.GetScrapeControl()
- Gets the control that is shown on the screen.GetScrapeControl(UiPath.OCR.Contracts.Scrape.ScrapeEngineUsages)
- Returns the UserControl that can be used to configure this OCR engine.OCRScrapeBase(UiPath.OCR.Contracts.Activities.IOCRActivity)
- Activity constructor.ScrapeOCRAsync(System.Drawing.Bitmap)
- Asynchronously performs OCR on the specified Image.ScrapeOCRAsync(System.Drawing.Bitmap, UiPath.OCR.Contracts.Scrape.ScrapeEngineUsages, System.Threading.CancellationToken)
- Asynchronously performs OCR on the specified Image. Can be canceled. Allows the caller to specify whether the OCR should be performed in Screen or Document mode.
Properties
Name
- Custom display the name given to this OCR. This name is visible in certain drop-down controls.Priority
- Custom priority is given to this OCR. Lower values indicate higher priority. This determines the ordering of OCR engines in certain drop-down controls.
internal class SampleOCRScrape : OCRScrapeBase
{
private readonly ScrapeEngineUsages _usage;
private readonly SampleScrapeControl _sampleScrapeControl = new SampleScrapeControl();
public override ScrapeEngineUsages Usage { get; } = ScrapeEngineUsages.Document | ScrapeEngineUsages.Screen;
public SampleOCRScrape(IOCRActivity ocrEngineActivity, ScrapeEngineUsages usage) : base(ocrEngineActivity)
{
_usage = usage;
}
public override ScrapeControlBase GetScrapeControl()
{
return _sampleScrapeControl;
}
public override Dictionary<string, object> GetScrapeArguments()
{
return new Dictionary<string, object>
{
{ nameof(SampleOCRAsyncCodeActivity.CustomInput), _sampleScrapeControl.SampleInput }
};
}
}
internal class SampleOCRScrape : OCRScrapeBase
{
private readonly ScrapeEngineUsages _usage;
private readonly SampleScrapeControl _sampleScrapeControl = new SampleScrapeControl();
public override ScrapeEngineUsages Usage { get; } = ScrapeEngineUsages.Document | ScrapeEngineUsages.Screen;
public SampleOCRScrape(IOCRActivity ocrEngineActivity, ScrapeEngineUsages usage) : base(ocrEngineActivity)
{
_usage = usage;
}
public override ScrapeControlBase GetScrapeControl()
{
return _sampleScrapeControl;
}
public override Dictionary<string, object> GetScrapeArguments()
{
return new Dictionary<string, object>
{
{ nameof(SampleOCRAsyncCodeActivity.CustomInput), _sampleScrapeControl.SampleInput }
};
}
}