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

Artículo
03/15/2023

Obtiene el texto sin formato de este intervalo. La propiedad Text es la propiedad predeterminada de la interfaz ITextRange .

Sintaxis

HRESULT GetText(
  BSTR *pbstr
);

Parámetros

pbstr

Tipo: BSTR*

El texto.

Valor devuelto

Tipo: HRESULT

Si el método se realiza correctamente, devuelve S_OK. Si se produce un error en el método, devuelve uno de los siguientes códigos de error. Para obtener más información sobre los códigos de error COM, vea Control de errores en COM.

Código devuelto	Descripción
E_INVALIDARG	pbstr es null.
E_OUTOFMEMORY	Memoria insuficiente para contener el texto.

Comentarios

El método ITextRange::GetText devuelve el texto sin formato en el intervalo. La propiedad Text es la propiedad predeterminada para ITextRange; Es decir, se invoca automáticamente para un intervalo, como en el siguiente ejemplo de Microsoft Visual Basic para Aplicaciones (VBA).

print range

Algunos de los ejemplos siguientes usan este hecho. El método ITextRange::SetText sustituye bstr por el texto del intervalo. Para procesar un solo carácter, la propiedad Char es más eficaz que la propiedad Text y no requiere crear un único intervalo de caracteres para almacenar un carácter. Si el intervalo está degenerado, la propiedad Text le permite insertar texto fácilmente. También puede eliminar el texto de un intervalo, como se muestra en los siguientes ejemplos de VBA.

range.delete

range = ""

Puede usar la propiedad Text para copiar texto sin formato de un lugar a otro, simplemente estableciendo un intervalo igual a otro. (Esto es bastante diferente de la propiedad Duplicate ; para obtener más información, vea ITextRange::GetDuplicate). La siguiente instrucción de ejemplo de Microsoft Visual Basic establece el texto del rango1 en el valor de range2.

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

Los rangos pueden estar en diferentes historias o incluso en diferentes aplicaciones. Sin embargo, implican copiar el texto primero en un BSTR y, a continuación, desde esa cadena a la ubicación de destino. Para grandes cantidades de texto, los métodos ITextRange::Copy e ITextRange::P aste pueden ser más rápidos, ya que pueden realizar la copia directamente desde el origen al destino y con cualquier formato admitido por el origen y el destino.

El texto devuelto por la propiedad Text se indica en Unicode. La marca de fin de párrafo puede ser dada por 0x2029 (separador de párrafo Unicode) o por retorno de carro/avance de línea (CR/LF) (0xd, 0xa) o por un retorno de carro por sí solo, dependiendo del archivo original. Microsoft Word usa un retorno de carro por sí solo, a menos que lea otra opción en un archivo, el Portapapeles o un IDataObject. El marcador de posición de un objeto incrustado lo proporciona el carácter especial, WCH_EMBEDDING, que tiene el valor Unicode 0xFFFC.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	tom.h
Archivo DLL	Msftedit.dll