ITextStory interface

The ITextStory interface methods are used to access shared data from multiple stories, which is stored in the parent ITextServices instance.

The stories can be "edited" simultaneously by using individual ITextRange2 methods, and displayed independently of one another. In addition, one story at a time can be UI active; that is, it receives keyboard and mouse input.

The ITextStory is a lightweight interface that does not require an ITextRange2 object. This allows the client to manipulate a story, which is a faster, smaller object than a complete editing instance.

When to implement

Applications typically do not implement the ITextStory interface. Microsoft text solutions, such as rich edit controls, implement ITextStory as part of their TOM implementation.

When to use

Applications can retrieve an ITextStory pointer from a rich edit control. To do this, call the object's ITextStory::GetRange method to retrieve an ITextRange2 for the story.

Members

The ITextStory interface inherits from the IUnknown interface. ITextStory also has these types of members:

Methods

The ITextStory interface has these methods.

MethodDescription
GetActive

Sets the active state of a story.

GetDisplay

Gets a new display for a story.

GetIndex

Gets the index of a story.

GetProperty

Gets the value of the specified property.

GetRange

Gets a text range object for the story.

GetText

Gets the text in a story according to the specified conversion flags.

GetType

Gets this story's type.

SetActive

Sets the active state of a story.

SetFormattedText

Replaces a story’s text with specified formatted text.

SetProperty

Sets the value of the specified property.

SetText

Replaces the text in a story with the specified text.

SetType

Sets the story type.

 

Requirements

Minimum supported client

Windows 8 [desktop apps only]

Minimum supported server

Windows Server 2012 [desktop apps only]

IDL

Tom.idl

 

 

Community Additions

ADD
Show:
© 2014 Microsoft