Метод ITextRange::GetText (tom.h)

Статья
08/26/2023

Возвращает обычный текст в этом диапазоне. Свойство Text является свойством по умолчанию интерфейса ITextRange .

Синтаксис

HRESULT GetText(
  BSTR *pbstr
);

Параметры

pbstr

Тип: BSTR*

Текст.

Возвращаемое значение

Тип: HRESULT

Если метод завершается успешно, он возвращает S_OK. Если метод завершается сбоем, он возвращает один из следующих кодов ошибок. Дополнительные сведения о кодах ошибок COM см. в разделе Обработка ошибок в COM.

Код возврата	Описание
E_INVALIDARG	pbstr имеет значение NULL.
E_OUTOFMEMORY	Недостаточно памяти для хранения текста.

Метод ITextRange::GetText возвращает обычный текст в диапазоне. Свойство Text является свойством по умолчанию для ITextRange; Это значит, что он автоматически вызывается для диапазона, как показано в следующем примере Microsoft Visual Basic для приложений (VBA).

print range

В некоторых примерах ниже используется этот факт. Метод ITextRange::SetText заменяет bstr для текста диапазона. Для обработки одного символа свойство Char более эффективно, чем свойство Text, и не требует создания одного диапазона символов для хранения символов. Если диапазон является вырожденным, свойство Text позволяет легко вставить текст. Вы также можете удалить текст в диапазоне, как показано в следующих примерах VBA.

range.delete

range = ""

Свойство Text можно использовать для копирования обычного текста из одного места в другое, просто задав один диапазон равным другому. (Это сильно отличается от свойства Duplicate . Дополнительные сведения см. в разделе ITextRange::GetDuplicate. В следующем примере инструкции Microsoft Visual Basic текст в диапазоне1 присваивается тексту в диапазоне 2.

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

Диапазоны могут находиться в разных историях или даже в разных приложениях. Однако они подразумевают копирование текста сначала в BSTR , а затем из этой строки в целевое расположение. Для больших объемов текста методы ITextRange::Copy и ITextRange::P aste могут выполняться быстрее, так как они могут выполнять копирование непосредственно из источника в целевой объект и в любом формате, поддерживаемом источником и целевым объектом.

Текст, возвращаемый свойством Text, предоставляется в Юникоде. Знак конца абзаца может быть задан 0x2029 (разделитель абзаца Юникода) или возврат каретки или перевода строки (CR/LF) (0xd, 0xa) или только возвратом каретки, в зависимости от исходного файла. Microsoft Word использует только возврат каретки, если не считывает другой вариант из файла, буфера обмена или IDataObject. Заполнитель для внедренного объекта присваивается специальным символом WCH_EMBEDDING, который имеет значение Юникода 0xFFFC.

Требования

Требование	Значение
Минимальная версия клиента	Windows Vista [только классические приложения]
Минимальная версия сервера	Windows Server 2003 [только классические приложения]
Целевая платформа	Windows
Header	tom.h
DLL	Msftedit.dll