Objet Layout (interface ILayout)

Cet objet expose des méthodes et des propriétés permettant de travailler avec le Layout de l’image. L’objet Layout sert de racine aux blocs. Ses attributs sont la largeur et la hauteur. Ces paramètres prennent les mêmes valeurs que les paramètres correspondants de la page noir et blanc de l’image pour laquelle l’objet Layout est défini. Cette opération est effectuée automatiquement lorsque l’objet Layout est analysé ou reconnu.

L’objet Layout est un objet persistant. Cela signifie que l’état actuel de l’objet peut être écrit dans un stockage persistant. Par la suite, l’objet peut être recréé en relisant son état à partir du stockage persistant. Les méthodes suivantes assurent la persistance de l’objet :

• Linux et macOS : SaveToFile et LoadFromFile
• Windows : SaveToFile, LoadFromFile, SaveToMemory et LoadFromMemory

​

Propriétés

	, read-only	Retourne l’objet Engine.
	, read-only	Donne accès à la collection de blocs Separator et de groupes de Separator du layout. Cette propriété fait référence à un objet valide, qu’il existe ou non des blocs Separator dans le Layout. En l’absence de Separator dans le Layout, la propriété BlackSeparators est vide.
	, read-only	Donne accès à la collection de blocs du layout. Cette collection ne contient pas les blocs Separator ni les groupes de Separator. Pour accéder à ces blocs, utilisez la propriété BlackSeparators. Cette propriété fait référence à un objet valide, qu’il existe ou non des blocs dans le Layout. En l’absence de blocs dans le Layout, la propriété Blocks est vide. Voir aussi Utilisation des propriétés d’objet en lecture seule . Cette collection ne contient jamais de blocs d’autoanalyse, car ce type de blocs est utilisé uniquement dans les composants visuels.
	, read-only	Retourne la collection triée logiquement des blocs du layout. Cette collection contient les mêmes blocs que ceux retournés par la propriété Blocks. Ils sont triés selon la position du coin supérieur gauche de chaque bloc, d’abord de gauche à droite, puis de haut en bas. Les blocs proches les uns des autres sont considérés comme appartenant à un même groupe logique.
	, read-only	Les composants visuels ne sont actuellement pris en charge que sous Windows. Donne accès à la collection de blocs visibles dans les composants visuels. Cette collection peut contenir des blocs des types suivants : texte, tableau, image raster, Barcode, autoanalyse. L’ordre des blocs dans cette collection est identique à celui affiché dans les composants visuels.
	, read-only	Retourne la hauteur du layout en pixels. Elle est égale à la hauteur de du .
		Stocke le nom du layout.
	, read-only	Écrit le texte de tous les blocs de texte et de tableau sur une seule ligne. L’objet détermine l’ordre dans lequel le texte des cellules de tableau est écrit. Cet ordre peut donc ne pas correspondre à l’ordre des cellules de tableau tel qu’elles apparaissent dans l’image. Le texte des blocs Barcode n’est pas écrit.
	, read-only	Stocke la Region englobante des blocs du layout. Si aucun bloc n’est présent, cette propriété retourne la Region vide.
		Permet d’associer des informations définies par l’utilisateur à un objet de type Layout .
	, read-only	Retourne la largeur du layout en pixels. Elle est égale à la largeur de du correspondant.

​

Méthodes

Nom	Description
Clean	Supprime tous les types de blocs et de Separator du Layout.
CopyFrom	Initialise les propriétés de l’objet courant avec les valeurs des propriétés similaires d’un autre objet.
LoadFromFile	Restaure le contenu de l’objet à partir d’un fichier sur le disque.
LoadFromMemory	Restaure le contenu de l’objet à partir de la mémoire globale. Windows uniquement.
SaveToArray	Enregistre le contenu de l’objet sous la forme d’un tableau d’octets.
SaveToFile	Enregistre le contenu de l’objet dans un fichier sur le disque.
SaveToMemory	Enregistre le contenu de l’objet dans la mémoire globale. Windows uniquement.
SaveToStream	Enregistre le contenu de l’objet dans le flux.

​

Objets associés

​

Windows

​

Linux et macOS

Diagramme d’objet

​

Paramètre de sortie

Cet objet est le paramètre de sortie de la méthode CreateLayoutFromStream de l’objet Engine.

​

Exemples

C# code

FREngine.IFRDocument frdoc;
// Itère sur les blocs du Layout
for (int iPage = 0; iPage < frDoc.Pages.Count; iPage++)
{
 FREngine.IFRPage page = frDoc.Pages[iPage];
 FREngine.ILayout layout = page.Layout;
 int blocksCount = layout.Blocks.Count;
 for (int iBlock = 0; iBlock < blocksCount; iBlock++)
 {
  FREngine.IBlock block = layout.Blocks[iBlock];
  ...
 }
}

L’objet est utilisé dans les exemples de code suivants :

• Linux : CustomLanguage
• Windows : CustomLanguage, RecognizedTextProcessing ; et dans les Demo Tools : Engine Predefined Processing Profiles

​

Voir aussi

Utilisation de Layout et des Blocks

LayoutBlocks

Utilisation des propriétés