UiPath Documentation
activities
latest
false
Document Understanding activities

FieldGroupDataPoint Class

FieldGroupDataPoint facade in the V1 navigator for a field group field, providing access to its instances and methods to add, insert, or remove them.

Definition

  • Namespace: UiPath.DocumentProcessing.Contracts.Extensions.Navigator.V1
  • Assembly: UiPath.DocumentProcessing.Contracts
  • Inherits: DataPointFacadeBase

Description

FieldGroupDataPoint is a facade for a field group field in an extraction result. It wraps a ResultsDataPoint and provides access to the field group's instances as FieldGroupValue objects.

The constructor throws System.ArgumentException if the wrapped data point is not a field group field. A FieldGroupDataPoint is typically obtained from ExtractionResultHandler.FromFieldGroup(...) or from GetFieldGroup(...) on ComponentCollectionFacade.

Members

Constructors

ConstructorDescription
FieldGroupDataPoint(ResultsDataPoint dataPoint)Initializes a new instance for a field group field. Throws ArgumentException if the field is not of type field group.

Properties

PropertyTypeDescription
ValuesFieldGroupValue[]All field group instances. Read-only.
this[int index]FieldGroupValueThe field group instance at the specified index, through indexer syntax. Read-only.

Methods

MethodReturnsDescription
GetValue(int index)FieldGroupValueReturns the field group instance at the specified index.
AddEmptyValue(Field taxonomyField)FieldGroupValueAdds a new empty field group instance built from the taxonomy definition and returns it. Throws ArgumentException if taxonomyField is not a field group type.
InsertEmptyValue(int index, Field taxonomyField)FieldGroupValueInserts a new empty field group instance built from the taxonomy definition at the specified index and returns it. Throws ArgumentException if taxonomyField is not a field group type.
Clear()FieldGroupDataPointRemoves all values from the field group and returns this instance for chaining.
Remove(int index)FieldGroupDataPointRemoves the instance 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. The taxonomyField parameter is a Field taxonomy definition.

  • Definition
  • Description
  • Members
  • Constructors
  • Properties
  • Methods
  • Inherited members

Was this page helpful?

Connect

Need help? Support

Want to learn? UiPath Academy

Have questions? UiPath Forum

Stay updated