Skip to main content
This object exposes method and properties of a hyperlink.

​
Properties

NameTypeDescription
ApplicationEngine, read-onlyReturns the Engine object.
SchemeHyperlinkSchemeEnumStores the hyperlink type which is detected automatically when the Target property is assigned a hyperlink address. If the value of the IHyperlink::Scheme property is HS\_Unknown, the type of the hyperlink assigned to the Target property will be detected automatically.
TargetBSTRStores the hyperlink address. If the link is local, use the user bookmark as Target and HS\_Local as Scheme (see the example below).

​
Methods

NameDescription
ParseTargetBrings the Target property to the canonical form, according to the types described in HyperlinkSchemeEnum.
Hyperlink Object Diagram

​
Output parameter

This object is the output parameter of the CreateHyperlink method of the Engine object.

​
Input parameter

This object is the input parameter of the SetHyperlink method of the Paragraph object.

​
Samples

// Create bookmark
paragraph1->SetBookmark( 0, count, L"my_user_bookmark" ) ;
// Create hyperlink
CSafePtr<IHyperlink> newHyperlink;
FREngine->CreateHyperlink( &newHyperlink ) ;
newHyperlink->put_Scheme( HS_Local ) ;
newHyperlink->put_Target( L"UserDefinedBookmark:my_user_bookmark" ) ;
paragraph2->SetHyperlink( 0, count, newHyperlink );
...

​
See also

Working with Text Working with Properties