Class RichTextValueBuilder

Outil de création devaleursde texteenrichi

Générateur 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 l'ensemble de la valeur ou l'efface si linkUrl est défini sur null.
setText(text)RichTextValueBuilderDéfinit le texte pour 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 à l'ensemble de la valeur.

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 ce compilateur.

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 (exclu).
linkUrlStringURL du lien défini.

Renvois

RichTextValueBuilder : ce générateur, pour le chaînage.

setLinkUrl(linkUrl)

Définit l'URL du lien pour l'ensemble de la valeur ou l'efface si linkUrl est défini sur 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 défini.

Renvois

RichTextValueBuilder : ce générateur, pour le chaînage.

setText(text)

Définit le texte pour cette valeur et efface tout style de texte existant. Lorsque vous créez une valeur de texte enrichi, vous devez l'appeler avant setTextStyle(startOffset, endOffset, textStyle).

Paramètres

NomTypeDescription
textStringTexte de cette valeur.

Renvois

RichTextValueBuilder : ce générateur, 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. Ne fait rien si textStyle est null. 

// Creates a Rich Text value for the text "HelloWorld", with "Hello" bolded, and
// "World" italicized.
const bold = SpreadsheetApp.newTextStyle().setBold(true).build();
const italic = SpreadsheetApp.newTextStyle().setItalic(true).build();
const 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 (exclu).
textStyleTextStyleStyle de texte défini.

Renvois

RichTextValueBuilder : ce générateur, pour le chaînage.

setTextStyle(textStyle)

Applique un style de texte à l'ensemble de la valeur. Les styles de texte précédemment définis ne sont affectés que s'ils sont directement écrasés par des valeurs dans textStyle. Ne fait rien si textStyle est null. 

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

Paramètres

NomTypeDescription
textStyleTextStyleStyle de texte défini.

Renvois

RichTextValueBuilder : ce générateur, pour le chaînage.