Excel.TextFrame class

  • Référence
Paquet:
excel

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

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Propriétés

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

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

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
hasText

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

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

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

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

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

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

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

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 Excel.TextRange .
topMargin

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

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

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

Méthodes

deleteText()

Supprime tout le texte dans la textframe.
load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.TextFrame d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.TextFrameDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

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.

autoSizeSetting: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Valeur de propriété

Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

bottomMargin

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

bottomMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

hasText

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

readonly hasText: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

horizontalAlignment

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

horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";

Valeur de propriété

Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

horizontalOverflow

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

horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";

Valeur de propriété

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

leftMargin

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

leftMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

orientation

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

orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";

Valeur de propriété

Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

readingOrder

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

readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";

Valeur de propriété

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

rightMargin

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

rightMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

textRange

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 Excel.TextRange .

readonly textRange: Excel.TextRange;

Valeur de propriété

Excel.TextRange

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

topMargin

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

topMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

verticalAlignment

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

verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";

Valeur de propriété

Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

verticalOverflow

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

verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";

Valeur de propriété

Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Détails de la méthode

deleteText()

Supprime tout le texte dans la textframe.

deleteText(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.getItem("Textbox");
    textbox.textFrame.deleteText();
    await context.sync();
});

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame;

Paramètres

options
Excel.Interfaces.TextFrameLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.TextFrame

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.TextFrame;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.TextFrame

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.TextFrame;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.TextFrame

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.TextFrameUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.TextFrame): void;

Paramètres

properties
Excel.TextFrame

Retours

void

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet Excel.TextFrame d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.TextFrameDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.TextFrameData;

Retours

Excel.Interfaces.TextFrameData