Passer au contenu principal

Fonctionnement

L’interface IFlexiCaptureTools est implémentée via l’objet global FCTools, disponible dans les scripts. Toutes les méthodes de l’objet global FCTools peuvent être appelées en tant que méthodes statiques, par exemple :
FCTools.ShowMessage( "Test" );
Remarque. Certaines méthodes et propriétés de cet objet ne sont pas disponibles dans Web Verification Station pour la vérification locale des règles. Les méthodes et propriétés non prises en charge sont signalées par un astérisque (*).

Méthodes

ClassifyPage( page : IPage, [facultatif] callback : IProcessingCallback, [facultatif] detectClassesWithoutLayout : bool ) : IPageClassificationResult *

Classe la page et, si la classification réussit, renvoie le résultat de la classification. Ce résultat peut être le nom d’une classe issue d’un classificateur de type de lot ou null.

Cette méthode peut être utilisée dans les cas suivants :

  • Les pages doivent être classées et exportées au format PDF avec recherche de textePDF avec recherche de texte vers différents dossiers selon les résultats de classification ; aucune reconnaissance ni mise en correspondance des Document Definitions n’est requise ;
  • Selon les résultats de classification, certaines actions doivent être effectuées sur le document avant la reconnaissance (par exemple, la correction de l’orientation de la page).

Remarque : Si le paramètre detectClassesWithoutLayout n’est pas spécifié, sa valeur est définie sur false. Si la valeur est true, la classification repose uniquement sur les classes d’un classificateur, et les Document Definitions disponibles ne sont pas utilisées pour la classification.

Remarque : Vous pouvez soit utiliser l’interface IProcessingCallback, soit implémenter votre propre interface.

IsModuleAllowedByLicense( authorId : string, moduleName : string ) : bool *

Vérifie si l’utilisation d’un module est autorisée par la licence.

LoadImage( filePath : string, [optional] pageNumber : int ) : IEditablePictureObject *

Charge une image depuis un fichier. L’image chargée pourra ensuite être modifiée. Si le paramètre pageNumber n’est pas spécifié, sa valeur est définie sur “1.”

NewImageSavingOptions() : IExportImageSavingOptions *

Crée un objet de la classe IExportImageSavingOptions.

PictureFromHBitmap( [optional] resolution : int, bitmap : HBITMAP ) : IEditablePictureObject *

Génère une image à partir d’un objet HBITMAP avec la résolution spécifiée. Si le paramètre resolution n’est pas spécifié, la résolution de l’image est détectée automatiquement. L’image générée pourra être modifiée.

Remarque : Comme l’objet HBITMAP est pris en charge par le système, il n’est pas nécessaire d’appeler la méthode CloseHandle après avoir généré l’image.

Rect( left : int, top : int, right : int, bottom : int ) : string

Génère une chaîne représentant un rectangle à partir des coordonnées spécifiées.

ShowMessage( text : string, [facultatif] isError : bool )

Affiche un message à l’utilisateur. Si l’indicateur isError n’est pas spécifié, il prend la valeur false. Si l’indicateur isError a pour valeur true, un message d’erreur s’affiche ; sinon, un message de notification s’affiche. Si le script est exécuté dans le cadre d’un processus de traitement, le message sera consigné dans le Log de traitement.

Contrairement à un classificateur, la méthode ClassifyPage sert à analyser la classe de la page, mais le résultat de la classification n’est pas associé. Par exemple, si un classificateur ne contient pas la Document Definition Banking_eng, la méthode ClassifyPage appliquée à la page peut renvoyer une section de cette Document Definition.

Propriétés

NomTypeAccèsDescription
CurrentUserSession *IUserSessionInfoLecture seuleRenvoie des informations sur la session de l’utilisateur qui utilise actuellement la Processing Station. Lors de la vérification, elle renvoie des informations sur la session de l’utilisateur qui effectue actuellement la vérification (y compris les utilisateurs distants).
ScriptContext *IScriptDefinitionContextLecture seuleDonne accès à l’objet dans lequel le script a été créé. Cette propriété vous permet d’accéder au projet quels que soient les paramètres reçus par le script.