activities
latest
false
Document Understanding activities
- 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
- ContentValidationData Class
- EvaluatedBusinessRulesForFieldValue Class
- EvaluatedBusinessRuleDetails Class
- ExtractorAsyncCodeActivity Class
- ExtractorCodeActivity Class
- ExtractorDocumentType Class
- ExtractorDocumentTypeCapabilities Class
- ExtractorFieldCapability Class
- ExtractorNativeActivity Class
- ExtractorResult Class
- FieldValue Class
- FieldValueResult 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
- Rule Class
- RuleResult Class
- RuleSet Class
- RuleSetResult Class
- 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
- FieldValueDetails Class
- 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
- BasicDataPoint Class
- BasicValue Class
- ComponentCollectionFacade Class
- DataPointFacadeBase Class
- ExtractionResultHandler Class
- FieldGroupDataPoint Class
- FieldGroupValue Class
- FieldLookupBase Class
- FieldRedactionSettings Class
- RedactionOptions Class (Preview)
- RedactionType Enum
- ResultsValueFacadeBase Class
- TableDataPoint Class
- TableRow Class
- TableValue Class
- WildcardDataPoint Class
- WildcardDataPointCollection Class
- Document Understanding ML
- Document Understanding OCR Local Server
- Document Understanding
- Release notes
- About the Document Understanding activity package
- Project compatibility
- Configuring external connection
- Document Understanding coded automation APIs (preview)
- 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
- Create Document Validation Artifacts
- Retrieve Document Validation Artifacts
- 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
- Load Taxonomy
- Digitize Document
- Classify Document Scope
- Keyword Based Classifier
- Document Understanding Project Classifier
- Intelligent Keyword Classifier
- Create Document Classification Action
- Create Document Validation Artifacts
- Retrieve Document Validation Artifacts
- 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
- Document Understanding Project Extractor Trainer
- RegEx Based Extractor
- Form Extractor
- Intelligent Form Extractor
- Redact Document
- Create Document Validation Action
- Wait For Document Validation Action And Resume
- Train Extractors Scope
- Export Extraction Results
- Machine Learning Extractor
- Machine Learning Extractor Trainer
- Machine Learning Classifier
- Machine Learning Classifier Trainer
- Generative Classifier
- Generative Extractor
- Configuring Authentication
- 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
FieldRedactionSettings class, defining the redaction appearance for a single field or for the Words To Redact input in the Redact Document activity.
FieldRedactionSettings is a public class that defines the redaction appearance for a single field, used by the RedactionOptions input of the Redact Document activity.
Definition
- Namespace:
UiPath.DocumentProcessing.Contracts.Redaction - Assembly:
UiPath.DocumentProcessing.Contracts
Description
Each FieldRedactionSettings entry controls how the redaction box is drawn for a specific field, overriding the global redaction settings on the activity. When FieldId is empty, the entry applies to the values matched through the Words To Redact input instead of a taxonomy field.
Members
Properties
FieldIdString- The id of the taxonomy field the settings apply to. If empty, the settings apply to the Words To Redact input instead.BorderColorString- The border color of the redaction box, as a hexadecimal color string (for example,000000).BorderSizeInt?- The border thickness of the redaction box.RedactionCodeFontColorString- The font color of the redaction code, as a hexadecimal color string.RedactionCodeFontSizeInt?- The font size of the redaction code.RedactionCodeString- The redaction code displayed on the redaction box.FillColorString- The fill color of the redaction box, as a hexadecimal color string.FillOpacityDouble?- The opacity of the redaction box, from0(fully transparent) to1(fully opaque).RedactionTypeRedactionType- The redaction style applied to the box. For the available values, see RedactionType.
Property use by redaction type
The RedactionType value determines which appearance properties affect the output:
Fill- UsesFillColorandFillOpacityto fill the entire redaction box, andBorderColorandBorderSizeto draw the box border.StrikeThrough- UsesFillColorandFillOpacityto fill a horizontal band across the middle of the box.BorderColorandBorderSizeare not used, because a strike-through has no border.
The RedactionCode, RedactionCodeFontColor, and RedactionCodeFontSize properties apply to both redaction types.
A FillOpacity of 0 makes the fill (or the strike-through band) fully transparent, so it is not painted. Because a strike-through has no solid fill behind the label, the RedactionCodeFontColor needs to contrast with the underlying page content to stay readable.
Note:
The RedactionCode label is drawn centered inside each redaction box. When RedactionCodeFontSize is not set, the label auto-sizes to about 70% of the box height and shrinks to fit the box width.
A value is redacted one line at a time: if its text wraps across two lines, it produces two redaction boxes, one per line. The redaction code is drawn on each box, so a value spanning two lines shows the RedactionCode label on both lines.