> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Hyperlink Object (IHyperlink Interface)

This object exposes method and properties of a hyperlink.

## Properties

| Name        | Type                                                                                                                                                                                                          | Description                                                                                                                                                                                                                                                                     |
| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application | [Engine](/fine-reader/engine/api-reference/engine-object-iengine-interface), [read-only](/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties#readonly_properties) | Returns the Engine object.                                                                                                                                                                                                                                                      |
| Scheme      | [HyperlinkSchemeEnum](/fine-reader/engine/api-reference/enumerations/hyperlinkschemeenum)                                                                                                                     | Stores 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. |
| Target      | [BSTR](/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)                                                                                                       | Stores the hyperlink address. If the link is local, use the user bookmark as Target and HS\\\_Local as Scheme (see the example below).                                                                                                                                          |

## Methods

| Name                                                                                               | Description                                                                                                                                                                      |
| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [ParseTarget](/fine-reader/engine/api-reference/text-related-objects/hyperlink/parsetarget-method) | Brings the Target property to the canonical form, according to the types described in [HyperlinkSchemeEnum](/fine-reader/engine/api-reference/enumerations/hyperlinkschemeenum). |

## Related objects

<img src="https://mintcdn.com/abbyy/lsETHFYUFiongXSm/images/fine-reader/engine/hyperlink.gif?s=5dea80fc22549d324284c1afc360d759" alt="Hyperlink" width="183" height="52" data-path="images/fine-reader/engine/hyperlink.gif" />[](/fine-reader/engine/api-reference/text-related-objects/paragraph/hyperlink-property)[](/fine-reader/engine/api-reference/text-related-objects/paragraph)

[Object Diagram](/fine-reader/engine/api-reference/object-diagram)

## Output parameter

This object is the output parameter of the [CreateHyperlink](/fine-reader/engine/api-reference/engine-object-iengine-interface/creation-methods/createlessobjectgreater-methods) method of the [Engine](/fine-reader/engine/api-reference/engine-object-iengine-interface) object.

## Input parameter

This object is the input parameter of the [SetHyperlink](/fine-reader/engine/api-reference/text-related-objects/paragraph/sethyperlink-method) method of the [Paragraph](/fine-reader/engine/api-reference/text-related-objects/paragraph) object.

## Samples

<Accordion title="C++ code">
  ```cpp theme={null}
  // 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 );
  ...
  ```
</Accordion>

## See also

[Working with Text](/fine-reader/engine/guided-tour/advanced-techniques/working-with-text)

[Working with Properties](/fine-reader/engine/guided-tour/advanced-techniques/programming-aspects/working-with-properties)