IParseDisplayName
A version of this page is also available for
4/8/2010
This interface parses a displayable name string to convert it into a moniker for custom moniker implementations. Display name parsing is necessary when the user inputs a string to identify a component, as in the following situations:
- A compound document application that supports linked components typically supports the Edit:Links dialog box. Through this dialog box, the user can enter a display name to specify a new link source for a specified linked component. The compound document needs to have this input string converted into a moniker.
- A script language such as the macro language of a spreadsheet can allow textual references to a component. The language's interpreter needs to have such a reference converted into a moniker in order to execute the macro.
When to Implement
Compound document applications that support links to embedded components or to pseudo-objects within their documents must provide an implementation of the IOleItemContainer interface, which is derived indirectly from IParseDisplayName.
In effect, such a compound document is providing a namespace for identifying its internal components; and its IOleItemContainer implementation (which includes the IParseDisplayName implementation) is the interface through which another application can access this namespace.
Alternatively, the compound document application can implement IParseDisplayName as part of its class object, which is accessible through the CoGetClassObject function.
Monikers that support their own namespace with custom requirements for parsing names also implement this interface.
When to Use
If you are implementing your own moniker class, you might need to use this interface from your implementation of IMoniker::ParseDisplayName.
If you call the MkParseDisplayName function, you are indirectly using IParseDisplayName. These two functions call IParseDisplayName to parse display names for objects that provide custom moniker implementations.
Methods in Vtable Order
| IUnknown method | Description |
|---|---|
Returns pointers to supported interfaces. |
|
Increments the reference count. |
|
Decrements the reference count. |
| Method | Description |
|---|---|
Parses the display name returning a moniker corresponding to it. |
Remarks
To determine whether the platform supports this interface, see Determining Supported COM APIs.
Requirements
| Header | Oleidl.h, oleidl.idl |
| Library | ole32.lib, uuid.lib |
| Windows Embedded CE | Windows CE 3.0 and later |
| Windows Mobile | Windows Mobile Version 5.0 and later |
See Also
Reference
IMoniker::ParseDisplayName
IOleItemContainer
MkParseDisplayName