ExcelScript.TextFrame interface

Paquet:

ExcelScript

Représente le cadre de texte d’un objet de forme.

Remarques

Exemples

/**
 * This script creates a star shape with the value from cell A1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the value of A1 from the worksheet named Sheet1.
  const sheet = workbook.getWorksheet("Sheet1");
  const value = sheet.getRange("A1").getValue();

  // Create a Shape object that looks like a 5-pointed star.
  const star = sheet.addGeometricShape(ExcelScript.GeometricShapeType.star5);

  // Set the text of star and make sure the shape fits the text.
  const textFrame: ExcelScript.TextFrame = star.getTextFrame();
  textFrame.getTextRange().setText(value.toString());
  textFrame.setAutoSizeSetting(ExcelScript.ShapeAutoSize.autoSizeShapeToFitText);
}

Méthodes

deleteText()	Supprime tout le texte dans la textframe.
getAutoSizeSetting()	Paramètres de dimensionnement automatique pour le cadre de texte. Un bloc de texte peut être configuré pour ajuster automatiquement le texte pour le cadre du texte, pour ajuster automatiquement le bloc de texte au texte ou de ne pas effectuer tout problème de dimensionnement automatique.
getBottomMargin()	Représente la marge bas, en points du cadre du texte.
getHasText()	Spécifie si le cadre de texte contient du texte.
getHorizontalAlignment()	Représente l’alignement horizontal pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalAlignment .
getHorizontalOverflow()	Représente le type de débordement horizontal du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalOverflow .
getLeftMargin()	Représente la marge gauche, en points du cadre du texte.
getOrientation()	Représente l’angle vers lequel le texte est orienté pour le cadre de texte. Pour plus d’informations, consultez ExcelScript.ShapeTextOrientation .
getReadingOrder()	Représente l’ordre de lecture du cadre texte gauche à droite ou de droite à gauche. Pour plus d’informations, consultez ExcelScript.ShapeTextReadingOrder .
getRightMargin()	Représente la marge droite, en points du cadre du texte.
getTextRange()	Représente le texte lié à une forme, en plus des propriétés et des méthodes de manipulation du texte. Pour plus d’informations, consultez ExcelScript.TextRange .
getTopMargin()	Représente la marge du haut, en points du cadre du texte.
getVerticalAlignment()	Représente l’alignement vertical pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalAlignment .
getVerticalOverflow()	Représente le type de débordement vertical du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalOverflow .
setAutoSizeSetting(autoSizeSetting)	Paramètres de dimensionnement automatique pour le cadre de texte. Un bloc de texte peut être configuré pour ajuster automatiquement le texte pour le cadre du texte, pour ajuster automatiquement le bloc de texte au texte ou de ne pas effectuer tout problème de dimensionnement automatique.
setBottomMargin(bottomMargin)	Représente la marge bas, en points du cadre du texte.
setHorizontalAlignment(horizontalAlignment)	Représente l’alignement horizontal pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalAlignment .
setHorizontalOverflow(horizontalOverflow)	Représente le type de débordement horizontal du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalOverflow .
setLeftMargin(leftMargin)	Représente la marge gauche, en points du cadre du texte.
setOrientation(orientation)	Représente l’angle vers lequel le texte est orienté pour le cadre de texte. Pour plus d’informations, consultez ExcelScript.ShapeTextOrientation .
setReadingOrder(readingOrder)	Représente l’ordre de lecture du cadre texte gauche à droite ou de droite à gauche. Pour plus d’informations, consultez ExcelScript.ShapeTextReadingOrder .
setRightMargin(rightMargin)	Représente la marge droite, en points du cadre du texte.
setTopMargin(topMargin)	Représente la marge du haut, en points du cadre du texte.
setVerticalAlignment(verticalAlignment)	Représente l’alignement vertical pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalAlignment .
setVerticalOverflow(verticalOverflow)	Représente le type de débordement vertical du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalOverflow .

Détails de la méthode

deleteText()

Supprime tout le texte dans la textframe.

deleteText(): void;

Retours

void

getAutoSizeSetting()

Paramètres de dimensionnement automatique pour le cadre de texte. Un bloc de texte peut être configuré pour ajuster automatiquement le texte pour le cadre du texte, pour ajuster automatiquement le bloc de texte au texte ou de ne pas effectuer tout problème de dimensionnement automatique.

getAutoSizeSetting(): ShapeAutoSize;

Retours

ExcelScript.ShapeAutoSize

getBottomMargin()

Représente la marge bas, en points du cadre du texte.

getBottomMargin(): number;

Retours

number

getHasText()

Spécifie si le cadre de texte contient du texte.

getHasText(): boolean;

Retours

boolean

getHorizontalAlignment()

Représente l’alignement horizontal pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalAlignment .

getHorizontalAlignment(): ShapeTextHorizontalAlignment;

Retours

ExcelScript.ShapeTextHorizontalAlignment

getHorizontalOverflow()

Représente le type de débordement horizontal du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalOverflow .

getHorizontalOverflow(): ShapeTextHorizontalOverflow;

Retours

ExcelScript.ShapeTextHorizontalOverflow

getLeftMargin()

Représente la marge gauche, en points du cadre du texte.

getLeftMargin(): number;

Retours

number

getOrientation()

Représente l’angle vers lequel le texte est orienté pour le cadre de texte. Pour plus d’informations, consultez ExcelScript.ShapeTextOrientation .

getOrientation(): ShapeTextOrientation;

Retours

ExcelScript.ShapeTextOrientation

getReadingOrder()

Représente l’ordre de lecture du cadre texte gauche à droite ou de droite à gauche. Pour plus d’informations, consultez ExcelScript.ShapeTextReadingOrder .

getReadingOrder(): ShapeTextReadingOrder;

Retours

ExcelScript.ShapeTextReadingOrder

getRightMargin()

Représente la marge droite, en points du cadre du texte.

getRightMargin(): number;

Retours

number

getTextRange()

Représente le texte lié à une forme, en plus des propriétés et des méthodes de manipulation du texte. Pour plus d’informations, consultez ExcelScript.TextRange .

getTextRange(): TextRange;

Retours

ExcelScript.TextRange

getTopMargin()

Représente la marge du haut, en points du cadre du texte.

getTopMargin(): number;

Retours

number

getVerticalAlignment()

Représente l’alignement vertical pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalAlignment .

getVerticalAlignment(): ShapeTextVerticalAlignment;

Retours

ExcelScript.ShapeTextVerticalAlignment

getVerticalOverflow()

Représente le type de débordement vertical du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalOverflow .

getVerticalOverflow(): ShapeTextVerticalOverflow;

Retours

ExcelScript.ShapeTextVerticalOverflow

setAutoSizeSetting(autoSizeSetting)

Paramètres de dimensionnement automatique pour le cadre de texte. Un bloc de texte peut être configuré pour ajuster automatiquement le texte pour le cadre du texte, pour ajuster automatiquement le bloc de texte au texte ou de ne pas effectuer tout problème de dimensionnement automatique.

setAutoSizeSetting(autoSizeSetting: ShapeAutoSize): void;

Paramètres

autoSizeSetting

ExcelScript.ShapeAutoSize

Retours

void

setBottomMargin(bottomMargin)

Représente la marge bas, en points du cadre du texte.

setBottomMargin(bottomMargin: number): void;

Paramètres

bottomMargin

number

Retours

void

setHorizontalAlignment(horizontalAlignment)

Représente l’alignement horizontal pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalAlignment .

setHorizontalAlignment(
            horizontalAlignment: ShapeTextHorizontalAlignment
        ): void;

Paramètres

horizontalAlignment

ExcelScript.ShapeTextHorizontalAlignment

Retours

void

setHorizontalOverflow(horizontalOverflow)

Représente le type de débordement horizontal du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextHorizontalOverflow .

setHorizontalOverflow(
            horizontalOverflow: ShapeTextHorizontalOverflow
        ): void;

Paramètres

horizontalOverflow

ExcelScript.ShapeTextHorizontalOverflow

Retours

void

setLeftMargin(leftMargin)

Représente la marge gauche, en points du cadre du texte.

setLeftMargin(leftMargin: number): void;

Paramètres

leftMargin

number

Retours

void

setOrientation(orientation)

Représente l’angle vers lequel le texte est orienté pour le cadre de texte. Pour plus d’informations, consultez ExcelScript.ShapeTextOrientation .

setOrientation(orientation: ShapeTextOrientation): void;

Paramètres

orientation

ExcelScript.ShapeTextOrientation

Retours

void

setReadingOrder(readingOrder)

Représente l’ordre de lecture du cadre texte gauche à droite ou de droite à gauche. Pour plus d’informations, consultez ExcelScript.ShapeTextReadingOrder .

setReadingOrder(readingOrder: ShapeTextReadingOrder): void;

Paramètres

readingOrder

ExcelScript.ShapeTextReadingOrder

Retours

void

setRightMargin(rightMargin)

Représente la marge droite, en points du cadre du texte.

setRightMargin(rightMargin: number): void;

Paramètres

rightMargin

number

Retours

void

setTopMargin(topMargin)

Représente la marge du haut, en points du cadre du texte.

setTopMargin(topMargin: number): void;

Paramètres

topMargin

number

Retours

void

setVerticalAlignment(verticalAlignment)

Représente l’alignement vertical pour le style. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalAlignment .

setVerticalAlignment(
            verticalAlignment: ShapeTextVerticalAlignment
        ): void;

Paramètres

verticalAlignment

ExcelScript.ShapeTextVerticalAlignment

Retours

void

setVerticalOverflow(verticalOverflow)

Représente le type de débordement vertical du cadre du texte. Pour plus d’informations, consultez ExcelScript.ShapeTextVerticalOverflow .

setVerticalOverflow(verticalOverflow: ShapeTextVerticalOverflow): void;

Paramètres

verticalOverflow

ExcelScript.ShapeTextVerticalOverflow

Retours

void