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 null ist.
setLinkUrl(linkUrl)RichTextValueBuilderLegt die Link-URL für den gesamten Wert fest oder löscht sie, wenn linkUrl null ist.
setText(text)RichTextValueBuilderHiermit wird der Text für diesen Wert festgelegt und alle vorhandenen Textstile gelöscht.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderWendet einen Textstil auf den angegebenen Teilstring dieses Werts an.
setTextStyle(textStyle)RichTextValueBuilderHiermit wird der gesamte Wert in einen Textstil umgewandelt.

Detaillierte Dokumentation

build()

Erstellt einen Rich-Text-Wert aus diesem Builder.

Rückflug

RichTextValue: Ein Rich-Text-Wert, der mit diesem Builder erstellt wurde.


setLinkUrl(startOffset, endOffset, linkUrl)

Legt die Link-URL für den angegebenen Teilstring dieses Werts fest oder löscht sie, wenn linkUrl null ist.

// 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 Startoffset für den Teilstring, einschließlich.
endOffsetIntegerDer Endversatz für den Teilstring, exklusiv.
linkUrlStringDie festgelegte Link-URL.

Rückflug

RichTextValueBuilder – Dieser Builder zur Verkettung.


setLinkUrl(linkUrl)

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

// 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 festgelegte Link-URL.

Rückflug

RichTextValueBuilder – Dieser Builder zur Verkettung.


setText(text)

Hiermit wird der Text für diesen Wert festgelegt und alle vorhandenen Textstile gelöscht. Beim Erstellen eines neuen Rich-Text-Werts sollte diese Methode vor setTextStyle(startOffset, endOffset, textStyle) aufgerufen werden.

Parameter

NameTypBeschreibung
textStringDer Text für diesen Wert.

Rückflug

RichTextValueBuilder – Dieser Builder zur Verkettung.


setTextStyle(startOffset, endOffset, textStyle)

Wendet einen Textstil auf den angegebenen Teilstring dieses Werts an. Ansätze beginnen bei 0 und sind relativ zum Textwert der Zelle. Es passiert nichts, wenn textStyle null ist.

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

Parameter

NameTypBeschreibung
startOffsetIntegerDer Startoffset für den Teilstring, einschließlich.
endOffsetIntegerDer Endversatz für den Teilstring, exklusiv.
textStyleTextStyleDer festgelegte Textstil.

Rückflug

RichTextValueBuilder – Dieser Builder zur Verkettung.


setTextStyle(textStyle)

Hiermit wird der gesamte Wert in einen Textstil umgewandelt. Bisher festgelegte Textstile sind nur dann betroffen, wenn sie direkt durch Werte in textStyle überschrieben werden. Es passiert nichts, wenn textStyle null ist.

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

Parameter

NameTypBeschreibung
textStyleTextStyleDer festgelegte Textstil.

Rückflug

RichTextValueBuilder – Dieser Builder zur Verkettung.