Class TextStyle

TextStyle

Style du texte

Les méthodes de lecture de cette classe renvoient null si le TextRange correspondant couvre plusieurs exécutions de texte, et ces exécutions ont des valeurs différentes pour la méthode de lecture appelée. Pour éviter cela, interrogez les styles de texte à l'aide des TextRange renvoyés par la méthode TextRange.getRuns().

Si vous utilisez des méthodes qui modifient la façon dont le texte s'adapte à une forme, tous les paramètres d'ajustement automatique appliqués aux styles de texte sont désactivés.

Méthodes

MéthodeType renvoyéBrève description
getBackgroundColor()ColorRenvoie la couleur d'arrière-plan du texte, ou null si le texte comporte plusieurs styles.
getBaselineOffset()TextBaselineOffsetRenvoie le décalage vertical du texte par rapport à sa position normale, ou null si le texte comporte plusieurs styles.
getFontFamily()StringRenvoie la famille de polices du texte, ou null si le texte comporte plusieurs styles.
getFontSize()NumberRenvoie la taille de police du texte en points, ou null si le texte comporte plusieurs styles.
getFontWeight()IntegerRenvoie l'épaisseur de police du texte, ou null si le texte comporte plusieurs styles.
getForegroundColor()ColorRenvoie la couleur de premier plan du texte, ou null si le texte présente plusieurs styles.
getLink()LinkRenvoie le Link au niveau du texte, ou null s'il n'y a pas de lien, s'il fait partie du texte ou s'il existe plusieurs liens.
hasLink()BooleanRenvoie true si le texte contient un lien, false dans le cas contraire, ou null si le lien se trouve dans le texte ou s'il existe plusieurs liens.
isBackgroundTransparent()BooleanRenvoie true si l'arrière-plan du texte est transparent, false dans le cas contraire ou null si le texte présente plusieurs styles.
isBold()BooleanRenvoie true si le texte s'affiche en gras, false dans le cas contraire ou null s'il existe plusieurs styles.
isItalic()BooleanRenvoie true si le texte est en italique, false dans le cas contraire ou null s'il existe plusieurs styles.
isSmallCaps()BooleanRenvoie true si le texte est en petites majuscules, false dans le cas contraire ou null s'il comporte plusieurs styles.
isStrikethrough()BooleanRenvoie true si le texte est barré, false dans le cas contraire ou null s'il existe plusieurs styles.
isUnderline()BooleanRenvoie true si le texte est souligné, false dans le cas contraire ou null s'il existe plusieurs styles.
removeLink()TextStyleSupprime un Link.
setBackgroundColor(color)TextStyleDéfinit la couleur d'arrière-plan du texte.
setBackgroundColor(red, green, blue)TextStyleDéfinit la couleur d'arrière-plan du texte sur les valeurs RVB données comprises entre 0 et 255.
setBackgroundColor(hexColor)TextStyleDéfinit la couleur d'arrière-plan du texte sur la chaîne de couleur hexadécimale donnée.
setBackgroundColor(color)TextStyleDéfinit la couleur d'arrière-plan du texte sur le ThemeColorType donné.
setBackgroundColorTransparent()TextStyleDéfinit la couleur d'arrière-plan du texte comme transparente.
setBaselineOffset(offset)TextStyleDéfinit le décalage vertical du texte par rapport à sa position normale.
setBold(bold)TextStyleDétermine si le texte doit être affiché en gras.
setFontFamily(fontFamily)TextStyleDéfinit la famille de polices du texte .
setFontFamilyAndWeight(fontFamily, fontWeight)TextStyleDéfinit la famille de polices et l'épaisseur du texte.
setFontSize(fontSize)TextStyleDéfinit la taille de police du texte, en points.
setForegroundColor(foregroundColor)TextStyleDéfinit la couleur du premier plan du texte.
setForegroundColor(red, green, blue)TextStyleDéfinit la couleur de premier plan du texte sur les valeurs RVB données comprises entre 0 et 255.
setForegroundColor(hexColor)TextStyleDéfinit la couleur de premier plan du texte sur la chaîne de couleurs hexadécimale donnée.
setForegroundColor(color)TextStyleDéfinit la couleur de premier plan du texte sur la valeur ThemeColorType donnée.
setItalic(italic)TextStyleDéfinit si le texte est mis en italique.
setLinkSlide(slideIndex)TextStyleDéfinit un Link sur le Slide donné à l'aide de l'index basé sur zéro de la diapositive.
setLinkSlide(slide)TextStyleDéfinit un Link sur le Slide donné, le lien est défini par l'ID de diapositive indiqué.
setLinkSlide(slidePosition)TextStyleDéfinit un Link sur le Slide donné en utilisant la position relative de la diapositive.
setLinkUrl(url)TextStyleDéfinit un Link sur la chaîne d'URL non vide donnée.
setSmallCaps(smallCaps)TextStyleDétermine si le texte s'affiche en petites majuscules.
setStrikethrough(strikethrough)TextStyleDétermine si le texte est rayé.
setUnderline(underline)TextStyleDétermine si le texte est souligné.

Documentation détaillée

getBackgroundColor()

Renvoie la couleur d'arrière-plan du texte, ou null si le texte comporte plusieurs styles.

Renvois

Color

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getBaselineOffset()

Renvoie le décalage vertical du texte par rapport à sa position normale, ou null si le texte comporte plusieurs styles.

Renvois

TextBaselineOffset

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getFontFamily()

Renvoie la famille de polices du texte, ou null si le texte comporte plusieurs styles.

Renvois

String

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getFontSize()

Renvoie la taille de police du texte en points, ou null si le texte comporte plusieurs styles.

Renvois

Number

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getFontWeight()

Renvoie l'épaisseur de police du texte, ou null si le texte comporte plusieurs styles.

La pondération est un multiple de 100 compris entre 100 et 900 inclus. Cette plage correspond aux valeurs numériques décrites dans la section 15.6 de la spécification CSS 2.1, et les valeurs non numériques ne sont pas autorisées. Les pondérations supérieures ou égales à 700 sont considérées en gras, auquel cas isBold() renvoie true. La valeur par défaut est 400 ("normal").

Renvois

Integer

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getForegroundColor()

Renvoie la couleur de premier plan du texte, ou null si le texte présente plusieurs styles.

Renvois

Color

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

Renvoie le Link au niveau du texte, ou null s'il n'y a pas de lien, s'il fait partie du texte ou s'il existe plusieurs liens. Appelez hasLink() pour déterminer si le texte ne comporte pas de lien. 

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

Renvois

Link

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

Renvoie true si le texte contient un lien, false dans le cas contraire, ou null si le lien se trouve dans le texte ou s'il existe plusieurs liens.

Les liens ne peuvent pas être définis sur des caractères de retour à la ligne. Par conséquent, si TextRange contient un caractère de retour à la ligne, cette méthode renvoie toujours null ou false.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isBackgroundTransparent()

Renvoie true si l'arrière-plan du texte est transparent, false dans le cas contraire ou null si le texte présente plusieurs styles.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isBold()

Renvoie true si le texte s'affiche en gras, false dans le cas contraire ou null s'il existe plusieurs styles.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isItalic()

Renvoie true si le texte est en italique, false dans le cas contraire ou null s'il existe plusieurs styles.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isSmallCaps()

Renvoie true si le texte est en petites majuscules, false dans le cas contraire ou null s'il comporte plusieurs styles.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isStrikethrough()

Renvoie true si le texte est barré, false dans le cas contraire ou null s'il existe plusieurs styles.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

isUnderline()

Renvoie true si le texte est souligné, false dans le cas contraire ou null s'il existe plusieurs styles.

Renvois

Boolean

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

Supprime un Link.

Lorsque vous supprimez un lien, la couleur de premier plan et le style de soulignement du lien hypertexte sont supprimés. Si possible, ces styles sont appliqués pour correspondre au texte qui précède le lien. 

text.getTextStyle().removeLink();

Renvois

TextStyle

setBackgroundColor(color)

Définit la couleur d'arrière-plan du texte.

Paramètres

NomTypeDescription
colorColor

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setBackgroundColor(red, green, blue)

Définit la couleur d'arrière-plan du texte sur les valeurs RVB données comprises entre 0 et 255.

Paramètres

NomTypeDescription
redInteger
greenInteger
blueInteger

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setBackgroundColor(hexColor)

Définit la couleur d'arrière-plan du texte sur la chaîne de couleur hexadécimale donnée.

La chaîne hexadécimale doit être au format "#RRGGBB". Par exemple, le rose est représenté par "#FFC0CB".

Paramètres

NomTypeDescription
hexColorString

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setBackgroundColor(color)

Définit la couleur d'arrière-plan du texte sur le ThemeColorType donné.

Paramètres

NomTypeDescription
colorThemeColorType

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setBackgroundColorTransparent()

Définit la couleur d'arrière-plan du texte comme transparente.

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setBaselineOffset(offset)

Définit le décalage vertical du texte par rapport à sa position normale.

Paramètres

NomTypeDescription
offsetTextBaselineOffset

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setBold(bold)

Détermine si le texte doit être affiché en gras.

Si vous modifiez la mise en gras du texte, l'épaisseur de la police utilisée pour le rendu est mise à jour.

Paramètres

NomTypeDescription
boldBoolean

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setFontFamily(fontFamily)

Définit la famille de polices du texte .

Paramètres

NomTypeDescription
fontFamilyString

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setFontFamilyAndWeight(fontFamily, fontWeight)

Définit la famille de polices et l'épaisseur du texte.

La pondération est un multiple de 100 compris entre 100 et 900 inclus. Cette plage correspond aux valeurs numériques décrites dans la section 15.6 de la spécification CSS 2.1, et les valeurs non numériques ne sont pas autorisées. Les pondérations supérieures ou égales à 700 sont considérées en gras, auquel cas isBold() renvoie true. La valeur par défaut est 400 ("normal").

Paramètres

NomTypeDescription
fontFamilyString
fontWeightInteger

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setFontSize(fontSize)

Définit la taille de police du texte, en points.

Paramètres

NomTypeDescription
fontSizeNumber

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setForegroundColor(foregroundColor)

Définit la couleur du premier plan du texte.

Paramètres

NomTypeDescription
foregroundColorColor

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setForegroundColor(red, green, blue)

Définit la couleur de premier plan du texte sur les valeurs RVB données comprises entre 0 et 255.

Paramètres

NomTypeDescription
redInteger
greenInteger
blueInteger

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setForegroundColor(hexColor)

Définit la couleur de premier plan du texte sur la chaîne de couleurs hexadécimale donnée.

La chaîne hexadécimale doit être au format "#RRGGBB". Par exemple, le rose est représenté par "#FFC0CB".

Paramètres

NomTypeDescription
hexColorString

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setForegroundColor(color)

Définit la couleur de premier plan du texte sur la valeur ThemeColorType donnée.

Paramètres

NomTypeDescription
colorThemeColorType

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setItalic(italic)

Définit si le texte est mis en italique.

Paramètres

NomTypeDescription
italicBoolean

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setLinkSlide(slideIndex)

Définit un Link sur le Slide donné à l'aide de l'index basé sur zéro de la diapositive.

En définissant un lien, vous modifiez le style du texte qui est souligné et dont la couleur de premier plan est ThemeColorType.HYPERLINK. Ce paramètre peut être modifié via setForegroundColor(hexColor) et setUnderline(underline).

Étant donné que les liens ne peuvent pas être définis sur des caractères de retour à la ligne, les caractères de retour à la ligne dans TextRange sont ignorés. 

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

Paramètres

NomTypeDescription
slideIndexIntegerIndice basé sur zéro de la diapositive.

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setLinkSlide(slide)

Définit un Link sur le Slide donné, le lien est défini par l'ID de diapositive indiqué.

En définissant un lien, vous modifiez le style du texte qui est souligné et dont la couleur de premier plan est ThemeColorType.HYPERLINK. Ce paramètre peut être modifié via setForegroundColor(hexColor) et setUnderline(underline).

Étant donné que les liens ne peuvent pas être définis sur des caractères de retour à la ligne, les caractères de retour à la ligne dans TextRange sont ignorés. 

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

Paramètres

NomTypeDescription
slideSlideLe Slide à associer.

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setLinkSlide(slidePosition)

Définit un Link sur le Slide donné en utilisant la position relative de la diapositive.

En définissant un lien, vous modifiez le style du texte qui est souligné et dont la couleur de premier plan est ThemeColorType.HYPERLINK. Ce paramètre peut être modifié via setForegroundColor(hexColor) et setUnderline(underline).

Étant donné que les liens ne peuvent pas être définis sur des caractères de retour à la ligne, les caractères de retour à la ligne dans TextRange sont ignorés. 

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

Paramètres

NomTypeDescription
slidePositionSlidePositionLa valeur SlidePosition relative.

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setLinkUrl(url)

Définit un Link sur la chaîne d'URL non vide donnée.

En définissant un lien, vous modifiez le style du texte qui est souligné et dont la couleur de premier plan est ThemeColorType.HYPERLINK. Ce paramètre peut être modifié via setForegroundColor(hexColor) et setUnderline(underline).

Étant donné que les liens ne peuvent pas être définis sur des caractères de retour à la ligne, les caractères de retour à la ligne dans TextRange sont ignorés. 

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

Paramètres

NomTypeDescription
urlStringChaîne d'URL.

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setSmallCaps(smallCaps)

Détermine si le texte s'affiche en petites majuscules.

Paramètres

NomTypeDescription
smallCapsBoolean

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setStrikethrough(strikethrough)

Détermine si le texte est rayé.

Paramètres

NomTypeDescription
strikethroughBoolean

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setUnderline(underline)

Détermine si le texte est souligné.

Paramètres

NomTypeDescription
underlineBoolean

Renvois

TextStyle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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