4D v14.3

ST Lire texte

Accueil

 
4D v14.3
ST Lire texte

ST Lire texte 


 

ST Lire texte ( {* ;} objet {; débutSél {; finSél}} ) -> Résultat 
Paramètre Type   Description
Opérateur in Si spécifié, objet est un nom d'objet (chaîne) Si omis, objet est une variable ou un champ
objet  Objet de formulaire in Nom d'objet (si * est spécifié) ou Variable ou champ Texte (si * est omis)
débutSél  Entier long in Début de la sélection
finSél  Entier long in Fin de la sélection
Résultat  Texte in Texte incluant les balises de style

La commande ST Lire texte retourne le texte multistyle présent dans le champ ou la variable de texte désigné(e) par le paramètre objet.

 

Si vous passez le paramètre optionnel *, vous indiquez que le paramètre objet est un nom d’objet (une chaîne). A l'exécution, si l'objet a le focus, la commande retourne les informations de l'objet en cours d'édition ; si l'objet n'a pas le focus, la commande retourne les informations de la source de données de l'objet (variable ou champ).
Si vous omettez le paramètre *, vous indiquez que le paramètre objet est un champ ou une variable. Dans ce cas, vous ne passez pas une chaîne mais une référence de champ ou de variable. A l'exécution, la commande retourne les informations de la variable ou du champ.

 

La commande retourne le texte avec les éventuelles balises de style qui lui sont associées, ce qui permet par exemple de copier et coller du texte en conservant les styles.

Les paramètres optionnels débutSél et finSél vous permettent de désigner une sélection de texte dans objet. Les valeurs débutSél et finSél expriment une sélection de texte brut, sans tenir compte des balises de style éventuellement présentes.

  • si vous omettez débutSél et finSél, ST Lire texte retourne la totalité du texte contenu dans objet,
  • si vous passez débutSél et finSél, ST Lire texte retourne la sélection de texte définie par ces bornes.

4D propose des constantes prédéfinies afin de désigner automatiquement des bornes de sélection dans les paramètres débutSél et finSél. Ces constantes sont placées dans le thème "Texte multistyle" : 

Constante Type Valeur Commentaire
ST Début sélection Entier long -1000 Désigne le premier caractère de la sélection courante de texte dans l’objet (*)
ST Début texte Entier long 1 Désigne le premier caractère du texte contenu dans l’objet
ST Fin sélection Entier long -1001 Désigne le dernier caractère de la sélection courante de texte dans l’objet (*)
ST Fin texte Entier long 0 Désigne le dernier caractère du texte contenu dans l’objet

(*) Vous devez passer un nom d’objet dans objet pour pouvoir utiliser cette constante. Si vous passez une référence de variable ou de champ, la commande s’appliquera à l’ensemble du texte de l’objet.

Si les valeurs de débutSél et finSél sont égales ou si débutSél est supérieur à finSél, une erreur est retournée.

A l’issue de l’exécution de cette commande, la variable OK prend la valeur 1 si aucune erreur n’a été rencontrée et 0 dans le cas contraire. C’est le cas notamment lorsque l’évaluation des balises de style échoue (balise incorrecte ou manquante). 

A noter qu’en cas d’erreur, la variable n’est pas modifiée. Lorsqu’une erreur se produit sur une variable lors de l’évaluation du texte, 4D transforme le texte en texte brut ; par conséquent, les caractères <, > et & seront convertis en entités HTML.

 
PROPRIÉTÉS 

Produit : 4D
Thème : Texte multistyle
Numéro : 1116
Nom intl. : ST Get text

Cette commande modifie la variable système OK

 
HISTORIQUE 

New
Créé : 4D v12
Modifié : 4D v12.1
Renommé : 4D v14

 
VOIR AUSSI  

ST FIXER TEXTE
ST Lire texte brut
TEXTE VERS TABLEAU

 
MOTS-CLÉS 

multi-style, multistyle, multi style

 
UTILISATION DE L'ARTICLE

4D - Langage ( 4D v14 R2)
4D - Langage ( 4D v14 R3)
4D - Langage ( 4D v14.3)
4D - Langage ( 4D v14 R4)

Hérité de : OBJET Lire texte style ( 4D v12.4)