T > TextFormat (objet)

TextFormat (objet)

L'objet TextFormat représente les informations de format des caractères.

Vous devez utiliser le constructeur new TextFormat pour créer une occurrence de l'objet TextFormat avant d'en appeler les méthodes.

Vous pouvez définir les paramètres de TextFormat sur null pour indiquer qu'ils sont indéfinis. Lorsque vous appliquez un objet TextFormat à un champ de texte avec la méthode setTextFormat, seules ses propriétés définies sont appliquées, comme dans l'exemple suivant :

monFormatDeTexte = new TextFormat();
monFormatDeTexte.bold = true;
monChampDeTexte.setTextFormat(monFormatDeTexte);

Ce code crée d'abord un objet TextFormat vide, avec toutes ses propriétés indéfinies, puis applique la propriété bold à une valeur définie.

Le code monChampDeTexte.setTextFormat(monFormatDeTexte) change seulement la propriété bold du format de texte par défaut du champ de texte, étant donné que la propriété bold est la seule qui soit définie dans monFormatDeTexte. Tous les autres aspects du format de texte par défaut du champ de texte restent inchangés.

Lorsque getTextFormat est invoqué, un objet TextFormat est retourné avec toutes ses propriétés définies, aucune propriété restant null.

 
Méthodes de l'objet TextFormat

Méthode	Description
TextFormat.getTextExtent	Renvoie un objet avec deux propriétés, width et height, qui indiquent la taille d'un texte dans un champ de texte.

 
Propriétés de l'objet TextFormat

Propriété	Description
TextFormat.align	Indique l'alignement d'un paragraphe.
TextFormat.blockIndent	Indique l'indentation d'un bloc, en points.
TextFormat.bold	Indique si le texte apparaît en gras.
TextFormat.bullet	Indique si le texte fait partie d'une liste à puces.
TextFormat.color	Indique la couleur du texte.
TextFormat.font	Indique le nom de la police du texte avec ce format.
TextFormat.indent	Indique l'indentation, de la marge gauche au premier caractère du paragraphe.
TextFormat.italic	Indique si le texte apparaît en italique.
TextFormat.leading	Indique l'espace séparant les lignes.
TextFormat.leftMargin	Indique la marge gauche du paragraphe, en points.
TextFormat.rightMargin	Indique la marge droite du paragraphe, en points.
TextFormat.tabStops	Spécifie des taquets de tabulation personnalisés.
TextFormat.target	Indique la fenêtre de navigateur dans laquelle un hyperlien est affiché.
TextFormat.size	Indique la taille du texte, en points.
TextFormat.underline	Indique si le texte est souligné.
TextFormat.url	Indique l'URL à laquelle le texte est lié.

 
Constructeur pour l'objet TextFormat

Disponibilité

Flash Player 6.

Usage

new TextFormat([police, [taille, [couleur, [gras, [italique, [souligné, [url, [cible, [alignement, [margeGauche, [margeDroite, [indentation, [espacement]]]]]]]]]]]]])

Paramètres

police Le nom d'une police pour le texte, sous forme de chaîne.

taille Un entier indiquant la taille en points.

couleur La couleur du texte utilisant ce format de texte. Un nombre contenant trois composants RVB 8 bits ; par exemple, 0xFF0000 est le rouge, 0x00FF00 est le vert.

gras Une valeur booléenne indiquant si le texte apparaît en gras.

italique Une valeur booléenne indiquant si le texte apparaît en italique.

souligné Une valeur booléenne indiquant si le texte apparaît souligné.

url L'URL à laquelle le texte de ce format est lié. Si url est une chaîne vide, le texte n'a pas d'hyperlien.

cible La fenêtre cible dans laquelle est affiché l'hyperlien. Si la fenêtre ciblée est une chaîne vide, le texte est affiché dans la fenêtre cible par défaut, _self. Si la propriété TextFormat.url est définie avec une chaîne vide ou avec la valeur null, cette propriété peut être récupérée ou définie mais n'a aucun effet.

alignement L'alignement du paragraphe, représenté sous forme de chaîne. Si "left", le paragraphe est aligné à gauche. Si "center", le paragraphe est centré. Si "right", le paragraphe est aligné à droite.

margeGauche Indique la marge gauche du paragraphe, en points.

margeDroite Indique la marge droite du paragraphe, en points.

indentation Un entier indiquant l'indentation de la marge gauche au premier caractère du paragraphe.

espacement Un nombre indiquant l'espace séparant les lignes.

Description

Constructeur ; crée une occurrence de l'objet TextFormat avec les propriétés spécifiées. Vous pouvez ensuite changer les propriétés de l'objet TextFormat pour changer le formatage des champs de texte.

N'importe quel paramètre peut être défini sur la valeur null pour indiquer qu'il n'est pas défini. Tous les paramètres sont facultatifs, tous les paramètres omis étant considérés comme null.