Class Link

Hierarchy

Link

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new Link(type: LinkType, bookLink: Devhelp.Link, name: string, relativeUrl: string): Devhelp.Link

- Defined in Devhelp-3.0.d.ts:4115
Parameters
- type: LinkType
- bookLink: Devhelp.Link
- name: string
- relativeUrl: string
Returns Devhelp.Link

Properties

Static name

name: string

Methods

belongsToPage

belongsToPage(pageId: string): boolean

- Defined in Devhelp-3.0.d.ts:4070
This function permits to know if link belongs to a certain page.

page_id is usually the HTML filename without the .html extension. More generally, page_id must be a relative URL (relative to the book base path), without the anchor nor the file extension.

For example if link has the relative URL "DhLink.html#dh-link-ref", then this function will return %TRUE if the page_id is "DhLink".

Parameters
- pageId: string
  
  a page ID, i.e. the filename without its extension.
Returns boolean

compare

compare(b: Devhelp.Link): number

- Defined in Devhelp-3.0.d.ts:4076
Compares the links a and b. This function is used to determine in which order the links should be displayed.

Parameters
- b: Devhelp.Link
  
  a #DhLink.
Returns number

getBookId

getBookId(): string

- Defined in Devhelp-3.0.d.ts:4077
Returns string

getBookTitle

getBookTitle(): string

- Defined in Devhelp-3.0.d.ts:4078
Returns string

getFlags

getFlags(): LinkFlags

- Defined in Devhelp-3.0.d.ts:4079
Returns LinkFlags

getLinkType

getLinkType(): LinkType

- Defined in Devhelp-3.0.d.ts:4080
Returns LinkType

getName

getName(): string

- Defined in Devhelp-3.0.d.ts:4081
Returns string

getUri

getUri(): string

- Defined in Devhelp-3.0.d.ts:4086
Gets the link URI, by concateneting the book base path with the link relative URL.

Returns string

matchRelativeUrl

matchRelativeUrl(relativeUrl: string): boolean

- Defined in Devhelp-3.0.d.ts:4087
Parameters
- relativeUrl: string
Returns boolean

ref

ref(): Devhelp.Link

- Defined in Devhelp-3.0.d.ts:4093
Increases the reference count of link.

Not thread-safe.

Returns Devhelp.Link

setFlags

setFlags(flags: LinkFlags): void

- Defined in Devhelp-3.0.d.ts:4098
Sets the flags of the link.

Parameters
- flags: LinkFlags
  
  the new flags of the link.
Returns void

unref

unref(): void

- Defined in Devhelp-3.0.d.ts:4104
Decreases the reference count of link.

Not thread-safe.

Returns void

Static new

new(type: LinkType, bookLink: Devhelp.Link, name: string, relativeUrl: string): Devhelp.Link

- Defined in Devhelp-3.0.d.ts:4116
Parameters
- type: LinkType
- bookLink: Devhelp.Link
- name: string
- relativeUrl: string
Returns Devhelp.Link

Static newBook

newBook(basePath: string, bookId: string, bookTitle: string, relativeUrl: string): Devhelp.Link

- Defined in Devhelp-3.0.d.ts:4117
Parameters
- basePath: string
- bookId: string
- bookTitle: string
- relativeUrl: string
Returns Devhelp.Link