Excel.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 : ExcelApi 1.9 ]
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 |
| text | Représente le contenu de texte brut de la plage de texte. |
Méthodes
| get |
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 |
| 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(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou 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 |
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: Excel.ShapeFont;Valeur de propriété
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
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 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?: Excel.Interfaces.TextRangeLoadOptions): Excel.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[]): Excel.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;
}): 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
set(properties, options)
Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties: Interfaces.TextRangeUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.TextRangeUpdateData
Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des 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 properties 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.TextRangeDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.TextRangeData;