ITextRangeProvider.ExpandToEnclosingUnit(TextUnit) Method

public:
 void ExpandToEnclosingUnit(System::Windows::Automation::Text::TextUnit unit);

public void ExpandToEnclosingUnit (System.Windows.Automation.Text.TextUnit unit);

abstract member ExpandToEnclosingUnit : System.Windows.Automation.Text.TextUnit -> unit

Public Sub ExpandToEnclosingUnit (unit As TextUnit)

Parameters

Remarks

If the range is already an exact quantity of the specified units then it remains unchanged.

There is a series of steps are involved behind the scenes in order for the Move method to execute successfully.

1. The text range is normalized; that is, the text range is collapsed to a degenerate range at the Start endpoint, which makes the End endpoint superfluous. This step is necessary to remove ambiguity in situations where a text range spans unit boundaries; for example, "{The U}RL https://www.microsoft.com/ is embedded in text" where "{" and "}" are the text range endpoints.

2. The resulting range is moved backward in the DocumentRange to the beginning of the requested unit boundary.

3. The range is moved forward or backward in the DocumentRange by the requested number of unit boundaries.

4. The range is then expanded from a degenerate range state by moving the End endpoint by one requested unit boundary.

Examples of how a text range is adjusted for Move() and ExpandToEnclosingUnit()

ExpandToEnclosingUnit respects both hidden and visible text.

ExpandToEnclosingUnit defers to the next largest TextUnit supported if the given TextUnit is not supported by the control.

The order, from smallest unit to largest, is listed below.

• Character

• Format

• Word

• Line

• Paragraph

• Page

• Document

Applies to