ITextProvider::DocumentRange Property

Gets a text range that encloses the main text of a document.

Syntax

HRESULT ITextProvider::get_DocumentRange(ITextRangeProvider **pRetVal);

Parameters

• pRetVal
  [retval][out] The address of a variable that receives a pointer to the ITextRangeProvider interface of the text range. This parameter is passed uninitialized.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Some auxiliary text such as headers, footnotes, or annotations may not be included.

See Also

UI Automation Providers Overview, ITextRangeProvider