IEndnoteTextRangeData Class Reference

#include <IEndnoteTextRangeData.h>

Inheritance diagram for IEndnoteTextRangeData:

Public Types
enum	{ kDefaultIID = IID_IENDNOTETEXTRANGEDATA }

Public Member Functions
virtual void	SetEndnoteRangeReference (TextRangeReference rangeRef)=0
virtual TextRangeReference	GetEndnoteRangeReference () const =0
virtual UIDRef	GetOwningStoryRef () const =0
virtual ITextModel *	QueryOwningStory () const =0
virtual TextIndex	GetStartTextIndex () const =0
virtual TextIndex	GetEndTextIndex () const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface is used to set or retrieve the endnotes text range details associated with an endnote.

Member Function Documentation

virtual TextRangeReference IEndnoteTextRangeData::GetEndnoteRangeReference ( ) const

pure virtual

INTERNAL USE: Get the text range reference for the endnote text.

virtual TextIndex IEndnoteTextRangeData::GetEndTextIndex ( ) const

pure virtual

Get the ending text index for the endnote text.

This is actually the text index of the right XML-like marker after the endnote text.

virtual UIDRef IEndnoteTextRangeData::GetOwningStoryRef ( ) const

pure virtual

Get the UIDRef of the story in which the endnote text is located.

virtual TextIndex IEndnoteTextRangeData::GetStartTextIndex ( ) const

pure virtual

Get the starting text index for the endnote text. This is actually the text index of the left XML-like marker before the endnote text. The endnote number is at the next text index, followed by the separator characters and then the actual endnote text.

virtual ITextModel* IEndnoteTextRangeData::QueryOwningStory ( ) const

pure virtual

Get the reference counted ITextModel pointer for the story in which the endnote text is located.

virtual void IEndnoteTextRangeData::SetEndnoteRangeReference ( TextRangeReference  rangeRef )

pure virtual

INTERNAL USE: Set the text range reference for the endnote text.