Class TextStyle

  • TextStyle defines the rendered style of text within a cell in Google Sheets, encompassing attributes like font family, size, color, and formatting.

  • It can be linked to a RichTextValue for more complex formatting but may return null for style properties if the RichTextValue has multiple runs with differing styles.

  • Developers can use methods like getFontFamily(), getFontSize(), isBold(), etc., to retrieve specific style attributes of the text.

  • A TextStyleBuilder can be created using the copy() method to facilitate the construction of new text styles based on existing ones.

  • The getForegroundColor() method is deprecated and should be replaced with getForegroundColorObject() to retrieve the font color as a Color object.
TextStyle

The rendered style of text in a cell.

Text styles can have a corresponding RichTextValue. If the RichTextValue spans multiple text runs that have different values for a given text style read method, the method returns null. To avoid this, query for text styles using the Rich Text values returned by the RichTextValue.getRuns() method.

Methods

MethodReturn typeBrief description
copy()TextStyleBuilderCreates a text style builder initialized with the values of this text style.
getFontFamily()StringGets the font family of the text.
getFontSize()IntegerGets the font size of the text in points.
getForegroundColorObject()ColorGets the font color of the text.
isBold()BooleanGets whether or not the text is bold.
isItalic()BooleanGets whether or not the cell is italic.
isStrikethrough()BooleanGets whether or not the cell has strikethrough.
isUnderline()BooleanGets whether or not the cell is underlined.

Detailed documentation

copy()

Creates a text style builder initialized with the values of this text style.

Return

TextStyleBuilder — A builder from this text style.

getFontFamily()

Gets the font family of the text. Returns null if the font family isn't set or the corresponding RichTextValue has multiple runs with different font families.

Return

String — The font family of the text (for example, "Arial") or null.

getFontSize()

Gets the font size of the text in points. Returns null if the font size isn't set or the corresponding RichTextValue has multiple runs with different font sizes.

Return

Integer — The font size of the text or null.

getForegroundColorObject()

Gets the font color of the text. Returns null if the font color isn't set or the corresponding RichTextValue has multiple runs with different font colors.

Return

Color — The font color of the text or null.

isBold()

Gets whether or not the text is bold. Returns null if bold isn't set or the corresponding RichTextValue has multiple runs with different bold settings.

Return

Boolean — Whether or not the cell is bold, or null.

isItalic()

Gets whether or not the cell is italic. Returns null if italic isn't set or the corresponding RichTextValue has multiple runs with different italic settings.

Return

Boolean — Whether or not the cell is italic, or null.

isStrikethrough()

Gets whether or not the cell has strikethrough. Returns null if strikethrough isn't set or the corresponding RichTextValue has multiple runs with different strikethrough settings.

Return

Boolean — Whether or not the cell has strikethrough, or null.

isUnderline()

Gets whether or not the cell is underlined. Returns null if underline isn't set or the corresponding RichTextValue has multiple runs with different underline settings.

Return

Boolean — Whether or not the cell is underlined, or null.

Deprecated methods