IXpsOMVisual::SetHyperlinkNavigateUri method

Sets the destination URI of the visual's hyperlink.

Syntax

HRESULT SetHyperlinkNavigateUri(
  [in] IUri *hyperlinkUri
);

Parameters

  • hyperlinkUri [in]
    The IUri interface that contains the destination URI of the visual's hyperlink.

Return value

If the method succeeds, it returns S_OK; otherwise, it returns an HRESULT error code.

Remarks

Setting an object's URI makes the object a hyperlink. When activated or clicked, the object will navigate to the destination that is specified by the URI in hyperlinkUri.

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

IUri

XML Paper Specification