Excel.TextFrame class

Les paramètres de dimensionnement automatique du bloc 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é

Remarques

Jeu d’API : ExcelApi 1.9

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

bottomMargin: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Indique si le bloc de texte contient du texte.

readonly hasText: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente l’alignement horizontal pour le style. Pour Excel.ShapeTextHorizontalAlignment plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente le type de débordement horizontal du cadre du texte. Pour Excel.ShapeTextHorizontalOverflow plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

leftMargin: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente l’angle d’orientation du texte pour le bloc de texte. Pour Excel.ShapeTextOrientation plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

rightMargin: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

readonly textRange: Excel.TextRange;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

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

topMargin: number;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente l’alignement vertical pour le style. Pour Excel.ShapeTextVerticalAlignment plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Représente le type de débordement vertical du cadre du texte. Pour Excel.ShapeTextVerticalOverflow plus de détails.

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

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

Supprime tout le texte dans la textframe.

deleteText(): void;

Retours

Remarques

Jeu 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();
});

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

Retours

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

Retours

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

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

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

Paramètres

Retours

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

Retours

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

toJSON(): Excel.Interfaces.TextFrameData;

Retours