com.azure.ai.formrecognizer.models

Class FormSelectionMark

java.lang.Object

com.azure.ai.formrecognizer.models.FormElement

com.azure.ai.formrecognizer.models.FormSelectionMark

public final class FormSelectionMark
extends FormElement

Represents a selection mark recognized from the input document.

Constructor Summary

Constructors

Constructor and Description
FormSelectionMark(String text, FieldBoundingBox boundingBox, int pageNumber) Creates a FormSelectionMark.

Method Summary

Modifier and Type	Method and Description
FieldBoundingBox	getBoundingBox() BoundingBox property of the element.
float	getConfidence() Gets the confidence property of the selection mark.
int	getPageNumber() Get the 1-based page number in the input document.
SelectionMarkState	getState() Gets the state property of the selection mark.
String	getText() The text content of the form element.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FormSelectionMark

public FormSelectionMark(String text,
                         FieldBoundingBox boundingBox,
                         int pageNumber)

Creates a FormSelectionMark.

Parameters:

text - The text content of the extracted element.

boundingBox - The BoundingBox specifying relative coordinates of the element.

pageNumber - the 1 based page number.

Method Detail

getBoundingBox

public FieldBoundingBox getBoundingBox()

BoundingBox property of the element.

Overrides:

getBoundingBox in class FormElement

Returns:

the bounding box of the element.

getText

public String getText()

The text content of the form element.

Overrides:

getText in class FormElement

Returns:

The text content of the form element.

getPageNumber

public int getPageNumber()

Get the 1-based page number in the input document.

Overrides:

getPageNumber in class FormElement

Returns:

the page number value.

getState

public SelectionMarkState getState()

Gets the state property of the selection mark.

Returns:

the state property of the selection mark.

getConfidence

public float getConfidence()

Gets the confidence property of the selection mark.

Returns:

the confidence property of the selection mark.