ApiHyperlink

class ApiHyperlink

Description

Class representing a Paragraph hyperlink.

Instance Methods

GetClassType(): hyperlink

Returns a type of the ApiHyperlink class.

SetLink(sLink): boolean

Sets the hyperlink address.

SetDisplayedText(sDisplay): boolean

Sets the hyperlink display text.

SetScreenTipText(sScreenTipText): boolean

Sets the screen tip text of the hyperlink.

GetLinkedText(): string

Returns the hyperlink address.

GetDisplayedText(): string

Returns the hyperlink display text.

GetScreenTipText(): string

Returns the screen tip text of the hyperlink.

GetElement(nPos): ParagraphContent

Returns the hyperlink element using the position specified.

GetElementsCount(): number

Returns a number of elements in the current hyperlink.

SetDefaultStyle(): boolean

Sets the default hyperlink style.

GetRange(Start, End): ApiRange

Returns a Range object that represents the document part contained in the specified hyperlink.

ToJSON(bWriteStyles): JSON

Converts the ApiHyperlink object into the JSON object.

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).