Class TextStyle
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Style de texte
Style de rendu du texte dans une cellule.
Les styles de texte peuvent avoir un RichTextValue correspondant. Si RichTextValue s'étend sur plusieurs exécutions de texte ayant des valeurs différentes pour une méthode de lecture de style de texte donnée, la méthode renvoie null. Pour éviter cela, interrogez les styles de texte à l'aide des valeurs de texte enrichi renvoyées par la méthode RichTextValue.getRuns().
Méthodes obsolètes
| Méthode | Type renvoyé | Brève description |
getForegroundColor() | String | Récupère la couleur de la police du texte. |
Documentation détaillée
copy()
Crée un outil de création de style de texte initialisé avec les valeurs de ce style de texte.
Renvois
TextStyleBuilder : compilateur à partir de ce style de texte.
getFontFamily()
Récupère la famille de polices du texte. Renvoie null si la famille de polices n'est pas définie ou si le RichTextValue correspondant comporte plusieurs exécutions avec différentes familles de polices.
Renvois
String : famille de polices du texte (par exemple, "Arial") ou null.
getFontSize()
Récupère la taille de police du texte en points. Renvoie null si la taille de police n'est pas définie ou si l'RichTextValue correspondante comporte plusieurs exécutions avec différentes tailles de police.
Renvois
Integer : taille de police du texte ou null.
getForegroundColorObject()
Récupère la couleur de la police du texte. Renvoie null si la couleur de la police n'est pas définie ou si le RichTextValue correspondant comporte plusieurs exécutions avec des couleurs de police différentes.
Renvois
Color : couleur de la police du texte ou null.
isBold()
Indique si le texte est en gras ou non. Renvoie null si l'italique n'est pas définie ou si le RichTextValue correspondant comporte plusieurs exécutions avec des paramètres d'italique différents.
Renvois
Boolean : indique si la cellule est en gras ou non (null).
isItalic()
Indique si la cellule est en italique ou non. Renvoie null si l'italique n'est pas défini ou si le RichTextValue correspondant comporte plusieurs exécutions avec des paramètres d'italique différents.
Renvois
Boolean : indique si la cellule est en italique ou non (null).
isStrikethrough()
Indique si la cellule est barrée ou non. Renvoie null si le trait est désactivé ou si le RichTextValue correspondant comporte plusieurs exécutions avec des paramètres de trait différents.
Renvois
Boolean : indique si la cellule est barrée ou non (null).
isUnderline()
Indique si la cellule est soulignée ou non. Renvoie null si l'attribut souligné n'est pas défini ou si le RichTextValue correspondant comporte plusieurs exécutions avec des paramètres de soulignement différents.
Renvois
Boolean : indique si la cellule est soulignée ou non, ou null.
Méthodes obsolètes
getForegroundColor()
Obsolète. Remplacé par getForegroundColorObject()
Récupère la couleur de la police du texte. Renvoie null si la couleur de la police n'est pas définie ou si le RichTextValue correspondant comporte plusieurs exécutions avec des couleurs de police différentes.
Renvois
String : couleur de la police du texte sous la forme d'une valeur CSS hexadécimale (par exemple, "#ff0000") ou null.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/26 (UTC).
[null,null,["Dernière mise à jour le 2025/07/26 (UTC)."],[[["\u003cp\u003e\u003ccode\u003eTextStyle\u003c/code\u003e defines the rendered style of text within a cell in Google Sheets, encompassing attributes like font family, size, color, and formatting.\u003c/p\u003e\n"],["\u003cp\u003eIt can be linked to a \u003ccode\u003eRichTextValue\u003c/code\u003e for more complex formatting but may return \u003ccode\u003enull\u003c/code\u003e for style properties if the \u003ccode\u003eRichTextValue\u003c/code\u003e has multiple runs with differing styles.\u003c/p\u003e\n"],["\u003cp\u003eDevelopers can use methods like \u003ccode\u003egetFontFamily()\u003c/code\u003e, \u003ccode\u003egetFontSize()\u003c/code\u003e, \u003ccode\u003eisBold()\u003c/code\u003e, etc., to retrieve specific style attributes of the text.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eTextStyleBuilder\u003c/code\u003e can be created using the \u003ccode\u003ecopy()\u003c/code\u003e method to facilitate the construction of new text styles based on existing ones.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003egetForegroundColor()\u003c/code\u003e method is deprecated and should be replaced with \u003ccode\u003egetForegroundColorObject()\u003c/code\u003e to retrieve the font color as a \u003ccode\u003eColor\u003c/code\u003e object.\u003c/p\u003e\n"]]],["TextStyle defines the visual styling of text within a cell. It interacts with RichTextValue, which handles text segments with varied styles. Core actions include: `copy()` which creates a new TextStyleBuilder with the current style, and getter methods such as `getFontFamily()`, `getFontSize()`, `getForegroundColorObject()`, `isBold()`, `isItalic()`, `isStrikethrough()`, and `isUnderline()`, that each retrieve a specific text style property. Most getter methods may return `null` if the property is not set or varies within a RichTextValue.\n"],null,["# Class TextStyle\n\nTextStyle\n\nThe rendered style of text in a cell.\n\nText styles can have a corresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value). If the [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) spans multiple text runs that have different values for a given text style read\nmethod, the method returns `null`. To avoid this, query for text styles using the Rich Text\nvalues returned by the [RichTextValue.getRuns()](/apps-script/reference/spreadsheet/rich-text-value#getRuns()) method. \n\n### Methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------------------|---------------------------------------------------------------------------|------------------------------------------------------------------------------|\n| [copy()](#copy()) | [TextStyleBuilder](/apps-script/reference/spreadsheet/text-style-builder) | Creates a text style builder initialized with the values of this text style. |\n| [getFontFamily()](#getFontFamily()) | `String` | Gets the font family of the text. |\n| [getFontSize()](#getFontSize()) | `Integer` | Gets the font size of the text in points. |\n| [getForegroundColorObject()](#getForegroundColorObject()) | [Color](/apps-script/reference/spreadsheet/color) | Gets the font color of the text. |\n| [isBold()](#isBold()) | `Boolean` | Gets whether or not the text is bold. |\n| [isItalic()](#isItalic()) | `Boolean` | Gets whether or not the cell is italic. |\n| [isStrikethrough()](#isStrikethrough()) | `Boolean` | Gets whether or not the cell has strikethrough. |\n| [isUnderline()](#isUnderline()) | `Boolean` | Gets whether or not the cell is underlined. |\n\n### Deprecated methods\n\n| Method | Return type | Brief description |\n|-----------------------------------------------|-------------|----------------------------------|\n| [getForegroundColor()](#getForegroundColor()) | `String` | Gets the font color of the text. |\n\nDetailed documentation\n----------------------\n\n### `copy()`\n\nCreates a text style builder initialized with the values of this text style.\n\n#### Return\n\n\n[TextStyleBuilder](/apps-script/reference/spreadsheet/text-style-builder) --- A builder from this text style.\n\n*** ** * ** ***\n\n### `get``Font``Family()`\n\nGets the font family of the text. Returns `null` if the font family isn't set or the\ncorresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different font\nfamilies.\n\n#### Return\n\n\n`String` --- The font family of the text (for example, \"Arial\") or `null`.\n\n*** ** * ** ***\n\n### `get``Font``Size()`\n\nGets the font size of the text in points. Returns `null` if the font size isn't set or\nthe corresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different font\nsizes.\n\n#### Return\n\n\n`Integer` --- The font size of the text or `null`.\n\n*** ** * ** ***\n\n### `get``Foreground``Color``Object()`\n\nGets the font color of the text. Returns `null` if the font color isn't set or the\ncorresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different font\ncolors.\n\n#### Return\n\n\n[Color](/apps-script/reference/spreadsheet/color) --- The font color of the text or `null`.\n\n*** ** * ** ***\n\n### `is``Bold()`\n\nGets whether or not the text is bold. Returns `null` if bold isn't set or the\ncorresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different bold\nsettings.\n\n#### Return\n\n\n`Boolean` --- Whether or not the cell is bold, or `null`.\n\n*** ** * ** ***\n\n### `is``Italic()`\n\nGets whether or not the cell is italic. Returns `null` if italic isn't set or the\ncorresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different italic\nsettings.\n\n#### Return\n\n\n`Boolean` --- Whether or not the cell is italic, or `null`.\n\n*** ** * ** ***\n\n### `is``Strikethrough()`\n\nGets whether or not the cell has strikethrough. Returns `null` if strikethrough isn't set\nor the corresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different\nstrikethrough settings.\n\n#### Return\n\n\n`Boolean` --- Whether or not the cell has strikethrough, or `null`.\n\n*** ** * ** ***\n\n### `is``Underline()`\n\nGets whether or not the cell is underlined. Returns `null` if underline isn't set or the\ncorresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different underline\nsettings.\n\n#### Return\n\n\n`Boolean` --- Whether or not the cell is underlined, or `null`.\n\nDeprecated methods\n------------------\n\n### `get``Foreground``Color()`\n\n\n**Deprecated.** Replaced by [getForegroundColorObject()](#getForegroundColorObject())\n\nGets the font color of the text. Returns `null` if the font color isn't set or the\ncorresponding [RichTextValue](/apps-script/reference/spreadsheet/rich-text-value) has multiple runs with different font\ncolors.\n\n#### Return\n\n\n`String` --- The font color of the text as a hex CSS value (for example, \"#ff0000\") or `null`."]]
