ITextDocument2 interface (tom.h)
Extends the ITextDocument interface, adding methods that enable the Input Method Editor (IME) to drive the rich edit control, and methods to retrieve other interfaces such as ITextDisplays, ITextRange2, ITextFont2, ITextPara2, and so on.
Some ITextDocument2 methods used with the IME need access to the current window handle (HWND). Use the ITextDocument2::GetWindow method to retrieve the handle.
Inheritance
The ITextDocument2 interface inherits from ITextDocument. ITextDocument2 also has these types of members:
Methods
The ITextDocument2 interface has these methods.
| ITextDocument2::AttachMsgFilter Attaches a new message filter to the edit instance. All window messages that the edit instance receives are forwarded to the message filter. |
| ITextDocument2::CheckTextLimit Checks whether the number of characters to be added would exceed the maximum text limit. |
| ITextDocument2::GetActiveStory Gets the active story; that is, the story that receives keyboard and mouse input. |
| ITextDocument2::GetCallManager Gets the call manager. |
| ITextDocument2::GetCaretType Gets the caret type. |
| ITextDocument2::GetClientRect Retrieves the client rectangle of the rich edit control. |
| ITextDocument2::GetDisplays Gets the displays collection for this Text Object Model (TOM) engine instance. |
| ITextDocument2::GetDocumentFont Gets an object that provides the default character format information for this instance of the Text Object Model (TOM) engine. |
| ITextDocument2::GetDocumentPara Gets an object that provides the default paragraph format information for this instance of the Text Object Model (TOM) engine. |
| ITextDocument2::GetEastAsianFlags Gets the East Asian flags. |
| ITextDocument2::GetEffectColor Retrieves the color used for special text attributes. |
| ITextDocument2::GetGenerator Gets the name of the Text Object Model (TOM) engine. |
| ITextDocument2::GetImmContext Gets the Input Method Manager (IMM) input context from the Text Object Model (TOM) host. |
| ITextDocument2::GetMainStory Gets the main story. |
| ITextDocument2::GetMathProperties Gets the math properties for the document. |
| ITextDocument2::GetNewStory Gets a new story. |
| ITextDocument2::GetNotificationMode Gets the notification mode. |
| ITextDocument2::GetPreferredFont Retrieves the preferred font for a particular character repertoire and character position. |
| ITextDocument2::GetProperty Retrieves the value of a property. |
| ITextDocument2::GetSelection2 Gets the active selection. (ITextDocument2.GetSelection2) |
| ITextDocument2::GetStory Retrieves the story that corresponds to a particular index. |
| ITextDocument2::GetStoryRanges2 Gets an object for enumerating the stories in a document. |
| ITextDocument2::GetStrings Gets a collection of rich-text strings. |
| ITextDocument2::GetTypographyOptions Gets the typography options. |
| ITextDocument2::GetVersion Gets the version number of the Text Object Model (TOM) engine. |
| ITextDocument2::GetWindow Gets the handle of the window that the Text Object Model (TOM) engine is using to display output. |
| ITextDocument2::Notify Notifies the Text Object Model (TOM) engine client of particular Input Method Editor (IME) events. |
| ITextDocument2::Range2 Retrieves a new text range for the active story of the document. |
| ITextDocument2::RangeFromPoint2 Retrieves the degenerate range at (or nearest to) a particular point on the screen. |
| ITextDocument2::ReleaseCallManager Releases the call manager. |
| ITextDocument2::ReleaseImmContext Releases an Input Method Manager (IMM) input context. |
| ITextDocument2::SetActiveStory Sets the active story; that is, the story that receives keyboard and mouse input. |
| ITextDocument2::SetCaretType Sets the caret type. |
| ITextDocument2::SetDocumentFont Sets the default character formatting for this instance of the Text Object Model (TOM) engine. |
| ITextDocument2::SetDocumentPara Sets the default paragraph formatting for this instance of the Text Object Model (TOM) engine. |
| ITextDocument2::SetEffectColor Specifies the color to use for special text attributes. |
| ITextDocument2::SetIMEInProgress Sets the state of the Input Method Editor (IME) in-progress flag. |
| ITextDocument2::SetMathProperties Specifies the math properties to use for the document. |
| ITextDocument2::SetNotificationMode Sets the notification mode. |
| ITextDocument2::SetProperty Specifies a new value for a property. |
| ITextDocument2::SetTypographyOptions Specifies the typography options for the document. |
| ITextDocument2::SysBeep Generates a system beep. |
| ITextDocument2::Update Updates the selection and caret. |
| ITextDocument2::UpdateWindow Notifies the client that the view has changed and the client should update the view if the Text Object Model (TOM) engine is in-place active. |
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows 8 [desktop apps only] |
| Minimum supported server | Windows Server 2012 [desktop apps only] |
| Target Platform | Windows |
| Header | tom.h |