Class TextStyle

TextStyle

O estilo do texto.

Os métodos de leitura nessa classe vão retornar null se o TextRange correspondente abranger várias execuções de texto e essas execuções tiverem valores diferentes para o método de leitura que estiver sendo chamado. Para evitar isso, consulte estilos de texto usando as TextRanges retornadas pelo método TextRange.getRuns().

Se você usar métodos que editam como o texto se encaixa em uma forma, todas as configurações de ajuste automático aplicadas aos estilos de texto serão desativadas.

Métodos

MétodoTipo de retornoBreve descrição
getBackgroundColor()ColorRetorna a cor de fundo do texto ou null se houver vários estilos no texto.
getBaselineOffset()TextBaselineOffsetRetorna o deslocamento vertical do texto da posição normal ou null se houver vários estilos no texto.
getFontFamily()StringRetorna a família de fontes do texto, ou null se houver vários estilos no texto.
getFontSize()NumberRetorna o tamanho da fonte do texto em pontos ou null se houver vários estilos no texto.
getFontWeight()IntegerRetorna a espessura da fonte do texto ou null se houver vários estilos no texto.
getForegroundColor()ColorRetorna a cor de primeiro plano do texto ou null se houver vários estilos no texto.
getLink()LinkRetorna o Link no texto ou null se não houver link ou se o link estiver em parte do texto ou se houver vários links.
hasLink()BooleanRetorna true se houver link no texto, false se não houver ou null se o link fizer parte do texto ou houver vários links.
isBackgroundTransparent()BooleanRetorna true se o plano de fundo do texto for transparente, false se não for, ou null se houver vários estilos no texto.
isBold()BooleanRetorna true se o texto é renderizado como negrito, false se não for, ou null se houver vários estilos no texto.
isItalic()BooleanRetorna true se o texto estiver em itálico, false se não estiver ou null se houver vários estilos no texto.
isSmallCaps()BooleanRetorna true se o texto estiver em letras maiúsculas pequenas, false se não estiver ou null se houver vários estilos no texto.
isStrikethrough()BooleanRetorna true se o texto é tachado, false se não for ou null se houver vários estilos no texto.
isUnderline()BooleanRetorna true se o texto estiver sublinhado, false se não estiver ou null se houver vários estilos no texto.
removeLink()TextStyleRemove um Link.
setBackgroundColor(color)TextStyleDefine a cor do plano de fundo do texto.
setBackgroundColor(red, green, blue)TextStyleDefine a cor de plano de fundo do texto para os valores RGB fornecidos de 0 a 255.
setBackgroundColor(hexColor)TextStyleDefine a cor do plano de fundo do texto para a string de cor hexadecimal especificada.
setBackgroundColor(color)TextStyleDefine a cor do plano de fundo do texto para o ThemeColorType especificado.
setBackgroundColorTransparent()TextStyleDefine a cor de fundo do texto como transparente.
setBaselineOffset(offset)TextStyleDefine o deslocamento vertical do texto em relação à posição normal.
setBold(bold)TextStyleDefine se o texto precisa ser renderizado em negrito.
setFontFamily(fontFamily)TextStyleDefine a família de fontes do texto .
setFontFamilyAndWeight(fontFamily, fontWeight)TextStyleDefine a família de fontes e a espessura do texto.
setFontSize(fontSize)TextStyleDefine o tamanho da fonte do texto, em pontos.
setForegroundColor(foregroundColor)TextStyleDefine a cor do primeiro plano do texto.
setForegroundColor(red, green, blue)TextStyleDefine a cor do primeiro plano do texto para os valores RGB fornecidos de 0 a 255.
setForegroundColor(hexColor)TextStyleDefine a cor do primeiro plano do texto para a string de cor hexadecimal especificada.
setForegroundColor(color)TextStyleDefine a cor do primeiro plano do texto para o ThemeColorType especificado.
setItalic(italic)TextStyleDefine se o texto será exibido em itálico.
setLinkSlide(slideIndex)TextStyleDefine um Link para o Slide especificado usando o índice baseado em zero do slide.
setLinkSlide(slide)TextStyleDefine um Link para o Slide especificado, o link é definido pelo ID do slide fornecido.
setLinkSlide(slidePosition)TextStyleDefine um Link para o Slide especificado usando a posição relativa do slide.
setLinkUrl(url)TextStyleDefine um Link para a string de URL não vazia fornecida.
setSmallCaps(smallCaps)TextStyleDefine se o texto será renderizado em letras maiúsculas pequenas.
setStrikethrough(strikethrough)TextStyleDefine se o texto será tachado.
setUnderline(underline)TextStyleDefine se o texto será sublinhado.

Documentação detalhada

getBackgroundColor()

Retorna a cor de fundo do texto ou null se houver vários estilos no texto.

Retorno

Color

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getBaselineOffset()

Retorna o deslocamento vertical do texto da posição normal ou null se houver vários estilos no texto.

Retorno

TextBaselineOffset

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getFontFamily()

Retorna a família de fontes do texto, ou null se houver vários estilos no texto.

Retorno

String

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getFontSize()

Retorna o tamanho da fonte do texto em pontos ou null se houver vários estilos no texto.

Retorno

Number

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getFontWeight()

Retorna a espessura da fonte do texto ou null se houver vários estilos no texto.

O peso é um múltiplo de 100 entre 100 e 900. Esse intervalo corresponde aos valores numéricos descritos na especificação do CSS 2.1, seção 15.6, com valores não numéricos não permitidos. Pesos maiores ou iguais a 700 são considerados em negrito, nesse caso, isBold() retorna true. O valor padrão é 400 ("normal").

Retorno

Integer

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

getForegroundColor()

Retorna a cor de primeiro plano do texto ou null se houver vários estilos no texto.

Retorno

Color

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

Retorna o Link no texto ou null se não houver link ou se o link estiver em parte do texto ou se houver vários links. Chame hasLink() para determinar se o texto não tem link.

var textLink = shape.getText().getTextStyle().getLink();
if (textLink != null) {
  Logger.log('Shape text has a link of type: ' + textLink.getLinkType());
}

Retorno

Link

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

Retorna true se houver link no texto, false se não houver ou null se o link fizer parte do texto ou houver vários links.

Não é possível definir links em caracteres de nova linha. Portanto, se TextRange contiver um caractere de nova linha, esse método sempre retornará null ou false.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isBackgroundTransparent()

Retorna true se o plano de fundo do texto for transparente, false se não for, ou null se houver vários estilos no texto.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isBold()

Retorna true se o texto é renderizado como negrito, false se não for, ou null se houver vários estilos no texto.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isItalic()

Retorna true se o texto estiver em itálico, false se não estiver ou null se houver vários estilos no texto.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isSmallCaps()

Retorna true se o texto estiver em letras maiúsculas pequenas, false se não estiver ou null se houver vários estilos no texto.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isStrikethrough()

Retorna true se o texto é tachado, false se não for ou null se houver vários estilos no texto.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

isUnderline()

Retorna true se o texto estiver sublinhado, false se não estiver ou null se houver vários estilos no texto.

Retorno

Boolean

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

Remove um Link.

A remoção de um link remove a cor do primeiro plano e o estilo de sublinhado do hiperlink do texto. Se possível, esses estilos são aplicados para corresponder ao texto que precede o link.

text.getTextStyle().removeLink();

Retorno

TextStyle


setBackgroundColor(color)

Define a cor do plano de fundo do texto.

Parâmetros

NomeTipoDescrição
colorColor

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setBackgroundColor(red, green, blue)

Define a cor de plano de fundo do texto para os valores RGB fornecidos de 0 a 255.

Parâmetros

NomeTipoDescrição
redInteger
greenInteger
blueInteger

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setBackgroundColor(hexColor)

Define a cor do plano de fundo do texto para a string de cor hexadecimal especificada.

A string hexadecimal precisa estar no formato "#RRGGBB". Por exemplo, rosa seria representado como '#FFC0CB'.

Parâmetros

NomeTipoDescrição
hexColorString

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setBackgroundColor(color)

Define a cor do plano de fundo do texto para o ThemeColorType especificado.

Parâmetros

NomeTipoDescrição
colorThemeColorType

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setBackgroundColorTransparent()

Define a cor de fundo do texto como transparente.

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setBaselineOffset(offset)

Define o deslocamento vertical do texto em relação à posição normal.

Parâmetros

NomeTipoDescrição
offsetTextBaselineOffset

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setBold(bold)

Define se o texto precisa ser renderizado em negrito.

Mudar o negrito do texto atualiza a espessura da fonte usada para renderizar o texto.

Parâmetros

NomeTipoDescrição
boldBoolean

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setFontFamily(fontFamily)

Define a família de fontes do texto .

Parâmetros

NomeTipoDescrição
fontFamilyString

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setFontFamilyAndWeight(fontFamily, fontWeight)

Define a família de fontes e a espessura do texto.

O peso é um múltiplo de 100 entre 100 e 900. Esse intervalo corresponde aos valores numéricos descritos na especificação do CSS 2.1, seção 15.6, com valores não numéricos não permitidos. Pesos maiores ou iguais a 700 são considerados em negrito, nesse caso, isBold() retorna true. O valor padrão é 400 ("normal").

Parâmetros

NomeTipoDescrição
fontFamilyString
fontWeightInteger

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setFontSize(fontSize)

Define o tamanho da fonte do texto, em pontos.

Parâmetros

NomeTipoDescrição
fontSizeNumber

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setForegroundColor(foregroundColor)

Define a cor do primeiro plano do texto.

Parâmetros

NomeTipoDescrição
foregroundColorColor

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setForegroundColor(red, green, blue)

Define a cor do primeiro plano do texto para os valores RGB fornecidos de 0 a 255.

Parâmetros

NomeTipoDescrição
redInteger
greenInteger
blueInteger

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setForegroundColor(hexColor)

Define a cor do primeiro plano do texto para a string de cor hexadecimal especificada.

A string hexadecimal precisa estar no formato "#RRGGBB". Por exemplo, rosa seria representado como '#FFC0CB'.

Parâmetros

NomeTipoDescrição
hexColorString

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setForegroundColor(color)

Define a cor do primeiro plano do texto para o ThemeColorType especificado.

Parâmetros

NomeTipoDescrição
colorThemeColorType

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setItalic(italic)

Define se o texto será exibido em itálico.

Parâmetros

NomeTipoDescrição
italicBoolean

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLinkSlide(slideIndex)

Define um Link para o Slide especificado usando o índice baseado em zero do slide.

A definição de um link muda o estilo do texto para ser sublinhado e para ter uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como os links não podem ser definidos em caracteres de nova linha, esses caracteres em TextRange são ignorados.

// Set a link to the first slide of the presentation.
text.getTextStyle().setLinkSlide(0);

Parâmetros

NomeTipoDescrição
slideIndexIntegerO índice baseado em zero para o slide.

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLinkSlide(slide)

Define um Link para o Slide especificado, o link é definido pelo ID do slide fornecido.

A definição de um link muda o estilo do texto para ser sublinhado e para ter uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como os links não podem ser definidos em caracteres de nova linha, esses caracteres em TextRange são ignorados.

// Set a link to the first slide of the presentation.
var slide = presentation.getSlides()[0];
text.getTextStyle().setLinkSlide(slide);

Parâmetros

NomeTipoDescrição
slideSlideO Slide que será vinculado.

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLinkSlide(slidePosition)

Define um Link para o Slide especificado usando a posição relativa do slide.

A definição de um link muda o estilo do texto para ser sublinhado e para ter uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como os links não podem ser definidos em caracteres de nova linha, esses caracteres em TextRange são ignorados.

// Set a link to the first slide of the presentation.
text.getTextStyle().setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);

Parâmetros

NomeTipoDescrição
slidePositionSlidePositionO SlidePosition relativo.

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setLinkUrl(url)

Define um Link para a string de URL não vazia fornecida.

A definição de um link muda o estilo do texto para ser sublinhado e para ter uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como os links não podem ser definidos em caracteres de nova linha, esses caracteres em TextRange são ignorados.

// Set a link to the URL.
text.getTextStyle().setLinkUrl("https://slides.google.com");

Parâmetros

NomeTipoDescrição
urlStringA string do URL.

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setSmallCaps(smallCaps)

Define se o texto será renderizado em letras maiúsculas pequenas.

Parâmetros

NomeTipoDescrição
smallCapsBoolean

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setStrikethrough(strikethrough)

Define se o texto será tachado.

Parâmetros

NomeTipoDescrição
strikethroughBoolean

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations

setUnderline(underline)

Define se o texto será sublinhado.

Parâmetros

NomeTipoDescrição
underlineBoolean

Retorno

TextStyle

Autorização

Os scripts que usam esse método exigem autorização com um ou mais dos seguintes escopos:

  • https://www.googleapis.com/auth/presentations.currentonly
  • https://www.googleapis.com/auth/presentations