Introduction

TXMLPropStorage est un composant pour enregistrer/restaurer des propriétés choisies (soit TForm soit n'importe quel contrôle au dessus de lui). Il travaille avec la propriété TForm.SessionProperties. .

Utilisation :

1. Déposer un composant TXMLPropStorage sur la fiche et choisir le nom de fichier, par exemple: session.xml
2. Ouvrir une fenêtre d'édition pour la propriété SessionProperties de TForm.
3. Ajouter la les propriétés de la fiche et/ou des contrôles à stocker dans session.xml.
4. Compiler l'application.

Votre application maintenant lira les valeurs de propriétés choisies de session.xml et les conservera pendant la durée d'exécution (comme Width, Height, Left, Top pour TForm).

TINIPropStorage travaille de la même manière que TXMLPropStorage, excepté qu'il stocke l'information de session dans un fichier Ini.

Propriété StoredValues

TINIPropStorage et TXMLPropStorage ont une propriété StoredValues qui stocke des valeurs (ce qui est pratique pour ne pas utiliser d'autres fichier de configuration)...

• Pourquoi est-ce vraiment utile ?
  1. Quelques propriétés (comme CheckGroup.Item[n].Checked) ne peuvent pas être sauvées dans SessionProperties de TForm, donc vous devez le faire manuellement. C'est également pratique pour sauver d'autres informations de configuration.

Ecrivons une petite démo :

• Lancez Lazarus et commencez une nouvelle application;
• Déposez un composant TXMLPropStorage et un TCheckGroup;
• Ajoutez un item au TCheckGroup (Item Test);
• Cliquez sur XMLPropStorage1 et accédez à l'editeur de propriété StoredValues;
• Ajoutez une nouvelle valeur avec un name = item0_checked et value = -1 (True = -1);
• Dans l'évènement OnRestoreProperties ajoutez ce code :

CheckGroup1.Checked[0] := StrToBool(XMLPropStorage1.StoredValue['item0_checked']);

• Dans l'évènement OnSavingProperties ajoutez ce code :

XMLPropStorage1.StoredValue['item0_checked'] := BoolToStr(CheckGroup1.Checked[0]);

• Lancez le programme de démo, changez la propriété checked de TCheckGroup.Items[n] et fermez votre fiche. Vos changements ont été sauvés ? :)

Vous pouvez changer la propriété Key de StoredValues.Items[n] si vous sauvez quelque information confidentielle (elle utilise les fonctions XOREncode et XORDecode de la RTL lors de l'enregistrement et de la restauration).

Une note sur des noms de fichier

TXMLPropStorage a un gestionnaire par défaut si vous ne choisissez pas un nom de fichier. Sous Windows les paramètres seront sauvés dans le répertoire de l'application sous PROGRAMNAME.xml

Sous des clônes Unix (Linux/FreeBSD/macOS) il sera sauvé dans le répertoire local de l'utilisateur courant sous .PROGRAMNAME

C'est donc une très bonne idée de laisser les noms par défaut pour les programmes unix qui doivent être lancer par des utilisateurs normaux.

Selon le rapport d'anomalie 13949, note 28856 : "The StoredValues[] array can only be used during the OnRestoreProperties or OnSaveProperties events. Outside these events, the values will not be stored." et "If you want to save/load values that are not published properties of a component or control, you should save them in a OnSaveProperties event, and load them using the OnRestoreProperties event."

Soit en Français : "Le tableau StoredValues[] peut seulement être utilisé pendant les événements OnRestoreProperties ou OnSaveProperties. En dehors de ceux-ci, les valeurs ne seront pas enregistrées." et "Si vous voulez enregistrer/charger des valeurs qui ne sont pas des propriétés d'un composant ou d'un contrôle, vous devriez les enregistrer dans un événement OnSaveProperties et les charger en utilisant un événement OnRestoreProperties".

Voir aussi

• Doc. TXMLPropStorage
• Doc. SessionProperties
• Hardware Access

From the Free Pascal wiki, page "TXMLPropStorage/fr", as it stood on 2020-03-02 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's Licensing page. If you have concerns about this material, message the admin.