PowerPoint.TextRange class
Contient le texte lié à une forme, en plus des propriétés et méthodes de manipulation du texte.
- Extends
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();
});
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| font | Renvoie un |
| length | Obtient ou définit la longueur de la plage que cela |
| paragraph |
Représente le format de paragraphe de la plage de texte. Pour plus d’informations , voir PowerPoint.ParagraphFormat . |
| start | 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 |
| text | Représente le contenu de texte brut de la plage de texte. |
Méthodes
| get |
Renvoie l’objet PowerPoint.TextFrame parent qui contient ce |
| get |
Retourne un |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| set |
Sélectionne cette option |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
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é
font
Renvoie un ShapeFont objet qui représente les attributs de police de la plage de texte.
readonly font: PowerPoint.ShapeFont;Valeur de 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();
});
length
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 propriété
number
Remarques
paragraphFormat
Représente le format de paragraphe de la plage de texte. Pour plus d’informations , voir PowerPoint.ParagraphFormat .
readonly paragraphFormat: PowerPoint.ParagraphFormat;Valeur de propriété
Remarques
start
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 propriété
number
Remarques
text
Représente le contenu de texte brut de la plage de texte.
text: string;Valeur de propriété
string
Remarques
Détails de la méthode
getParentTextFrame()
Renvoie l’objet PowerPoint.TextFrame parent qui contient ce TextRange.
getParentTextFrame(): PowerPoint.TextFrame;Retours
Remarques
getSubstring(start, length)
Retourne un TextRange objet pour la sous-chaîne dans la plage donnée.
getSubstring(start: number, length?: number): PowerPoint.TextRange;Paramètres
- start
-
number
Index de base zéro du premier caractère à obtenir à partir de la plage de texte.
- length
-
number
Optional. Nombre de caractères à retourner dans la nouvelle plage de texte. Si length est omis, tous les caractères du début à la fin du dernier paragraphe de la plage de texte sont retournés.
Retours
Remarques
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.TextRangeLoadOptions): PowerPoint.TextRange;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
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.TextRange;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
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.TextRange;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
setSelected()
Sélectionne cette option TextRange dans l’affichage actuel.
setSelected(): void;Retours
void
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();
});
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.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;