Class RichTextValueBuilder

RichTextValueBuilder

Un compilador para valores de texto enriquecido.

Métodos

Método	Tipo de datos que se muestra	Descripción breve
build()	RichTextValue	Crea un valor de texto enriquecido a partir de este compilador.
setLinkUrl(startOffset, endOffset, linkUrl)	RichTextValueBuilder	Configura la URL del vínculo para la subcadena determinada de este valor o la borra si linkUrl es null.
setLinkUrl(linkUrl)	RichTextValueBuilder	Establece la URL del vínculo para todo el valor o la borra si linkUrl es null.
setText(text)	RichTextValueBuilder	Establece el texto para este valor y borra los estilos de texto existentes.
setTextStyle(startOffset, endOffset, textStyle)	RichTextValueBuilder	Aplica un estilo de texto a la subcadena dada de este valor.
setTextStyle(textStyle)	RichTextValueBuilder	Aplica un estilo de texto a todo el valor.

Documentación detallada

build()

Crea un valor de texto enriquecido a partir de este compilador.

Devolvedor

RichTextValue: Es un valor de texto enriquecido creado a partir de este compilador.

---

setLinkUrl(startOffset, endOffset, linkUrl)

Configura la URL del vínculo para la subcadena determinada de este valor o la borra si linkUrl es 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();

Parámetros

Nombre	Tipo	Descripción
startOffset	Integer	El desplazamiento inicial de la substring, inclusive.
endOffset	Integer	Es el desplazamiento final de la substring, exclusivo.
linkUrl	String	La URL del vínculo que se establece.

Devolvedor

RichTextValueBuilder: Este compilador se usa para encadenar.

---

setLinkUrl(linkUrl)

Establece la URL del vínculo para todo el valor o la borra si linkUrl es 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();

Parámetros

Nombre	Tipo	Descripción
linkUrl	String	La URL del vínculo que se establece.

Devolvedor

RichTextValueBuilder: Este compilador se usa para encadenar.

---

setText(text)

Establece el texto para este valor y borra los estilos de texto existentes. Cuando se crea un nuevo valor de texto enriquecido, se debe llamar a este antes de setTextStyle(startOffset, endOffset, textStyle).

Parámetros

Nombre	Tipo	Descripción
text	String	Es el texto de este valor.

Devolvedor

RichTextValueBuilder: Este compilador se usa para encadenar.

---

setTextStyle(startOffset, endOffset, textStyle)

Aplica un estilo de texto a la subcadena dada de este valor. Los desplazamientos se basan en 0 y son relativos al valor de texto de la celda. No hace nada si textStyle es 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();

Parámetros

Nombre	Tipo	Descripción
startOffset	Integer	El desplazamiento inicial de la substring, inclusive.
endOffset	Integer	Es el desplazamiento final de la substring, exclusivo.
textStyle	TextStyle	El estilo de texto que se configura

Devolvedor

RichTextValueBuilder: Este compilador se usa para encadenar.

---

setTextStyle(textStyle)

Aplica un estilo de texto a todo el valor. Los estilos de texto previamente establecidos solo se ven afectados si se reemplazan directamente por valores dentro de textStyle. No hace nada si textStyle es 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();

Parámetros

Nombre	Tipo	Descripción
textStyle	TextStyle	El estilo de texto que se configura

Devolvedor

RichTextValueBuilder: Este compilador se usa para encadenar.