Excel.TextRange class

Paquet:

excel

Contient le texte lié à une forme, en plus des propriétés et méthodes de manipulation du texte.

Extends

OfficeExtension.ClientObject

Remarques

Jeu d’API : ExcelApi 1.9

Utilisateur

• Excel.TextFrame : textRange

Propriétés

context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
font	Renvoie un ShapeFont objet qui représente les attributs de police de la plage de texte.
text	Représente le contenu de texte brut de la plage de texte.

Méthodes

getSubstring(start, length)	Renvoie un objet TextRange pour les caractères dans la plage de donnée.
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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TextRange est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TextRangeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

Détails de la propriété

context

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é

Excel.RequestContext

font

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

readonly font: Excel.ShapeFont;

Valeur de propriété

Excel.ShapeFont

Remarques

Jeu d’API : ExcelApi 1.9

text

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

text: string;

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApi 1.9

Détails de la méthode

getSubstring(start, length)

Renvoie un objet TextRange pour les caractères dans la plage de donnée.

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

Paramètres

start

number

Index en base zéro du premier caractère obtenu à partir de la plage de texte.

length

number

Facultatif. Nombre de caractères à renvoyer dans la nouvelle plage de texte. Si la longueur est omise, tous les caractères du début à la fin du dernier paragraphe de la plage de texte seront renvoyés.

Retours

Excel.TextRange

Remarques

Jeu d’API : ExcelApi 1.9

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

Paramètres

options

Excel.Interfaces.TextRangeLoadOptions

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

Retours

Excel.TextRange

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

Paramètres

propertyNames

string | string[]

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

Retours

Excel.TextRange

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

Excel.TextRange

set(properties, options)

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.TextRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties

Excel.Interfaces.TextRangeUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux 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 de propriétés 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.TextRange): void;

Paramètres

properties

Excel.TextRange

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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.TextRange est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.TextRangeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.TextRangeData;

Retours

Excel.Interfaces.TextRangeData