Partager via

PowerPoint.TextFrame class

  • Référence
Paquet:
powerpoint

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

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Selects the first 10 characters of the selected shape.
await PowerPoint.run(async (context) => {
  const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
  const shapeCount = shapes.getCount();
  await context.sync();
  if (shapeCount.value !== 1) {
    console.warn("You must select only one shape with text in it.");
    return;
  }
  const shape: PowerPoint.Shape = shapes.getItemAt(0);
  const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
  await context.sync();
  if (textFrame.hasText != true) {
    console.warn("You must select only one shape with text in it.");
    return;
  }
  const textRange: PowerPoint.TextRange = textFrame.textRange;
  textRange.load("text");
  await context.sync();
  if (textRange.text.length < 10) {
    console.warn("You must select only one shape with at least 10 characters in it.");
    return;
  }
  const textRange10 = textRange.getSubstring(0, 10);
  textRange10.setSelected();
  await context.sync();
});

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

Représente la marge gauche, en points du cadre du texte.
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 , voir PowerPoint.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, voir PowerPoint.TextVerticalAlignment .
wordWrap

Détermine si les lignes se cassent automatiquement pour insérer du texte à l’intérieur de la forme.

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.
toJSON()

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 PowerPoint.TextFrame est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.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: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Valeur de propriété

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

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

bottomMargin

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

bottomMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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é

PowerPoint.RequestContext

hasText

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

readonly hasText: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

leftMargin

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

leftMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

rightMargin

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

rightMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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 , voir PowerPoint.TextRange .

readonly textRange: PowerPoint.TextRange;

Valeur de propriété

PowerPoint.TextRange

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

topMargin

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

topMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

verticalAlignment

Représente l’alignement vertical pour le style. Pour plus d’informations, voir PowerPoint.TextVerticalAlignment .

verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";

Valeur de propriété

PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

wordWrap

Détermine si les lignes se cassent automatiquement pour insérer du texte à l’intérieur de la forme.

wordWrap: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Détails de la méthode

deleteText()

Supprime tout le texte dans la textframe.

deleteText(): void;

Retours

void

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;

Paramètres

options
PowerPoint.Interfaces.TextFrameLoadOptions

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

Retours

PowerPoint.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[]): PowerPoint.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

PowerPoint.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;
        }): PowerPoint.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

PowerPoint.TextFrame

toJSON()

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 PowerPoint.TextFrame est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant PowerPoint.Interfaces.TextFrameDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): PowerPoint.Interfaces.TextFrameData;

Retours

PowerPoint.Interfaces.TextFrameData