BasicDataPoint Class

BasicDataPoint facade in the V1 navigator for a basic (non-complex) field, providing strongly-typed access to read, add, insert, update, and remove its values.

定義

• 名前空間: UiPath.DocumentProcessing.Contracts.Extensions.Navigator.V1
• アセンブリ: UiPath.DocumentProcessing.Contracts
• Inherits: DataPointFacadeBase

説明

BasicDataPoint is a facade for a basic (non-complex) field in an extraction result. It wraps a ResultsDataPoint and provides a fluent, strongly-typed API to read and edit the field's values as BasicValue objects.

The constructor throws System.ArgumentException if the wrapped data point is a complex type (table or field group). A BasicDataPoint is typically obtained from ExtractionResultHandler.FromBasicDataPoint(...) or from GetSimpleField(...) on ComponentCollectionFacade. For tables or field groups, use TableDataPoint or FieldGroupDataPoint instead.

メンバー

コンストラクター

コンストラクター	説明
BasicDataPoint(ResultsDataPoint dataPoint)	Initializes a new instance for a basic field. Throws ArgumentException if the field is a table or field group type.

プロパティ

プロパティ	入力	説明
Value	BasicValue	The first value of the field, or null if the field has no values. Read-only.
Values	BasicValue[]	All values of the field. Read-only.

メソッド

メソッド	戻り値	説明
GetValue(int index = 0)	BasicValue	Returns the value at the specified index. Defaults to the first value.
AddValue(ResultsValue value)	BasicValue	Appends an existing value to the end of the values list. Throws ArgumentNullException if value is null.
AddValue(string value, float confidence, float ocrConfidence = 0, ResultsContentReference reference = null, bool operatorConfirmed = false, ResultsDerivedField[] derivedFields = null)	BasicValue	Builds a value from the supplied properties and appends it to the values list.
InsertValue(int index, ResultsValue value)	BasicValue	Inserts an existing value at the specified index. Throws ArgumentNullException if value is null.
InsertValue(int index, string value, float confidence, float ocrConfidence = 0, ResultsContentReference reference = null, bool operatorConfirmed = false, ResultsDerivedField[] derivedFields = null)	BasicValue	Builds a value from the supplied properties and inserts it at the specified index.
UpdateValue(ResultsValue value)	BasicValue	Updates the first value with the supplied value. Adds the value if the field is missing.
UpdateValue(int index, ResultsValue value)	BasicValue	Updates the value at the specified index. Adds the value if the field is missing. Throws ArgumentNullException if value is null.
UpdateValue(int index = 0, string value = null, float? confidence = null, float? ocrConfidence = null, ResultsContentReference reference = null, bool? operatorConfirmed = null, ResultsDerivedField[] derivedFields = null)	BasicValue	Updates only the supplied (non-null) properties of the value at the specified index. Adds a value if none exists at that index.
Clear()	BasicDataPoint	Removes all values from the field and returns this instance for chaining.
Remove(int index)	BasicDataPoint	Removes the value at the specified index and returns this instance for chaining.

Inherited members

Field metadata and validator properties (FieldType, FieldId, FieldName, IsMissing, DataVersion, DataSource, OperatorConfirmed, ValidatorNotes, ValidatorNotesInfo) and GetRawDataPoint() are inherited from DataPointFacadeBase.