Méthode ITextRange ::GetText (tom.h)

Article
03/03/2024

Obtient le texte brut de cette plage. La propriété Text est la propriété par défaut de l’interface ITextRange .

Syntaxe

HRESULT GetText(
  BSTR *pbstr
);

Paramètres

pbstr

Type : BSTR*

Texte.

Valeur retournée

Type : HRESULT

Si la méthode réussit, elle retourne S_OK. Si la méthode échoue, elle retourne l’un des codes d’erreur suivants. Pour plus d’informations sur les codes d’erreur COM, consultez Gestion des erreurs dans COM.

Code de retour	Description
E_INVALIDARG	pbstr a la valeur Null.
E_OUTOFMEMORY	Mémoire insuffisante pour contenir le texte.

Remarques

La méthode ITextRange ::GetText retourne le texte brut dans la plage. La propriété Text est la propriété par défaut pour ITextRange ; Autrement dit, il est appelé automatiquement pour une plage, comme dans l’exemple Microsoft Visual Basic pour Applications (VBA) suivant.

print range

Certains des exemples ci-dessous utilisent ce fait. La méthode ITextRange ::SetText remplace bstr par le texte de plage. Pour le traitement d’un caractère unique, la propriété Char est plus efficace que la propriété Text et ne nécessite pas la création d’une plage de caractères unique pour le stockage d’un caractère. Si la plage est dégénérée, la propriété Text vous permet d’insérer facilement du texte. Vous pouvez également supprimer le texte d’une plage, comme illustré dans les exemples VBA suivants.

range.delete

range = ""

Vous pouvez utiliser la propriété Text pour copier du texte brut d’un emplacement à un autre, en définissant simplement une plage égale à une autre. (Ceci est très différent de la propriété Duplicate ; pour plus d’informations, consultez ITextRange ::GetDuplicate). L’exemple d’instruction Microsoft Visual Basic suivant définit le texte de la plage1 sur celui de la plage2.

range1 = range2 ' Replace range1's text by range2's

Les plages peuvent être dans différentes histoires ou même dans différentes applications. Toutefois, elles impliquent de copier le texte d’abord dans un BSTR , puis de cette chaîne à l’emplacement cible. Pour les grandes quantités de texte, les méthodes ITextRange ::Copy et ITextRange ::P aste peuvent être plus rapides, car elles peuvent effectuer la copie directement de la source vers la cible et avec n’importe quel format pris en charge par la source et la cible.

Le texte retourné par la propriété Text est donné en Unicode. La marque de fin de paragraphe peut être donnée par 0x2029 (séparateur de paragraphe Unicode), ou par retour chariot/flux de ligne (CR/LF) (0xd, 0xa), ou par un retour chariot seul, selon le fichier d’origine. Microsoft Word utilise un retour chariot seul, sauf s’il lit un autre choix dans à partir d’un fichier, du Presse-papiers ou d’un IDataObject. L’espace réservé pour un objet incorporé est donné par le caractère spécial , WCH_EMBEDDING, qui a la valeur Unicode 0xFFFC.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	tom.h
DLL	Msftedit.dll