Método ITextRangeProvider::ExpandToEnclosingUnit (uiautomationcore.h)

Normaliza o intervalo de texto pela unidade de texto especificada. O intervalo será expandido se for menor que a unidade especificada ou encurtado se for maior que a unidade especificada.

Sintaxe

HRESULT ExpandToEnclosingUnit(
  [in] TextUnit unit
);

Parâmetros

[in] unit

Tipo: TextUnit

O tipo de unidades de texto, como caractere, palavra, parágrafo e assim por diante.

Valor retornado

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Comentários

Aplicativos cliente, como leitores de tela, usam esse método para recuperar a palavra, a frase ou o parágrafo completo que existe no ponto de inserção ou na posição do cursor.

Apesar do nome, o método ITextRangeProvider::ExpandToEnclosingUnit não necessariamente expande um intervalo de texto. Em vez disso, ele "normaliza" um intervalo de texto movendo os pontos de extremidade para que o intervalo engloba a unidade de texto especificada. O intervalo será expandido se for menor que a unidade especificada ou encurtado se for maior que a unidade especificada. Se o intervalo já for uma quantidade exata das unidades especificadas, ele permanecerá inalterado. É fundamental que o método ExpandToEnclosingUnit sempre normalize os intervalos de texto de maneira consistente; caso contrário, outros aspectos da manipulação de intervalo de texto por unidade de texto seriam imprevisíveis. O diagrama a seguir mostra como ExpandToEnclosingUnit normaliza um intervalo de texto movendo os pontos de extremidade do intervalo.

ExpandToEnclosingUnit assume como padrão a próxima maior unidade de texto com suporte se a unidade de texto especificada não tiver suporte no controle. A ordem, da menor unidade para a maior, é a seguinte:

• Caractere
• Formato
• Word
• Linha
• Paragraph
• Página
• Documento

ExpandToEnclosingUnit respeita o texto visível e oculto.

Comportamento do intervalo quando a unidade é TextUnit::Format

TextUnit::Format como um valor unitário posiciona o limite de um intervalo de texto para expandir ou mover o intervalo com base em atributos de texto compartilhado (formato) do texto dentro do intervalo. No entanto, o uso da unidade de texto de formato não deve mover ou expandir um intervalo de texto através do limite de um objeto inserido, como uma imagem ou hiperlink. Para obter mais informações, consulte Unidades de Texto de Automação da Interface do Usuário ou Texto e Padrões de Controle TextRange.

Requisitos

Cliente mínimo com suporte	Windows XP [aplicativos da área de trabalho | aplicativos UWP]
Servidor mínimo com suporte	Windows Server 2003 [aplicativos da área de trabalho | Aplicativos UWP]
Plataforma de Destino	Windows
Cabeçalho	uiautomationcore.h (include UIAutomation.h)

Confira também

Conceitual

ITextProvider

ITextRangeProvider

Referência

Padrões de controle Text e TextRange

Visão Geral dos Provedores de Automação de Interface do Usuário