Accusoft.FormFixSdk Namespace > IdentificationResult Class : State Property |
'Declaration Public ReadOnly Property State As IdentificationState
'Usage Dim instance As IdentificationResult Dim value As IdentificationState value = instance.State
public IdentificationState State {get;}
public: __property IdentificationState get_State();
public: property IdentificationState State { IdentificationState get(); }
This property indicates the final state of the identification process. Similar information is available in the FormModelIndex and FormModel properties.
This property will have one of three possible values: MatchFound, NoMatchFound, MultipleMatchesFound. If it is set to NoMatchFound or MultipleMatchesFound, then FormModelIndex will be -1 and FormModel will be null. Otherwise, when it is set to MatchFound, both FormModelIndex and FormModel will refer to the same, best match.
When this has a value of Multiple matches, the identification process found two or more matches, but was not able to determine if one of the matches was significantly better than the others. Therefore the identification process could not produce a best match, or one that is good enough.
Although the MatchFound and MultipleMatchesFound states both represent a successful identification, you likely want to treat them differently. You can use the BestMatches property to help deal with multiple matches.