Windows Dev Center

Expand Minimize

IXpsOMCanvas interface

A group of visual elements and related properties.

When to implement

Never. Custom implementation of this interface is not supported.

Members

The IXpsOMCanvas interface inherits from IXpsOMVisual. IXpsOMCanvas also has these types of members:

Methods

The IXpsOMCanvas interface has these methods.

MethodDescription
Clone

Makes a deep copy of the interface.

GetAccessibilityLongDescription

Gets the long (detailed) textual description of the object's contents.

GetAccessibilityShortDescription

Gets a short textual description of the object's contents.

GetDictionary

Gets a pointer to the resolved IXpsOMDictionary interface of the dictionary associated with the canvas.

GetDictionaryLocal

Gets a pointer to the IXpsOMDictionary interface of the local, unshared dictionary.

GetDictionaryResource

Gets a pointer to the IXpsOMRemoteDictionaryResource interface of the remote dictionary resource.

GetUseAliasedEdgeMode

Gets a Boolean value that determines whether the edges of the objects in the canvas are to be rendered using the aliased edge mode.

GetVisuals

Gets a pointer to an IXpsOMVisualCollection interface that contains a collection of the visual objects in the canvas.

SetAccessibilityLongDescription

Sets the long (detailed) textual description of the object's contents.

SetAccessibilityShortDescription

Sets the short textual description of the object's contents.

SetDictionaryLocal

Sets the IXpsOMDictionary interface pointer of the local, unshared dictionary.

SetDictionaryResource

Sets the IXpsOMRemoteDictionaryResource interface pointer of the remote dictionary resource.

SetUseAliasedEdgeMode

Sets the value that determines whether the edges of objects in this canvas will be rendered using the aliased edge mode.

 

Remarks

The code example that follows illustrates how to create an instance of this interface.



IXpsOMCanvas    *newInterface;

// Note the implicit requirement that CoInitializeEx 
//  has previously been called from this thread.

hr = CoCreateInstance(
    __uuidof(XpsOMObjectFactory),
    NULL,
    CLSCTX_INPROC_SERVER,
    _uuidof(IXpsOMObjectFactory),
    reinterpret_cast<LPVOID*>(&xpsFactory)
    );

if (SUCCEEDED(hr))
{
    hr = xpsFactory->CreateCanvas (&newInterface);
    if (SUCCEEDED(hr))
    {
        // use newInterface

        newInterface->Release();
    }
    xpsFactory->Release();
}
else
{
    // evaluate HRESULT error returned in hr
}


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

IXpsOMVisual
IXpsOMObjectFactory::CreateCanvas
Interfaces
XML Paper Specification

 

 

Community Additions

ADD
Show:
© 2015 Microsoft