Compilateur pour les valeurs en texte enrichi.
Méthodes
Méthode | Type renvoyé | Brève description |
---|---|---|
build() | RichTextValue | Crée une valeur de texte enrichi à partir de ce compilateur. |
setLinkUrl(startOffset, endOffset, linkUrl) | RichTextValueBuilder | Définit l'URL du lien pour la sous-chaîne donnée de cette valeur ou l'efface si linkUrl est null . |
setLinkUrl(linkUrl) | RichTextValueBuilder | Définit l'URL du lien pour la valeur entière ou l'efface si linkUrl est défini sur null . |
setText(text) | RichTextValueBuilder | Définit le texte de cette valeur et efface tout style de texte existant. |
setTextStyle(startOffset, endOffset, textStyle) | RichTextValueBuilder | Applique un style de texte à la sous-chaîne donnée de cette valeur. |
setTextStyle(textStyle) | RichTextValueBuilder | Applique un style de texte à l'ensemble de la valeur. |
Documentation détaillée
build()
Crée une valeur de texte enrichi à partir de ce compilateur.
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
Nom | Type | Description |
---|---|---|
startOffset | Integer | Décalage de début inclus pour la sous-chaîne. |
endOffset | Integer | Décalage de fin pour la sous-chaîne, exclusif. |
linkUrl | String | URL du lien définie. |
Renvois
RichTextValueBuilder
: compilateur pour le chaînage.
setLinkUrl(linkUrl)
Définit l'URL du lien pour la valeur entière 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
Nom | Type | Description |
---|---|---|
linkUrl | String | URL du lien définie. |
Renvois
RichTextValueBuilder
: compilateur pour le chaînage.
setText(text)
Définit le texte de cette valeur et efface tout style de texte existant. Lors de la création d'une valeur de texte enrichi, cette valeur doit être appelée avant setTextStyle(startOffset, endOffset, textStyle)
.
Paramètres
Nom | Type | Description |
---|---|---|
text | String | Texte 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 de texte de la cellule. N'a aucun effet si la valeur de textStyle
est 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
Nom | Type | Description |
---|---|---|
startOffset | Integer | Décalage de début inclus pour la sous-chaîne. |
endOffset | Integer | Décalage de fin pour la sous-chaîne, exclusif. |
textStyle | TextStyle | Style de texte défini. |
Renvois
RichTextValueBuilder
: compilateur pour le chaînage.
setTextStyle(textStyle)
Applique un style de texte à l'ensemble de la valeur. Les styles de texte définis précédemment ne sont affectés que s'ils sont directement écrasés par des valeurs dans textStyle
. N'a aucun effet si textStyle
est défini sur 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
Nom | Type | Description |
---|---|---|
textStyle | TextStyle | Style de texte défini. |
Renvois
RichTextValueBuilder
: compilateur pour le chaînage.