Class RichTextValueBuilder

RichTextValueBuilder

Outil de création de valeurs de texte enrichi.

Méthodes

MéthodeType renvoyéBrève description
build()RichTextValueCrée une valeur de texte enrichi à partir de cet outil de création.
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilderDéfinit l'URL du lien pour la sous-chaîne donnée de cette valeur ou l'efface si linkUrl est null
setLinkUrl(linkUrl)RichTextValueBuilderDéfinit l'URL du lien pour la valeur complète ou l'efface si linkUrl est null.
setText(text)RichTextValueBuilderDéfinit le texte correspondant à cette valeur et efface tout style de texte existant.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderApplique un style de texte à la sous-chaîne donnée de cette valeur.
setTextStyle(textStyle)RichTextValueBuilderApplique un style de texte à la valeur entière.

Documentation détaillée

build()

Crée une valeur de texte enrichi à partir de cet outil de création.

Renvois

RichTextValue : valeur de texte enrichi créée à partir de cet outil de création.


setLinkUrl(startOffset, endOffset, linkUrl)

Définit l'URL du lien pour la sous-chaîne donnée de cette valeur ou l'efface si linkUrl est null

// Creates a Rich Text value for the text "foo no baz" with "foo" pointing to
// "https://bar.foo" and "baz" to "https://abc.xyz".
// "foo" is underlined with the default link color, whereas "baz" has its text style
// overridden by a call to `setTextStyle`, and is therefore black and bold with no underlining.
const boldStyle = SpreadsheetApp.newTextStyle()
    .setUnderline(false)
    .setBold(true)
    .setForegroundColor("#000000")
    .build();
const value = SpreadsheetApp.newRichTextValue()
    .setText("foo no baz")
    .setLinkUrl(0, 3, "https://bar.foo")
    .setLinkUrl(7, 10, "https://abc.xyz")
    .setTextStyle(7, 10, boldStyle)
    .build();

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la sous-chaîne, inclus.
endOffsetIntegerDécalage de fin de la sous-chaîne, exclusif.
linkUrlStringURL du lien en cours de définition.

Renvois

RichTextValueBuilder : compilateur pour le chaînage.


setLinkUrl(linkUrl)

Définit l'URL du lien pour la valeur complète ou l'efface si linkUrl est null.

// Creates a Rich Text value for the text "Foo" which points to "https://bar.foo".
const value = SpreadsheetApp.newRichTextValue()
    .setText("Foo")
    .setLinkUrl("https://bar.foo")
    .build();

Paramètres

NomTypeDescription
linkUrlStringURL du lien en cours de définition.

Renvois

RichTextValueBuilder : compilateur pour le chaînage.


setText(text)

Définit le texte correspondant à cette valeur et efface tout style de texte existant. Lors de la création d'un texte enrichi , il doit être appelé avant setTextStyle(startOffset, endOffset, textStyle).

Paramètres

NomTypeDescription
textStringTexte de cette valeur.

Renvois

RichTextValueBuilder : compilateur pour le chaînage.


setTextStyle(startOffset, endOffset, textStyle)

Applique un style de texte à la sous-chaîne donnée de cette valeur. Les décalages sont basés sur 0 et sont relatifs à la valeur textuelle de la cellule. N'a aucun effet si textStyle est défini sur null.

// Creates a Rich Text value for the text "HelloWorld", with "Hello" bolded, and "World"
// italicized.
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("HelloWorld")
    .setTextStyle(0, 5, bold)
    .setTextStyle(5, 10, italic)
    .build();

Paramètres

NomTypeDescription
startOffsetIntegerDécalage de début de la sous-chaîne, inclus.
endOffsetIntegerDécalage de fin de la sous-chaîne, exclusif.
textStyleTextStyleStyle de texte en cours de définition.

Renvois

RichTextValueBuilder : compilateur pour le chaînage.


setTextStyle(textStyle)

Applique un style de texte à la valeur entière. Les styles de texte définis précédemment ne sont affectés que s'ils sont directement écrasées par les valeurs dans textStyle. N'a aucun effet si textStyle est null.

// Creates a Rich Text value for the text "HelloWorld" with "Hello" bolded and italicized,
// and "World" only italicized.
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("HelloWorld")
    .setTextStyle(0, 5, bold)
    .setTextStyle(italic)
    .build();

Paramètres

NomTypeDescription
textStyleTextStyleStyle de texte en cours de définition.

Renvois

RichTextValueBuilder : compilateur pour le chaînage.