Class DocumentField

An object representing the content and location of a field value.

Inheritance

System.Object

DocumentField

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.AI.FormRecognizer.dll

Syntax

public class DocumentField

Properties

BoundingRegions

Bounding regions covering the field.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.DocumentAnalysis.BoundingRegion> BoundingRegions { get; }

Property Value

System.Collections.Generic.IReadOnlyList<BoundingRegion>

Confidence

Confidence of correctly extracting the field.

Declaration

public Nullable<float> Confidence { get; }

Property Value

System.Nullable<System.Single>

Content

Field content.

Declaration

public string Content { get; }

Property Value

System.String

Spans

Location of the field in the reading order concatenated content.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentSpan> Spans { get; }

Property Value

System.Collections.Generic.IReadOnlyList<DocumentSpan>

ValueType

The data type of the field value.

Declaration

public Azure.AI.FormRecognizer.DocumentAnalysis.DocumentFieldType ValueType { get; }

Property Value

DocumentFieldType

Methods

AsAddress()

Gets the value of the field as an AddressValue.

Declaration

public Azure.AI.FormRecognizer.DocumentAnalysis.AddressValue AsAddress ();

Returns

AddressValue The value of the field converted to an AddressValue.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Address.

AsCountryRegion()

Gets the value of the field as an ISO 3166-1 alpha-3 country code System.String.

Declaration

public string AsCountryRegion ();

Returns

System.String The value of the field converted to an ISO 3166-1 alpha-3 country code System.String.

Exceptions

System.InvalidOperationException Thrown when ValueType is not CountryRegion.

AsCurrency()

Gets the value of the field as a CurrencyValue.

Declaration

public Azure.AI.FormRecognizer.DocumentAnalysis.CurrencyValue AsCurrency ();

Returns

CurrencyValue The value of the field converted to CurrencyValue.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Currency.

AsDate()

Gets the value of the field as a System.DateTime.

Declaration

public DateTime AsDate ();

Returns

System.DateTime The value of the field converted to a System.DateTime.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Date or when the value is null.

AsDictionary()

Gets the value of the field as a System.Collections.Generic.Dictionary`2.

Declaration

public System.Collections.Generic.IReadOnlyDictionary<string,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentField> AsDictionary ();

Returns

System.Collections.Generic.IReadOnlyDictionary<System.String,DocumentField> The value of the field converted to a System.Collections.Generic.Dictionary`2.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Dictionary.

AsDouble()

Gets the value of the field as a System.Double.

Declaration

public double AsDouble ();

Returns

System.Double The value of the field converted to a System.Double.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Double.

AsInt64()

Gets the value of the field as a System.Int64.

Declaration

public long AsInt64 ();

Returns

System.Int64 The value of the field converted to a System.Int64.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Int64 or when the value is null.

AsList()

Gets the value of the field as an System.Collections.Generic.IReadOnlyList.

Declaration

public System.Collections.Generic.IReadOnlyList<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentField> AsList ();

Returns

System.Collections.Generic.IReadOnlyList<DocumentField> The value of the field converted to an System.Collections.Generic.IReadOnlyList.

Exceptions

System.InvalidOperationException Thrown when ValueType is not List.

AsPhoneNumber()

Gets the value of the field as a phone number System.String.

Declaration

public string AsPhoneNumber ();

Returns

System.String The value of the field converted to a phone number System.String.

Exceptions

System.InvalidOperationException Thrown when ValueType is not PhoneNumber.

AsSelectionMarkState()

Gets the value of the field as a SelectionMarkState.

Declaration

public Azure.AI.FormRecognizer.DocumentAnalysis.SelectionMarkState AsSelectionMarkState ();

Returns

SelectionMarkState The value of the field converted to SelectionMarkState.

Exceptions

System.InvalidOperationException Thrown when ValueType is not SelectionMark.

AsSignatureType()

Gets the value of the field as a DocumentSignatureType.

Declaration

public Azure.AI.FormRecognizer.DocumentAnalysis.DocumentSignatureType AsSignatureType ();

Returns

DocumentSignatureType The value of the field converted to DocumentSignatureType.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Signature.

AsString()

Gets the value of the field as a System.String.

Declaration

public string AsString ();

Returns

System.String The value of the field converted to a System.String.

Exceptions

System.InvalidOperationException Thrown when ValueType is not String.

AsTime()

Gets the value of the field as a System.TimeSpan.

Declaration

public TimeSpan AsTime ();

Returns

System.TimeSpan The value of the field converted to a System.TimeSpan.

Exceptions

System.InvalidOperationException Thrown when ValueType is not Time or when the value is null.

ToString()

Returns a string that represents the DocumentField object.

Declaration

public override string ToString ();

Returns

System.String A string that represents the DocumentField object.