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 die angegebene Teilstring dieses Werts fest oder löscht sie, wenn linkUrl is null.
setLinkUrl(linkUrl)RichTextValueBuilderLegt die Link-URL für den gesamten Wert fest oder löscht sie, wenn linkUrl null ist.
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 Teilstring 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 Rich-Text-Wert, der aus diesem Builder erstellt wurde.


setLinkUrl(startOffset, endOffset, linkUrl)

Legt die Link-URL für die angegebene 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 Start-Offset für die Teilstring (einschließlich).
endOffsetIntegerDer End-Offset für die Teilstring (ausschließlich).
linkUrlStringDie festzulegende 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 festzulegende Link-URL.

Rückflug

RichTextValueBuilder : Dieser Builder zur Verkettung.


setText(text)

Legt den Text für diesen Wert fest und löscht alle vorhandenen Textstile. Wenn Sie einen neuen Rich-Text-Wert erstellen, 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 die angegebene Teilstring dieses Werts an. Offsets sind nullbasiert und relativ zum Textwert der Zelle. Diese Methode hat keine Auswirkungen, 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 Start-Offset für die Teilstring (einschließlich).
endOffsetIntegerDer End-Offset für die Teilstring (ausschließlich).
textStyleTextStyleDer festzulegende Textstil.

Rückflug

RichTextValueBuilder : Dieser Builder zur Verkettung.


setTextStyle(textStyle)

Wendet einen Textstil auf den gesamten Wert an. Zuvor festgelegte Textstile werden nur beeinflusst, wenn sie direkt durch Werte in textStyle überschrieben werden. Diese Methode hat keine Auswirkungen, 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 festzulegende Textstil.

Rückflug

RichTextValueBuilder : Dieser Builder zur Verkettung.