ITextStrings interface (tom.h)
The ITextStrings interface represents a collection of rich-text strings that are useful for manipulating rich text. In particular, you can use the collection to convert linearly formatted math expressions into built-up form and vice versa. You can also use the collection to collect the concatenation of a set of rich-text strings, or to manipulate a string without changing a primary story. The collection is efficiently implemented by concatenating the strings in a scratch story and maintaining an array of the string counts that identify the strings.
Inheritance
The ITextStrings interface inherits from the IDispatch interface. ITextStrings also has these types of members:
Methods
The ITextStrings interface has these methods.
| ITextStrings::Add Adds a string to the end of the collection. |
| ITextStrings::Append Appends a string to the string at the specified index in the collection. |
| ITextStrings::Cat2 Concatenates two strings. |
| ITextStrings::CatTop2 Inserts text between the top two strings in a collection. |
| ITextStrings::DeleteRange Deletes the contents of a given range. |
| ITextStrings::EncodeFunction Encodes an object, given a set of argument strings. |
| ITextStrings::GetCch Gets the count of characters for a selected string index. |
| ITextStrings::GetCount Gets the number of strings in a string collection. |
| ITextStrings::InsertNullStr Inserts a NULL string in the collection at a selected string index. |
| ITextStrings::Item Gets an ITextRange2 object for a selected index in a string collection. |
| ITextStrings::MoveBoundary Moves the start boundary of a string, by index, for a selected number of characters. |
| ITextStrings::PrefixTop Prefixes a string to the top string in the collection. |
| ITextStrings::Remove Removes a string from a string collection, starting at an index. |
| ITextStrings::SetFormattedText Replaces text with formatted text. |
| ITextStrings::SetOpCp Sets the character position in the source range's story that has desired character formatting attributes. |
| ITextStrings::SuffixTop Suffixes a string to the top string in the collection. |
| ITextStrings::Swap Swaps the top two strings in the collection. |
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 |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for