PowerPoint.TextRange class

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 la propriété

Renvoie un ShapeFont objet qui représente les attributs de police de la plage de texte.

readonly font: PowerPoint.ShapeFont;

Valeur de la propriété

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

// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.font.color = "green";
  await context.sync();
});

Retourne une collection de liens hypertexte qui existent sur ce TextRange.

readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

Obtient ou définit la longueur de la plage que cela TextRange représente. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou si la valeur est supérieure à la longueur du texte disponible à partir du point de départ.

length: number;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Représente le format de paragraphe de la plage de texte. Pour plus d’informations , voir PowerPoint.ParagraphFormat .

readonly paragraphFormat: PowerPoint.ParagraphFormat;

Valeur de la propriété

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

// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
  await context.sync();

  console.log("Font properties of selected text range:");
  console.log(`\tallCaps: ${textRange.font.allCaps}`);
  console.log(`\tbold: ${textRange.font.bold}`);
  console.log(`\tcolor: ${textRange.font.color}`);
  console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
  console.log(`\titalic: ${textRange.font.italic}`);
  console.log(`\tname: ${textRange.font.name}`);
  console.log(`\tsize: ${textRange.font.size}`);
  console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
  console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
  console.log(`\tsubscript: ${textRange.font.subscript}`);
  console.log(`\tsuperscript: ${textRange.font.superscript}`);
  console.log(`\tunderline: ${textRange.font.underline}`);

  console.log("Paragraph format properties of selected text range:");
  console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
  console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});

Obtient ou définit l’index de base zéro, par rapport au cadre de texte parent, pour la position de départ de la plage qu’il TextRange représente. Lève une exception lorsqu’elle InvalidArgument est définie avec une valeur négative ou si la valeur est supérieure à la longueur du texte.

start: number;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Représente le contenu de texte brut de la plage de texte.

text: string;

Valeur de la propriété

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

Renvoie l’objet PowerPoint.TextFrame parent qui contient ce TextRange.

getParentTextFrame(): PowerPoint.TextFrame;

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

Retourne un TextRange objet pour la sous-chaîne dans la plage donnée.

getSubstring(start: number, length?: number): PowerPoint.TextRange;

Paramètres

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.4 ]

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

Paramètres

Retourne

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

Paramètres

Retourne

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

Paramètres

Retourne

Définit un lien hypertexte sur ce TextRange avec les options spécifiées. Cela supprime tous les liens hypertexte existants sur ce TextRange.

setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;

Paramètres

Retourne

Objet PowerPoint.Hyperlink nouvellement créé.

Remarques

[ Ensemble d’API : PowerPointApi 1.10 ]

Sélectionne cette option TextRange dans l’affichage actuel.

setSelected(): void;

Retourne

Remarques

[ Ensemble d’API : PowerPointApi 1.5 ]

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

...

// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
  const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedTextSlideSelection[0]);
  const shape1: PowerPoint.Shape = slide1.shapes.getItem(savedTextShapeSelection[0]);
  const textRange: PowerPoint.TextRange = shape1.textFrame.textRange.getSubstring(
    savedTextTextRangeStart,
    savedTextTextRangeLength,
  );
  textRange.setSelected();
  await context.sync();
});

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

toJSON(): PowerPoint.Interfaces.TextRangeData;

Retourne