IXpsOMVisual::SetIsHyperlinkTarget method

Specifies whether the visual is the target of a hyperlink.

Syntax

HRESULT SetIsHyperlinkTarget(
  [in] BOOL isHyperlink
);

Parameters

  • isHyperlink [in]
    The Boolean value that specifies whether the visual is the target of a hyperlink.

    Value Meaning
    TRUE

    The visual is the target of a hyperlink.

    FALSE

    The visual is not the target of a hyperlink.

     

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the table that follows. For information about XPS document API return values that are not listed in this table, see XPS Document Errors.

Return code Description
S_OK

The method succeeded.

XPS_E_MISSING_NAME

The page has not been named. The hyperlink target status can only be set if the page has a name.

 

Remarks

The visual must be named before it can be set as the target of a hyperlink.

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

SetName

XPS Document Errors

XML Paper Specification