Class RichTextValueBuilder

RichTextValueBuilder

Ein Builder für Rich-Text-Werte.

Methoden

MethodeRückgabetypKurzbeschreibung
build()RichTextValueErstellt einen Rich-Text-Wert aus diesem Builder.
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilderLegt die Link-URL für den angegebenen Teilstring dieses Werts fest oder löscht sie, wenn linkUrl Folgendes ist: null.
setLinkUrl(linkUrl)RichTextValueBuilderLegt die Link-URL für den gesamten Wert fest oder löscht sie, wenn linkUrl den Wert null hat.
setText(text)RichTextValueBuilderLegt den Text für diesen Wert fest und löscht alle vorhandenen Textstile.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderWendet einen Textstil auf die angegebene Teilzeichenfolge dieses Werts an.
setTextStyle(textStyle)RichTextValueBuilderWendet einen Textstil auf den gesamten Wert an.

Detaillierte Dokumentation

build()

Erstellt einen Rich-Text-Wert aus diesem Builder.

Rückflug

RichTextValue: Ein von diesem Builder erstellter RTF-Wert.


setLinkUrl(startOffset, endOffset, linkUrl)

Legt die Link-URL für den angegebenen Teilstring dieses Werts fest oder löscht sie, wenn linkUrl Folgendes ist: 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();

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz für die Teilzeichenfolge (einschließlich).
endOffsetIntegerDer Endversatz für die Teilzeichenfolge, ausschließlich.
linkUrlStringDie Link-URL, die festgelegt wird.

Rückflug

RichTextValueBuilder: Dieser Builder für Verkettungen.


setLinkUrl(linkUrl)

Legt die Link-URL für den gesamten Wert fest oder löscht sie, wenn linkUrl den Wert null hat.

// 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();

Parameter

NameTypBeschreibung
linkUrlStringDie Link-URL, die festgelegt wird.

Rückflug

RichTextValueBuilder: Dieser Builder für Verkettungen.


setText(text)

Legt den Text für diesen Wert fest und löscht alle vorhandenen Textstile. Beim Erstellen eines neuen Rich-Text- muss vor setTextStyle(startOffset, endOffset, textStyle) aufgerufen werden.

Parameter

NameTypBeschreibung
textStringDer Text für diesen Wert.

Rückflug

RichTextValueBuilder: Dieser Builder für Verkettungen.


setTextStyle(startOffset, endOffset, textStyle)

Wendet einen Textstil auf die angegebene Teilzeichenfolge dieses Werts an. Offsets sind 0-basiert und relativ mit dem Textwert der Zelle. Tut nichts, wenn textStyle null ist.

// 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();

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startversatz für die Teilzeichenfolge (einschließlich).
endOffsetIntegerDer Endversatz für die Teilzeichenfolge, ausschließlich.
textStyleTextStyleDer Textstil, der festgelegt wird.

Rückflug

RichTextValueBuilder: Dieser Builder für Verkettungen.


setTextStyle(textStyle)

Wendet einen Textstil auf den gesamten Wert an. Zuvor festgelegte Textstile sind nur betroffen, wenn sie werden direkt von Werten in textStyle überschrieben. Tut nichts, wenn textStyle ist 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();

Parameter

NameTypBeschreibung
textStyleTextStyleDer Textstil, der festgelegt wird.

Rückflug

RichTextValueBuilder: Dieser Builder für Verkettungen.