IXpsOMDictionary interface

The dictionary is used by an XPS package to share resources.

When to implement

Never. Custom implementation of this interface is not supported.

Members

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

  • Methods

Methods

The IXpsOMDictionary interface has these methods.

Method Description
Append

Appends an IXpsOMShareable interface along with its key to the end of the dictionary.

Clone

Makes a deep copy of the interface.

GetAt

Gets the IXpsOMShareable interface pointer and the key name string of the entry at a specified index in the dictionary.

GetByKey

Gets the IXpsOMShareable interface pointer of the entry that contains the specified key.

GetCount

Gets the number of entries in the dictionary.

GetIndex

Gets the index of an IXpsOMShareable interface from the dictionary.

GetOwner

Gets a pointer to the interface that contains the dictionary.

InsertAt

Inserts an IXpsOMShareable interface at a specified location in the dictionary and sets the key to identify the interface.

RemoveAt

Removes and releases the entry from a specified location in the dictionary.

SetAt

Replaces the entry at a specified location in the dictionary.

 

Remarks

The interface pointers stored in a dictionary will usually point to interfaces, such as IXpsOMBrush and IXpsOMVisual, that are derived from the IXpsOMShareable interface. To determine the interface type, call the IXpsOMShareable::GetType method.

A dictionary cannot contain duplicate interface pointers.

Requirements

Minimum supported client

Windows 7, Windows Vista with SP2 and Platform Update for Windows Vista [desktop apps | Windows Store apps]

Minimum supported server

Windows Server 2008 R2, Windows Server 2008 with SP2 and Platform Update for Windows Server 2008 [desktop apps | Windows Store apps]

Header

Xpsobjectmodel.h

IDL

XpsObjectModel.idl

See also

IXpsOMObjectFactory::CreateDictionary

IXpsOMShareable

Interfaces

XML Paper Specification