ITextStoreACP2 interface (textstor.h)

The ITextStoreACP2 interface is implemented by the application and is used by the TSF manager to manipulate text streams or text stores in TSF. An application can obtain an instance of this interface with a call to the CreateContext method. The interface ID is IID_ITextStoreACP2.

This interface exposes text stores through an application character position (ACP) format. Applications that use an anchor-based format should use ITextStoreAnchor.


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


The ITextStoreACP2 interface has these methods.


Installs a new advise sink from the ITextStoreACPSink interface or modifies an existing advise sink. The sink interface is specified by the punk parameter.

Determines the character position where a transition occurs in an attribute value. The specified attribute to check is application-dependent.

Converts a point in screen coordinates to an application character position.

Gets a TsViewCookie that represents the current active view.

Gets an embedded document. (ITextStoreACP2.GetEmbedded)

Gets the number of characters in a document.

Gets formatted text data about a specified text string. The caller must have a read/write lock on the document before calling this method.

Gets the bounding box screen coordinates of the display surface where the text stream is rendered.

Gets the character position of a text selection in a document. This method supports multiple text selections. The caller must have a read-only lock on the document before calling this method.

Gets the document status. The document status is returned through the TS_STATUS structure.

Gets info about text at a specified character position. This method returns the visible and hidden text and indicates if embedded data is attached to the text.

Gets the bounding box, in screen coordinates, of the text at a specified character position. The caller must have a read-only lock on the document before calling this method.

Inserts an embedded object at the specified character. (ITextStoreACP2.InsertEmbedded)

Inserts an IDataObject at the insertion point or selection. The client that calls this method must have a read/write lock before inserting an IDataObject object into the document.

Inserts text at the insertion point or selection. A caller must have a read/write lock on the document before inserting text.

Determines whether the specified start and end character positions are valid. Use this method to adjust an edit to a document before executing the edit. The method must not return values outside the range of the document.

Gets a value indicating whether the specified object can be inserted into the document. (ITextStoreACP2.QueryInsertEmbedded)

Gets text attributes at the specified character position. (ITextStoreACP2.RequestAttrsAtPosition)

Gets text attributes transitioning at the specified character position. (ITextStoreACP2.RequestAttrsTransitioningAtPosition)

Called by the TSF manager to provide a document lock in order to modify the document. This method calls the OnLockGranted method to create the document lock.

Get the attributes that are supported in the document. (ITextStoreACP2.RequestSupportedAttrs)

Gets the attributes returned by a call to an attribute request method. (ITextStoreACP2.RetrieveRequestedAttrs)

Selects text within the document. The application must have a read/write lock on the document before calling this method.

Sets the text selection to the supplied character positions.

Called by an application to indicate that it no longer requires notifications from the TSF manager. The TSF manager will release the sink interface and stop notifications.


Minimum supported client Windows 8 [desktop apps | UWP apps]
Minimum supported server Windows Server 2012 [desktop apps | UWP apps]
Target Platform Windows
Header textstor.h