ITextStoreACP interface (textstor.h)

The ITextStoreACP 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 ITfDocumentMgr::CreateContext method. The interface ID is IID_ITextStoreACP.

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


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


The ITextStoreACP interface has these methods.


The ITextStoreACP::AdviseSink method installs a new advise sink from the ITextStoreACPSink interface or modifies an existing advise sink. The sink interface is specified by the punk parameter.

The ITextStoreACP::FindNextAttrTransition method determines the character position where a transition occurs in an attribute value. The specified attribute to check is application-dependent.

The ITextStoreACP::GetACPFromPoint method converts a point in screen coordinates to an application character position.

The ITextStoreACP::GetActiveView method returns a TsViewCookie data type that specifies the current active view.

Gets an embedded document.

The ITextStoreACP::GetEndACP method returns the number of characters in a document.

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

The ITextStoreACP::GetScreenExt method returns the bounding box screen coordinates of the display surface where the text stream is rendered.

The ITextStoreACP::GetSelection method returns 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.

The ITextStoreACP::GetStatus method obtains the document status. The document status is returned through the TS_STATUS structure.

The ITextStoreACP::GetText method returns information 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.

The ITextStoreACP::GetTextExt method returns 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.

The ITextStoreACP::GetWnd method returns the handle to a window that corresponds to the current document.

Inserts an embedded object at the specified character.

The ITextStoreACP::InsertEmbeddedAtSelection method inserts an IDataObject object 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.

The ITextStoreACP::InsertTextAtSelection method inserts text at the insertion point or selection. A caller must have a read/write lock on the document before inserting text.

The ITextStoreACP::QueryInsert method determines whether the specified start and end character positions are valid.

Gets a value indicating whether the specified object can be inserted into the document.

Gets text attributes at the specified character position.

Gets text attributes transitioning at the specified character position.

The ITextStoreACP::RequestLock method is called by the TSF manager to provide a document lock in order to modify the document. This method calls the ITextStoreACPSink::OnLockGranted method to create the document lock.

Get the attributes that are supported in the document.

Gets the attributes returned by a call to an attribute request method.

The ITextStoreACP::SetSelection method selects text within the document. The application must have a read/write lock on the document before calling this method.

The ITextStoreACP::SetText method sets the text selection to the supplied character positions.

The ITextStoreACP::UnadviseSink method is 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 2000 Professional [desktop apps only]
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header textstor.h
Redistributable TSF 1.0 on Windows 2000 Professional

See also


Text Stores