ITextStoryRanges interface (tom.h)

The purpose of the ITextStoryRanges interface is to enumerate the stories in an ITextDocument.

Inheritance

The ITextStoryRanges interface inherits from the IDispatch interface. ITextStoryRanges also has these types of members:

Methods

The ITextStoryRanges interface has these methods.

 
ITextStoryRanges::_NewEnum

Retrieves an IEnumVARIANT enumerator interface for this collection of stories.
ITextStoryRanges::GetCount

Retrieves the number of stories in the specified stories collection.
ITextStoryRanges::Item

Retrieves an ITextRange object for the Indexth story in this story collection.

Remarks

You get a pointer to an ITextStoryRanges collection by calling the GetStoryRanges method. Each story obtained from this collection is represented by an ITextRange object that covers the whole story. Text Object Model (TOM) engines that only have a single story do not need to implement an ITextStoryRanges interface. Your code should only get a stories collection if GetStoryCount returns a story count greater than one.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header tom.h

See also

Conceptual

IDispatch

Text Object Model

Using The Text Object Model