imported>DanielRigal: deprod

2025-03-18T00:13:57Z

deprod

New page

{{Short description|Microsoft Windows programming interface}}
The '''Text Object Model''' ('''TOM''') is a [[Microsoft Windows]] [[Application Programming Interface|API]] that provides developers with object-based rich text manipulation interfaces. It is implemented through [[Component Object Model|COM]], and can be accessed through [[Microsoft Word]] or additionally through the RichEdit controls that normally ship with Windows.<ref name="tom_msdn">{{cite web|url=http://msdn.microsoft.com/en-us/library/windows/desktop/bb787607.aspx|title=Text Object Model|accessdate=2011-12-04}}</ref>

==History==
When TOM was developed, it was influenced heavily by WordBasic,<ref name="tom_msdn" /> a [[macro language]] used within Word before [[Visual Basic for Applications|VBA]] ([[Microsoft Word#Word 1990 to 1995|Word 95]] and previous releases). TOM has developed alongside the RichEdit technology, and has been present since version 1.0 of the RichEdit components.<ref name="richedit_2006">{{cite web|url=https://learn.microsoft.com/en-us/archive/blogs/murrays/richedit-versions|title=RichEdit versions|date=13 October 2006 |accessdate=2023-11-19}}</ref> The API has been available as an option for [[Windows CE]] since the 2.5 release of RichEdit (Western Languages Only), which was at least used by [[Microsoft Office Mobile#Word Mobile|Pocket Word]] at that time.<ref name="richedit_2006" />

Version 8.0 of RichEdit, which shipped with [[Windows 8]], added support for [[OpenType math]].<ref>{{Cite web|url=http://blogs.msdn.com/b/murrays/archive/2012/03/03/richedit-8-0-preview.aspx|title = DevBlogs}}</ref>

==Technical details==
To retrieve an implemented instance of <code>ITextDocument</code> [[interface (object-oriented programming)|interface]] (the top-level document interface), the <code>EM_GETOLEINTERFACE</code> message may be sent via the [http://msdn2.microsoft.com/en-us/library/ms644950.aspx SendMessage] API to obtain a pointer to an <code>IRichEditOle</code> object, which also implements the <code>ITextDocument</code> interface.<ref name="tom_msdn" /> TOM may operate differently depending on the version of the RichEdit control the interface is retrieved for (RICHEDIT50W windows provide more functionality than the standard RICHEDIT20W or RICHEDIT20A controls, like proper table support).<ref name="richedit_2006" />

===COM Interfaces===
;ITextDocument
:A top-level interface. Documents may be opened and saved through this interface. Some screen update control is achieved here as well. Undo/redo grouping is implemented here. Arbitrary text ranges ('''ITextRange''') and a text range for currently selected text ('''ITextSelection''') are provided, which are used to modify or review the document.
;ITextRange
:Provides editing and data-binding tools to select text within a document, that can be examined, modified, or removed. Ranges exist within paragraphs, and the paragraph a range is within is accessible through a property of this object.
:;ITextSelection
::Provides selection information, in addition to functionality provided by the '''ITextRange'''.
;ITextFont
:Dual Interface with '''ITextPara'''
:A mechanism for inspection and modification of rich edit font attributes, that is considerably more extensive that the standard OLE interface used to describe a font (IFontDisp, StdFont).
;ITextPara
:Dual Interface with '''ITextFont'''
:Provides extensive information about the position, formatting outside of fonts (e.g. first line indent), behavior (e.g. widow control), and purpose of a paragraph (it could be a normal paragraph, a list, a table, etc).

==See also==
*[[Rich Text Format]]
*[[Component Object Model]] (COM)
*[[Object Linking and Embedding]] (OLE)

==References==
{{reflist}}

==External links==
*[http://msdn2.microsoft.com/en-us/library/bb787607.aspx Text Object Model Overview]
*[http://msdn2.microsoft.com/en-us/library/bb788041.aspx Obtaining the TOM Object for a RichEdit Control]
*[http://blogs.msdn.com/b/murrays/archive/2010/01/13/richedit-versions-1-0-through-3-0.aspx Historical RichEdit/TOM information] ([https://web.archive.org/web/20160304063220/http://blogs.msdn.com/b/murrays/archive/2010/01/13/richedit-versions-1-0-through-3-0.aspx WebArchive link])
*[https://www.brad-smith.info/blog/projects/textobjectmodel TOM Classes for .NET]

{{Microsoft APIs}}

[[Category:Microsoft application programming interfaces]]

Text Object Model - Revision history

imported>DanielRigal: deprod