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

Artigo
08/26/2023

Obtém o texto sem formatação neste intervalo. A propriedade Text é a propriedade padrão da interface ITextRange .

Sintaxe

HRESULT GetText(
  BSTR *pbstr
);

Parâmetros

pbstr

Tipo: BSTR*

O texto.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Se o método falhar, ele retornará um dos seguintes códigos de erro. Para obter mais informações sobre códigos de erro COM, consulte Tratamento de erros em COM.

Código de retorno	Descrição
E_INVALIDARG	pbstr é nulo.
E_OUTOFMEMORY	Memória insuficiente para manter o texto.

Comentários

O método ITextRange::GetText retorna o texto sem formatação no intervalo. A propriedade Text é a propriedade padrão para ITextRange; ou seja, ele é invocado automaticamente para um intervalo, como no exemplo do Microsoft Visual Basic for Applications (VBA) a seguir.

print range

Alguns dos exemplos abaixo usam esse fato. O método ITextRange::SetText substitui bstr pelo texto do intervalo. Para processar um único caractere, a propriedade Char é mais eficiente do que a propriedade Text e não requer a criação de um único intervalo de caracteres para armazenar um caractere. Se o intervalo for degenerado, a propriedade Text permitirá que você insira texto facilmente. Você também pode excluir o texto em um intervalo, conforme mostrado nos exemplos de VBA a seguir.

range.delete

range = ""

Você pode usar a propriedade Text para copiar texto sem formatação de um local para outro, simplesmente definindo um intervalo igual a outro. (Isso é bem diferente da propriedade Duplicate ; para obter mais informações, consulte ITextRange::GetDuplicate). A instrução de exemplo do Microsoft Visual Basic a seguir define o texto no intervalo1 como aquele no intervalo2.

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

Os intervalos podem estar em histórias diferentes ou até mesmo em aplicativos diferentes. No entanto, eles implicam copiar o texto primeiro para um BSTR e, em seguida, dessa cadeia de caracteres para o local de destino. Para grandes quantidades de texto, os métodos ITextRange::Copy e ITextRange::P aste podem ser mais rápidos, pois podem executar a cópia diretamente da origem para o destino e com qualquer formato compatível com a origem e o destino.

O texto retornado pela propriedade Text é dado em Unicode. A marca de fim de parágrafo pode ser fornecida por 0x2029 (separador de parágrafo Unicode) ou por cr/LF (retorno de carro/alimentação de linha) (0xd, 0xa) ou por um retorno de carro sozinho, dependendo do arquivo original. O Microsoft Word usa um retorno de carro sozinho, a menos que leia outra opção de um arquivo, da área de transferência ou de um IDataObject. O espaço reservado para um objeto inserido é fornecido pelo caractere especial , WCH_EMBEDDING, que tem o valor Unicode 0xFFFC.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tom.h
DLL	Msftedit.dll