Class TextStyle

TextStyle

O estilo do texto.

Os métodos de leitura nessa classe retornam null se os TextRange correspondentes abrangem várias execuções de texto e essas execuções têm valores diferentes para o método de leitura que está sendo chamado. Para evitar isso, consulte os estilos de texto usando os TextRanges retornados pelo método TextRange.getRuns().

Se você usar métodos que editam como o texto se ajusta a 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()Color|nullRetorna a cor de fundo do texto ou null se houver vários estilos no texto.
getBaselineOffset()TextBaselineOffset|nullRetorna o deslocamento vertical do texto da posição normal ou null se houver vários estilos no texto.
getFontFamily()String|nullRetorna a família de fontes do texto ou null se houver vários estilos no texto.
getFontSize()Number|nullRetorna o tamanho da fonte do texto em pontos ou null se houver vários estilos no texto.
getFontWeight()Integer|nullRetorna a espessura da fonte do texto ou null se houver vários estilos no texto.
getForegroundColor()Color|nullRetorna a cor de primeiro plano do texto ou null se houver vários estilos no texto.
getLink()Link|nullRetorna o Link no texto ou null se não houver um link, se ele estiver em parte do texto ou se houver vários links.
hasLink()Boolean|nullRetorna true se houver um link no texto, false se não houver ou null se o link estiver em parte do texto ou se houver vinculação múltipla.
isBackgroundTransparent()Boolean|nullRetorna 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()Boolean|nullRetorna true se o texto for renderizado em negrito, false se não for ou null se houver vários estilos no texto.
isItalic()Boolean|nullRetorna true se o texto estiver em itálico, false se não estiver ou null se houver vários estilos no texto.
isSmallCaps()Boolean|nullRetorna 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()Boolean|nullRetorna true se o texto estiver tachado, false se não estiver ou null se houver vários estilos no texto.
isUnderline()Boolean|nullRetorna true se o texto estiver sublinhado, false se não estiver ou null se houver vários estilos no texto.
removeLink()TextStyleRemove uma 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 com os valores RGB especificados de 0 a 255.
setBackgroundColor(hexColor)TextStyleDefine a cor do plano de fundo do texto como a string de cor hexadecimal especificada.
setBackgroundColor(color)TextStyleDefine a cor do plano de fundo do texto como o ThemeColorType especificado.
setBackgroundColorTransparent()TextStyleDefine a cor do plano 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 deve ser renderizado em negrito.
setFontFamily(fontFamily)TextStyleDefine a família de fontes do texto .
setFontFamilyAndWeight(fontFamily, fontWeight)TextStyleDefine a família e a espessura da fonte do texto.
setFontSize(fontSize)TextStyleDefine o tamanho da fonte do texto em pontos.
setForegroundColor(foregroundColor)TextStyleDefine a cor de primeiro plano do texto.
setForegroundColor(red, green, blue)TextStyleDefine a cor de primeiro plano do texto com os valores RGB especificados de 0 a 255.
setForegroundColor(hexColor)TextStyleDefine a cor de primeiro plano do texto como a string de cor hexadecimal especificada.
setForegroundColor(color)TextStyleDefine a cor de primeiro plano do texto como o ThemeColorType especificado.
setItalic(italic)TextStyleDefine se o texto está 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 especificada.
setSmallCaps(smallCaps)TextStyleDefine se o texto é renderizado em letras maiúsculas pequenas.
setStrikethrough(strikethrough)TextStyleDefine se o texto está tachado.
setUnderline(underline)TextStyleDefine se o texto está sublinhado.

Documentação detalhada

getBackgroundColor()

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

Retornar

Color|null: a cor de fundo do texto.

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.

Retornar

TextBaselineOffset|null: o deslocamento vertical do texto da posição normal.

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.

Retornar

String|null: a família de fontes do texto.

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.

Retornar

Number|null: o tamanho da fonte do texto em pontos.

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 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 negrito. Nesse caso, isBold() retorna true. O valor padrão é 400 ("normal").

Retornar

Integer|null: o peso da fonte do texto.

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.

Retornar

Color|null: a cor de primeiro plano do texto.

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 um link, se ele estiver em parte do texto ou se houver vários links. Chame hasLink() para determinar se o texto não tem um link. 

const shape = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0];
const textLink = shape.getText().getTextStyle().getLink();
if (textLink != null) {
  Logger.log(`Shape text has a link of type: ${textLink.getLinkType()}`);
}

Retornar

Link|null: o link no texto.

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 um link no texto, false se não houver ou null se o link estiver em parte do texto ou se houver vinculação múltipla.

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

Retornar

Boolean|null: indica se há um link no texto.

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.

Retornar

Boolean|null: indica se o plano de fundo do texto é transparente.

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 for renderizado em negrito, false se não for ou null se houver vários estilos no texto.

Retornar

Boolean|null: se o texto é renderizado em negrito.

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.

Retornar

Boolean|null: se o texto está em itálico.

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.

Retornar

Boolean|null: indica se o texto está em letras maiúsculas pequenas.

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 estiver tachado, false se não estiver ou null se houver vários estilos no texto.

Retornar

Boolean|null: indica se o texto está tachado.

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.

Retornar

Boolean|null: se o texto está sublinhado.

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 uma Link.

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

const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
textRange.getTextStyle().removeLink();

Retornar

TextStyle: este TextStyle, para encadeamento.

setBackgroundColor(color)

Define a cor do plano de fundo do texto.

Parâmetros

NomeTipoDescrição
colorColorA cor de fundo a ser definida.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 com os valores RGB especificados de 0 a 255.

Parâmetros

NomeTipoDescrição
redIntegerO componente vermelho da cor.
greenIntegerO componente verde da cor.
blueIntegerO componente azul da cor.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 como a string de cor hexadecimal especificada.

A string hexadecimal precisa estar no formato "#RRGGBB". Por exemplo, a cor rosa é representada como

Parâmetros

NomeTipoDescrição
hexColorStringA string de cor hexadecimal.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 como o ThemeColorType especificado.

Parâmetros

NomeTipoDescrição
colorThemeColorTypeO tipo de cor do tema.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 do plano de fundo do texto como transparente.

Retornar

TextStyle: este TextStyle, para encadeamento.

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
offsetTextBaselineOffsetO deslocamento do valor de referência a ser definido.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 deve ser renderizado em negrito.

Parâmetros

NomeTipoDescrição
boldBooleanDefine se o texto será renderizado em negrito.

Retornar

TextStyle: este TextStyle, para encadeamento.

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
fontFamilyStringA família de fontes a ser definida.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 e a espessura da fonte do texto.

Parâmetros

NomeTipoDescrição
fontFamilyStringA família de fontes.
fontWeightIntegerA espessura da fonte.

Retornar

TextStyle: este TextStyle, para encadeamento.

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
fontSizeNumberO tamanho da fonte em pontos.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 de primeiro plano do texto.

Parâmetros

NomeTipoDescrição
foregroundColorColorA cor de primeiro plano a ser definida.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 de primeiro plano do texto com os valores RGB especificados de 0 a 255.

Parâmetros

NomeTipoDescrição
redIntegerO componente vermelho da cor.
greenIntegerO componente verde da cor.
blueIntegerO componente azul da cor.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 de primeiro plano do texto como a string de cor hexadecimal especificada.

A string hexadecimal precisa estar no formato "#RRGGBB". Por exemplo, a cor rosa é representada como

Parâmetros

NomeTipoDescrição
hexColorStringA string de cor hexadecimal.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 de primeiro plano do texto como o ThemeColorType especificado.

Parâmetros

NomeTipoDescrição
colorThemeColorTypeO tipo de cor do tema.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 está em itálico.

Parâmetros

NomeTipoDescrição
italicBooleanSe o texto vai ser renderizado em itálico.

Retornar

TextStyle: este TextStyle, para encadeamento.

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.

Ao definir um link, o estilo do texto muda para sublinhado e com uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como não é possível definir links em caracteres de nova linha, eles são ignorados no TextRange. 

// Set a link to the first slide of the presentation.
const presentation = SlidesApp.getActivePresentation();
const slide = presentation.getSlides()[0];
const textRange = slide.getShapes()[0].getText();
textRange.getTextStyle().setLinkSlide(0);

Parâmetros

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

Retornar

TextStyle: este TextStyle, para encadeamento.

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.

Ao definir um link, o estilo do texto muda para sublinhado e com uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como não é possível definir links em caracteres de nova linha, eles são ignorados no TextRange. 

// Set a link to the first slide of the presentation.
const presentation = SlidesApp.getActivePresentation();
const slide = presentation.getSlides()[0];
const textRange = slide.getShapes()[0].getText();
textRange.getTextStyle().setLinkSlide(slide);

Parâmetros

NomeTipoDescrição
slideSlideO Slide a ser vinculado.

Retornar

TextStyle: este TextStyle, para encadeamento.

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.

Ao definir um link, o estilo do texto muda para sublinhado e com uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como não é possível definir links em caracteres de nova linha, eles são ignorados no TextRange. 

// Set a link to the first slide of the presentation.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
textRange.getTextStyle().setLinkSlide(SlidesApp.SlidePosition.FIRST_SLIDE);

Parâmetros

NomeTipoDescrição
slidePositionSlidePositionO SlidePosition relativo.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 especificada.

Ao definir um link, o estilo do texto muda para sublinhado e com uma cor de primeiro plano ThemeColorType.HYPERLINK. Isso pode ser mudado usando setForegroundColor(hexColor) e setUnderline(underline).

Como não é possível definir links em caracteres de nova linha, eles são ignorados no TextRange. 

// Set a link to the URL.
const textRange = SlidesApp.getActivePresentation().getSlides()[0].getShapes()[0].getText();
textRange.getTextStyle().setLinkUrl('https://slides.google.com');

Parâmetros

NomeTipoDescrição
urlStringA string do URL.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 é renderizado em letras maiúsculas pequenas.

Parâmetros

NomeTipoDescrição
smallCapsBooleanSe o texto será renderizado em letras maiúsculas pequenas.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 está tachado.

Parâmetros

NomeTipoDescrição
strikethroughBooleanSe o texto será tachado.

Retornar

TextStyle: este TextStyle, para encadeamento.

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 está sublinhado.

Parâmetros

NomeTipoDescrição
underlineBooleanSe o texto será sublinhado.

Retornar

TextStyle: este TextStyle, para encadeamento.

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