Class RichTextValueBuilder

Creador devalores de texto enriquecido

Es un compilador para valores de texto enriquecido.

Métodos

MétodoTipo de datos que se muestraDescripción breve
build()RichTextValueCrea un valor de texto enriquecido a partir de este compilador.
setLinkUrl(startOffset, endOffset, linkUrl)RichTextValueBuilderEstablece la URL de vínculo para la subcadena determinada de este valor o la borra si linkUrl es null.
setLinkUrl(linkUrl)RichTextValueBuilderEstablece la URL del vínculo para todo el valor o lo borra si linkUrl es null.
setText(text)RichTextValueBuilderEstablece el texto para este valor y borra cualquier estilo de texto existente.
setTextStyle(startOffset, endOffset, textStyle)RichTextValueBuilderAplica un estilo de texto a la subcadena determinada de este valor.
setTextStyle(textStyle)RichTextValueBuilderAplica un estilo de texto a todo el valor.

Documentación detallada

build()

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

Volver

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


setLinkUrl(startOffset, endOffset, linkUrl)

Establece la URL de 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

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial de la subcadena, inclusive.
endOffsetIntegerEs el desplazamiento final de la subcadena, exclusivo.
linkUrlStringLa URL del vínculo que se establece.

Volver

RichTextValueBuilder: Este compilador, para encadenar.


setLinkUrl(linkUrl)

Establece la URL del vínculo para todo el valor o lo 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

NombreTipoDescripción
linkUrlStringLa URL del vínculo que se establece.

Volver

RichTextValueBuilder: Este compilador, para encadenar.


setText(text)

Establece el texto para este valor y borra cualquier estilo de texto existente. Cuando se crea un valor de texto enriquecido nuevo, se debe llamar a esto antes de setTextStyle(startOffset, endOffset, textStyle).

Parámetros

NombreTipoDescripción
textStringEl texto de este valor.

Volver

RichTextValueBuilder: Este compilador, para encadenar.


setTextStyle(startOffset, endOffset, textStyle)

Aplica un estilo de texto a la subcadena determinada 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.
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();

Parámetros

NombreTipoDescripción
startOffsetIntegerEs el desplazamiento inicial de la subcadena, inclusive.
endOffsetIntegerEs el desplazamiento final de la subcadena, exclusivo.
textStyleTextStyleEs el estilo de texto que se está configurando.

Volver

RichTextValueBuilder: Este compilador, para encadenar.


setTextStyle(textStyle)

Aplica un estilo de texto a todo el valor. Los estilos de texto establecidos anteriormente 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.
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();

Parámetros

NombreTipoDescripción
textStyleTextStyleEs el estilo de texto que se está configurando.

Volver

RichTextValueBuilder: Este compilador, para encadenar.