azure-docs-sdk-java/docs-ref-autogen/com.azure.ai.formrecognizer...

104 строки
7.3 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.models.FormSelectionMark"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark"
name: "FormSelectionMark"
nameWithType: "FormSelectionMark"
summary: "Represents a selection mark recognized from the input document."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"com.azure.ai.formrecognizer.models.FormElement?alt=com.azure.ai.formrecognizer.models.FormElement&text=FormElement\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement.getBoundingBox()?alt=com.azure.ai.formrecognizer.models.FormElement.getBoundingBox&text=getBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement.getPageNumber()?alt=com.azure.ai.formrecognizer.models.FormElement.getPageNumber&text=getPageNumber\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"com.azure.ai.formrecognizer.models.FormElement.getText()?alt=com.azure.ai.formrecognizer.models.FormElement.getText&text=getText\" data-throw-if-not-resolved=\"False\" />"
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **FormSelectionMark**</br> extends <xref href=\"com.azure.ai.formrecognizer.models.FormElement?alt=com.azure.ai.formrecognizer.models.FormElement&text=FormElement\" data-throw-if-not-resolved=\"False\" />"
constructors:
- uid: "com.azure.ai.formrecognizer.models.FormSelectionMark.FormSelectionMark(java.lang.String,com.azure.ai.formrecognizer.models.FieldBoundingBox,int)"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark.FormSelectionMark(String text, FieldBoundingBox boundingBox, int pageNumber)"
name: "FormSelectionMark(String text, FieldBoundingBox boundingBox, int pageNumber)"
nameWithType: "FormSelectionMark.FormSelectionMark(String text, FieldBoundingBox boundingBox, int pageNumber)"
summary: "Creates a Form<wbr>Selection<wbr>Mark."
parameters:
- description: "The text content of the extracted element."
name: "text"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The BoundingBox specifying relative coordinates of the element."
name: "boundingBox"
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldBoundingBox?alt=com.azure.ai.formrecognizer.models.FieldBoundingBox&text=FieldBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- description: "the 1 based page number."
name: "pageNumber"
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FormSelectionMark(String text, FieldBoundingBox boundingBox, int pageNumber)"
desc: "Creates a FormSelectionMark."
methods:
- uid: "com.azure.ai.formrecognizer.models.FormSelectionMark.getBoundingBox()"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark.getBoundingBox()"
name: "getBoundingBox()"
nameWithType: "FormSelectionMark.getBoundingBox()"
summary: "Bounding<wbr>Box property of the element."
overridden: "com.azure.ai.formrecognizer.models.FormElement.getBoundingBox()"
syntax: "public FieldBoundingBox getBoundingBox()"
desc: "BoundingBox property of the element."
returns:
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldBoundingBox?alt=com.azure.ai.formrecognizer.models.FieldBoundingBox&text=FieldBoundingBox\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormSelectionMark.getConfidence()"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark.getConfidence()"
name: "getConfidence()"
nameWithType: "FormSelectionMark.getConfidence()"
summary: "Gets the confidence property of the selection mark."
syntax: "public float getConfidence()"
desc: "Gets the confidence property of the selection mark."
returns:
description: "the confidence property of the selection mark."
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormSelectionMark.getPageNumber()"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark.getPageNumber()"
name: "getPageNumber()"
nameWithType: "FormSelectionMark.getPageNumber()"
summary: "Get the 1-based page number in the input document."
overridden: "com.azure.ai.formrecognizer.models.FormElement.getPageNumber()"
syntax: "public int getPageNumber()"
desc: "Get the 1-based page number in the input document."
returns:
type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormSelectionMark.getState()"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark.getState()"
name: "getState()"
nameWithType: "FormSelectionMark.getState()"
summary: "Gets the state property of the selection mark."
syntax: "public SelectionMarkState getState()"
desc: "Gets the state property of the selection mark."
returns:
description: "the state property of the selection mark."
type: "<xref href=\"com.azure.ai.formrecognizer.models.SelectionMarkState?alt=com.azure.ai.formrecognizer.models.SelectionMarkState&text=SelectionMarkState\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormSelectionMark.getText()"
fullName: "com.azure.ai.formrecognizer.models.FormSelectionMark.getText()"
name: "getText()"
nameWithType: "FormSelectionMark.getText()"
summary: "The text content of the form element."
overridden: "com.azure.ai.formrecognizer.models.FormElement.getText()"
syntax: "public String getText()"
desc: "The text content of the form element."
returns:
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
type: "class"
desc: "Represents a selection mark recognized from the input document."
metadata: {}
package: "com.azure.ai.formrecognizer.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.10