get_hyperlinks method

get_hyperlinks

Extracts hyperlinks from the document.

Returns

A collection of PageHyperlinkArea objects; null if hyperlinks extraction isn’t supported.

def get_hyperlinks(self):
    ...

Example

The following example shows how to extract all hyperlinks from the whole document:

get_hyperlinks

Extracts hyperlinks from the document page.

Returns

A collection of PageHyperlinkArea objects; null if hyperlinks extraction isn’t supported.

def get_hyperlinks(self, page_index):
    ...
Parameter Type Description
page_index int The zero-based page index.

Example

The following example shows how to extract hyperlinks from the document page:

get_hyperlinks

Extracts hyperlinks from the document using customization options (to set the rectangular area that contains hyperlinks).

Returns

A collection of PageHyperlinkArea objects; null if hyperlinks extraction isn’t supported.

def get_hyperlinks(self, options):
    ...
Parameter Type Description
options groupdocs.parser.options.PageAreaOptions The options for hyperlinks extraction.

Example

The following example shows how to extract hyperlinks from the document page area:

get_hyperlinks

Extracts hyperlinks from the document page using customization options (to set the rectangular area that contains hyperlinks).

Returns

A collection of PageHyperlinkArea objects; null if hyperlinks extraction isn’t supported.

def get_hyperlinks(self, page_index, options):
    ...
Parameter Type Description
page_index int The zero-based page index.
options groupdocs.parser.options.PageAreaOptions The options for hyperlinks extraction.

Example

The following example shows how to extract hyperlinks from the document page area using customization options:

See Also