Oxygène++

https://www.memsoft.fr/aide/sdk
Admin
Oxygène++ is a development platform that provides tools for building applications with features...
Tokens:417,103
Snippets:2,309
Trust Score:8.4
Update:1 day ago
Show doc for...
Tokens:
Raw
### Example: Multi-criteria filter with DebutRequete/FinRequete

Source: https://www.memsoft.fr/aide/sdk/008.instructions/037.debutrequete_finrequete.htm

Shows a complete example of using DebutRequete and FinRequete to filter the CLIENT table with multiple criteria (CP, TVM1, CR), sort by NOM, position at the beginning, and iterate through results with LireSuivant. The example is in the Memsoft SDK language.

```Memsoft SDK
Domaine : ESSAI "Installation d'un filtre multi-critères" 
Objet TRAITEMENT : FMCRIT 
         Methode JE_TESTE 
                 DebutRequete CLIENT 
                     Filtre (CP, DebutePar, "78") 
                                        Et (TVM1, SuperieurA, 10000) 
                                        Et (CR, EgalA, "JCL") 
                     Classement NOM 
                     PositionDebut 
                   FinRequete 
                   TantQue LireSuivant(CLIENT) 
                     BoiteMessage CLIENT.NOM + " "+ CLIENT.PRNOM 
                   FinTantQue 
          FinMethode 
FinObjet
```

--------------------------------

### Formats instruction example in EDITION object

Source: https://www.memsoft.fr/aide/sdk/008.instructions/048.formats.htm

Example of using the Formats instruction within an EDITION object's DEBUT method to set column formats. The example includes the object declaration, TABULATION method, and DEBUT method with Formats, Cadrages, and Designations instructions.

```memsoft
Domaine : ESSAI 
Objet EDITION : EDTFORM "Edition avec Formats" 
         Declaration 
                   TABLE : REPR 
                   VARIABLES: 
                     Chaine V1="1° champ" 
                     Chaine V2="° champ" 
          FinDeclaration 

         Methode TABULATION 
                   Editer NOM, "PRNOM" ,CA, DATCA 
          FinMethode 

     Methode DEBUT 
          Designations , ,(V1 ), 2+V2 
          **Formats** Defaut,Defaut,"+##0,000.00" ,"\[0-3\]\[0-9\]'-'\[0-1\]\[0-9\]'-'\[0-9\]\[0-9\]\[0-9\]\[0-9\]" 
          Cadrages Defaut,Defaut,"D","C" 
     FinMethode 
FinObjet
```

--------------------------------

### CreerUnique full example with domain and objects

Source: https://www.memsoft.fr/aide/sdk/008.instructions/035.creerunique.htm

Complete example showing a domain ESSAI with two SAISIE objects. The first object launches the second using CreerUnique in its COMMANDE 1 method.

```plaintext
Domaine : ESSAI 
Objet SAISIE : "Lancement d'objets"          Declaration                   ECRAN : ECR1          FinDeclaration 
          Methode DEBUT                   Commande 1,"Lancement gestion représentants"          FinMethode 
          Methode COMMANDE 1                   CreerUnique GR          FinMethode 
FinObjet 
Objet SAISIE : GR          Declaration                   ECRAN : REPR          FinDeclaration 
FinObjet
```

--------------------------------

### CreerObjet Example with Domain ESSAI and Objects SAISIE and GR

Source: https://www.memsoft.fr/aide/sdk/008.instructions/033.creerobjet.htm

Complete example showing two objects: SAISIE with an ECRAN and a DEBUT method that calls CreerObjet GR, and GR with its own ECRAN. Demonstrates asynchronous creation.

```Memsoft
Domaine : ESSAI 
Objet SAISIE : "Création d'objets"          Declaration                   ECRAN : ECR1          FinDeclaration 
          Methode DEBUT                   Commande 1,"Lancement gestion représentants"          FinMethode 
          Methode COMMANDE 1                   CreerObjet GR          FinMethode 
FinObjet 
Objet SAISIE : GR          Declaration                   ECRAN : REPR          FinDeclaration 
FinObjet
```

--------------------------------

### LirePrecedent example: reading previous client record

Source: https://www.memsoft.fr/aide/sdk/007.fonctions/041.lireprecedent.htm

Example showing how to use LirePrecedent to read the previous record matching a query. It sets up a secondary table context, issues a query, positions at the end, and calls LirePrecedent to get the previous record.

```Memsoft
Domaine : ESSAI "Lecture du client précédent" 
Objet TRAITEMENT : LIREPREC 
         Declaration 
                   TABLE : CLIENT 
                   TABLE_SECONDAIRE : CLIENT->CLIENT2 
         FinDeclaration 

         Methode JE_TESTE 
                   Requete CLIENT2.VILLE, EgalA "VERSAILLES" 
                   PositionnerFin CLIENT2 
                   Si LirePrecedent(CLIENT2) Alors 
                     BoiteMessage "L'avant-dernier client recensé localisé à Versailles est"+ 
                                                                 CLIENT2.NO 
                   FinSi 
         FinMethode 
FinObjet
```

--------------------------------

### Methode DEBUT_CREATION: AppliquerMethode MON_CALCUL[InstanceCreee].ATTRIBUE_NUMERO (CODEUNIQUE)

Source: https://www.memsoft.fr/aide/sdk/001.programmation_composant/derivation_des_composants/notions_d_objet_et_de_modele/notion_d_objet_et_de_modele.htm?agt=index

Shows the DEBUT_CREATION method that synchronously calls the ATTRIBUE_NUMERO method on the CALCUL instance, passing CODEUNIQUE by reference to receive the result.

```Oxygène
Methode DEBUT_CREATION          AppliquerMethode MON_CALCUL[InstanceCreee].ATTRIBUE_NUMERO (CODEUNIQUE) 
FinMethode
```

--------------------------------

### LireSuivant example: scanning clients in VERSAILLES

Source: https://www.memsoft.fr/aide/sdk/008.instructions/067.liresuivant.htm

Example of using LireSuivant to iterate over records matching a criterion. It sets up a table and secondary table, issues a Requete to filter by city, positions at the start, then loops while EtatTable returns 0, resetting TVM and calling LireSuivant again.

```memsoft
Domaine : ESSAI "Remise à zéro de TVM pour les clients de VERSAILLES" 
Objet TRAITEMENT : LIRESUIV 
         Declaration 
                   TABLE : CLIENT 
                   TABLE_SECONDAIRE : CLIENT->CLIENT2 
         FinDeclaration 

         Methode JE_TESTE 
                   Requete CLIENT2.VILLE, EgalA "VERSAILLES" 
                   PositionnerDebut CLIENT2 
                   **LireSuivant** CLIENT2 
                   TantQue EtatTable(CLIENT2) = 0 
                     TVM=0 
                     **LireSuivant** CLIENT2 
                   FinTantQue 
         FinMethode 
FinObjet
```

--------------------------------

### SuppFiltre example: remove filter and recalculate total

Source: https://www.memsoft.fr/aide/sdk/008.instructions/097.suppfiltre.htm

Example of using SuppFiltre to remove a filter on the CLIENT table after a query, then iterate over all records to calculate a new total. The example is written in the Memsoft SDK language and shows the full TRAITEMENT object structure.

```memsoft
Domaine : ESSAI "Mise à 0 de TVM sur VERSAILLE et calcul nouveau total" 
Objet TRAITEMENT : SFILT 
         Declaration 
                   VARIABLES : 
                     Double total("nouveau total TVM") 
          FinDeclaration 

          Methode JE_TESTE 
                   Requete CLIENT.VILLE, EgalA "VERSAILLES" 
                   TantQue LireSuivant (CLIENT) 
                     TVM=0 
                   FinTantQue 
                   **SuppFiltre** CLIENT 
                   PositionnerDebut CLIENT 
                   TantQue LireSuivant (CLIENT) 
                     total=total+TVM 
                   FinTantQue 
                   BoiteMessage "Nouveau total TVM" + total 
          FinMethode 
FinObjet
```

--------------------------------

### Example using BPage in an EDITION object

Source: https://www.memsoft.fr/aide/sdk/006.variables/001.bpage.htm

Shows how to use the BPage system variable in an EDITION object. The example defines an object with a PERIPH and TABLE, and in the DEBUT_PAGE method it displays a message with the current BPage value, prints a frame, and sets the line position.

```Memsoft SDK
Domaine : ESSAI "Imprimer divers" 
Objet EDITION : TESTVS          Declaration                   PERIPH : E                   TABLE : CLIENT          FinDeclaration 
          Methode TABULATION                   Editer NOM, RUE, VILLE, TVM          FinMethode 
          Methode DEBUT_PAGE          Ou DEBUT_DOCUMENT                   BoiteMessage "La marge basse est de : " +BPage                   Page "H"                   ImprimerCadre Ligne ,1 ,5 ,Largeur ,"ROG"                   ImprimerCadre Ligne +1 ,10 ,3 ,Largeur -20 ,"RN" ,2                   Ligne =HPage +2                   Imprimer "Test des Variables système" ,"C",0 ,"" ,"GG"                   Ligne =HPage +6                   Lignes 2                   Bandeau 3          FinMethode 
FinObjet
```

--------------------------------

### Requete Usage Example

Source: https://www.memsoft.fr/aide/sdk/008.instructions/083.requete.htm

Example of using the Requete instruction in a treatment method to filter clients with code 'TC' and display their names.

```memsoft
Domaine : ESSAI "Installation d'un filtre"
Objet TRAITEMENT : REQUEG
          Methode JE_TESTE
                    Requete CLIENT.CR, EgalA, "TC"
                    TantQue LireSuivant(CLIENT)
                      BoiteMessage CLIENT.NOM+" "+CLIENT.PRNOM
                    FinTantQue
          FinMethode
FinObjet
```

--------------------------------

### Example: Optimizing an edition with BasculerContexteMemoire

Source: https://www.memsoft.fr/aide/sdk/008.instructions/basculercontextememoire.htm

Shows how to create a memory context, populate it with relevant data, and switch the main table to that context to optimize processing. The context must be created beforehand with CreerContexteMemoire and populated with PeupleContexteMemoire or CopierContexte.

```Memsoft
Objet IMPETAT : EDITION1 
   Declaration 
        TABLE : "GCPLFAC" 
        PARAMETRES : Chaine vNumeroDoc 
        VARIABLES : Entier vNb 
    FinDeclaration 

    Methode DEBUT 
        // crée un contexte en mémoire de la table principale 
        CreerContexteMemoire TABLE 
        // copie uniquement les données nécessaires sur le contexte 
        Requete TABLE.NUMERO, DebutePar, vNumeroDoc + "|" 
        PeupleContexteMemoire TABLE, "COMPTER\_LIGNES" 
        // faire pointer la table principale sur le contexte en mémoire 
        BasculerContexteMemoire TABLE 
    FinMethode 

    Methode COMPTER\_LIGNES 
        vNb = vNb + 1 
    FinMethode
```

--------------------------------

### DEBUT method creating MON_CALCUL instance

Source: https://www.memsoft.fr/aide/sdk/001.programmation_composant/derivation_des_composants/notions_d_objet_et_de_modele/notion_d_objet_et_de_modele.htm

Shows the DEBUT method of the SAISIE object that creates an instance of MON_CALCUL. This instance becomes the privileged interlocutor for subsequent calls.

```Oxygène
Methode DEBUT         CreerObjet MON_CALCUL 
FinMethode
```

--------------------------------

### TRAITEMENT object example with Afficher

Source: https://www.memsoft.fr/aide/sdk/008.instructions/003.afficher.htm

Complete example of a TRAITEMENT object that uses Afficher to refresh a gauge and a numeric field when either is modified.

```plaintext
Domaine : ESSAI "Afficher un Emplacement" 
Objet TRAITEMENT : AFFZONE 
         Declaration 
                  ECRAN : CL 
                  MODES : Mm 
                  VARIABLES : 
                    Entier NBRE("zone de saisie numérique") 
                    Entier JAUGE("variable de jauge") 
         FinDeclaration 

         Methode DEBUT 
                  GererCaractere=1 
                  JAUGE=75 
                  NBRE=75 
                  Saisir "NBRE" 
         FinMethode 

         //La jauge présente dans l'écran doit être réactualisée lorsque le

         // nombre est modifié 
         Methode NBRE_CARACTERE 
                  JAUGE=NBRE 
                  Afficher "JAUGE" 
         FinMethode 

         //La valeur _NBRE_, présente dans l'écran doit être affichée lorsque la

         // jauge est modifiée 
         Methode CODE_JAUGE 
                  NBRE=JAUGE 
                  Afficher "NBRE" 
         FinMethode 
FinObjet
```

--------------------------------

### ChainerObjet example with two objects

Source: https://www.memsoft.fr/aide/sdk/008.instructions/024.chainerobjet.htm

Complete example showing two objects, GESTION_CLIENT and GESTION_REPRESENTANT, where the first chains to the second. The message after ChainerObjet is not executed.

```memsoft
Domaine : ESSAI  "Chaînage d' objets" 
Objet SAISIE : GESTION_CLIENT          Declaration                   ECRAN : CLIECR          FinDeclaration 
          Methode DEBUT                   Commande 1,"Chaînage Gestion des représentants"          FinMethode 
          Methode COMMANDE 1                   ChainerObjet GESTION_REPRESENTANT                   BoiteMessage "Je passe par içi."          FinMethode 
FinObjet 
Objet SAISIE : GESTION_REPRESENTANT          Declaration                   ECRAN : REPR          FinDeclaration 
          Methode DEBUT                   BoiteMessage "Je passe par là."          FinMethode 
FinObjet
```

--------------------------------

### DEBUT_LIGNE

Source: https://www.memsoft.fr/aide/sdk/modeles_d_objet/modeles_de_base/modeles_de_traitement/004.import/modele_xmlimport.htm

Méthode appelée avant la lecture d'une ligne.

```APIDOC
## DEBUT_LIGNE

### Description
Méthode appelée avant la lecture d'une ligne.

### Paramètres
- **NomTable** (Chaine) - Requis - Nom de la table.

### Action par défaut
Rien.
```

--------------------------------

### ActiverObjet syntax and examples

Source: https://www.memsoft.fr/aide/sdk/008.instructions/002.activerobjet.htm

Shows the syntax of ActiverObjet and two usage examples: activating an object in the same domain and activating a specific instance in another domain.

```text
ActiverObjet [domaine.] objet [ [<instance>] ]
```

```text
Chaine Obj1("Objet") = "O1"   
Chaine Dom1("Domaine") = "D1"

ActiverObjet O1    
ActiverObjet Obj1
```

```text
ActiverObjet D1.O1[2]                                
ActiverObjet Dom1.Obj1[2]
```

--------------------------------

### Methode DEBUT avec CreerUnique et CONNECTE

Source: https://www.memsoft.fr/aide/sdk/001.programmation_composant/derivation_des_composants/notions_d_objet_et_de_modele/notion_d_objet_et_de_modele.htm

Extrait de la méthode DEBUT de l'objet SAISIE montrant la création unique de MON_CALCUL et l'appel à CONNECTE.

```oxygene
Methode DEBUT          CreerUnique MON_CALCUL          AppliquerMethode MON_CALCUL[InstanceCreee].CONNECTE 
FinMethode
```

--------------------------------

### Lire function example with error handling

Source: https://www.memsoft.fr/aide/sdk/007.fonctions/039.lire.htm

Example of using Lire to read a client record by number, with error handling via EtatTable and BoiteMessage.

```Memsoft
Domaine : ESSAI "Lecture et mise à jour d'un enregistrement particulier" 
Objet TRAITEMENT : LIREMAJ 
         Declaration 
                   TABLE:CLIENT 
                   TABLE_SECONDAIRE:CLIENT->CLIENT2 
         FinDeclaration 

         Methode JE_TESTE 
                  Si Lire (CLIENT2.NO, EgalA, "12") Alors 
                    TVM=TVM+100 
                  SinonSi EtatTable(CLIENT2)=1 Alors 
                    BoiteMessage "Le client 12 n'existe pas!" 
                  Sinon 
                    BoiteMessage "Impossible de lire le client 12!" 
                  FinSi 
         FinMethode 
FinObjet
```

--------------------------------

### Exemple de programmation SETAPE avec méthode DEBUT_VISUALISATION

Source: https://www.memsoft.fr/aide/sdk/modeles_d_objet/modeles_de_base/modeles_de_saisie/005.setape/exemple_setape.htm

Exemple complet d'un objet SETAPE nommé MASAISIE avec écran DCLI, définissant les étapes et utilisant la méthode DEBUT_VISUALISATION pour autoriser ou interdire la zone ZONE1 selon l'étape courante.

```L4G
Objet SETAPE : MASAISIE "Ma saisie avec étapes"

Declaration
   ECRAN : "DCLI"
   VARIABLES:
            Chaine Heritee Etapes="PAGE1,PAGE2,GROUPE4"
            Chaine Heritee EtapeCourante
FinDeclaration

Methode DEBUT_VISUALISATION
   Si EtapeCourante="PAGE1" Alors
            Autoriser "ZONE1"
   Sinon
            Interdire "ZONE1"
   FinSi
FinMethode

FinObjet
```

--------------------------------

### Full example of EDITER in an EDITION object

Source: https://www.memsoft.fr/aide/sdk/008.instructions/042.editer.htm

Complete example showing the Editer instruction within a TABULATION method of an EDITION object, including declarations and other instructions.

```plaintext
Domaine : ESSAI 
Objet EDITION : EDTCRIT "Exemple d'utilisation de EDITER" 
         Declaration 
                  TABLE : CLIENT 
                  VARIABLES: 
                    Chaine VAR1="VILLE" 
                    Chaine VAR2="RUE" 
                    Chaine VAR3="CP" 
         FinDeclaration 

         Methode TABULATION 
                  Editer "CODE","NOM","TVM1","TVM1+10",VAR1,VAR2,VAR3 
                  Designations "CODE","NOM","TVM1","TVM1+10","VILLE","ADRESSE", "CP" 
                  Colonnes 1, 9, 26, 36, 46, 64, 81, 88 
         FinMethode 

         Methode DEBUT_DOCUMENT 
                  AppliquerDefaut DEBUT_DOCUMENT("Editions d'expressions") 
         FinMethode 
FinObjet
```
Tokens:
Raw