Export (0) Print
Expand All

IXpsOMPage::SetIsHyperlinkTarget method

Specifies whether the page is the target of a hyperlink.

Syntax


HRESULT SetIsHyperlinkTarget(
  [in]  BOOL isHyperlinkTarget
);

Parameters

isHyperlinkTarget [in]

The Boolean value that indicates whether the page is the target of a hyperlink.

ValueMeaning
TRUE

The page is the target of a hyperlink.

FALSE

The page 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 codeDescription
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

Only those pages that have this property set to TRUE will be included in the hyperlink targets that are collected by IXpsOMPageReference::CollectLinkTargets.

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

IXpsOMPage
XPS Document Errors
XML Paper Specification

 

 

Community Additions

ADD
Show:
© 2015 Microsoft