LinkServices

Services available for links. See document examples.

• LinkServices
  • String.asBookmarkPageRef() : org.obeonetwork.m2doc.element.MBookmarkPageRef
    • Parameter
    • Example
  • String.asBookmarkPageRef(boolean) : org.obeonetwork.m2doc.element.MBookmarkPageRef
    • Parameter
    • Example
  • String.asBookmarkRef(String) : org.obeonetwork.m2doc.element.MBookmarkCustomTextRef
    • Parameter
    • Example
  • String.asBookmarkRef(String, boolean) : org.obeonetwork.m2doc.element.MBookmarkCustomTextRef
    • Parameter
    • Example
  • String.asBookmarkSectionRef() : org.obeonetwork.m2doc.element.MBookmarkSectionRef
    • Parameter
    • Example
  • String.asBookmarkSectionRef(boolean) : org.obeonetwork.m2doc.element.MBookmarkSectionRef
    • Parameter
    • Example
  • String.asBookmarkTextRef() : org.obeonetwork.m2doc.element.MBookmarkTextRef
    • Parameter
    • Example
  • String.asBookmarkTextRef(boolean) : org.obeonetwork.m2doc.element.MBookmarkTextRef
    • Parameter
    • Example
  • String.asBookmark(String) : org.obeonetwork.m2doc.element.MBookmark
    • Parameter
    • Example
  • String.asLink(String) : org.obeonetwork.m2doc.element.MHyperLink
    • Parameter
    • Example
  • String.asLink(String, String) : org.obeonetwork.m2doc.element.MHyperLink
    • Parameter
    • Example

String.asBookmarkPageRef() : org.obeonetwork.m2doc.element.MBookmarkPageRef

Inserts a page number bookmark reference

Parameter

• id: The ID of the bookmark reference

Example

• ‘Art1’.asBookmarkPageRef()
  • a bookmark reference with the ID ‘Art1’ with the page number

String.asBookmarkPageRef(boolean) : org.obeonetwork.m2doc.element.MBookmarkPageRef

Inserts a page number bookmark reference

Parameter

• id: The ID of the bookmark reference
• optional: If true, the reference is omitted if the corresponding bookmark doesn’t exists

Example

• ‘Art1’.asBookmarkPageRef(true)
  • a bookmark reference with the ID ‘Art1’ with the page number only if a bookmark with ID ‘Art1’ exists

String.asBookmarkRef(String) : org.obeonetwork.m2doc.element.MBookmarkCustomTextRef

Converts a String to a bookmark reference

Parameter

• text: The label of the bookmark reference
• id: The ID of the bookmark reference

Example

• ‘Artifact1’.asBookmarkRef(‘Art1’)
  • a bookmark reference with the ID ‘Art1’ the label ‘Artifact1’

String.asBookmarkRef(String, boolean) : org.obeonetwork.m2doc.element.MBookmarkCustomTextRef

Converts a String to a bookmark reference

Parameter

• text: The label of the bookmark reference
• id: The ID of the bookmark reference
• optional: If true, this reference will only generate the text if the corresponding bookmark doesn’t exists

Example

• ‘Artifact1’.asBookmarkRef(‘Art1’, true)
  • a bookmark reference with the ID ‘Art1’ the label ‘Artifact1’ only if a bookmark with ID ‘Art1’ exists, otherwise only the label ‘Artifact1’

String.asBookmarkSectionRef() : org.obeonetwork.m2doc.element.MBookmarkSectionRef

Inserts a section bookmark reference

Parameter

• id: The ID of the bookmark reference

Example

• ‘Art1’.asBookmarkSectionRef(true)
  • a bookmark reference with the ID ‘Art1’ with the section number

String.asBookmarkSectionRef(boolean) : org.obeonetwork.m2doc.element.MBookmarkSectionRef

Inserts a section bookmark reference

Parameter

• id: The ID of the bookmark reference
• optional: If true, the reference is omitted if the corresponding bookmark doesn’t exists

Example

• ‘Art1’.asBookmarkPageRef(true)
  • a bookmark reference with the ID ‘Art1’ with the section number

String.asBookmarkTextRef() : org.obeonetwork.m2doc.element.MBookmarkTextRef

Inserts a text bookmark reference

Parameter

• id: The ID of the bookmark reference

Example

• ‘Art1’.asBookmarkPageRef()
  • a bookmark reference with the ID ‘Art1’ with the bookmark text

String.asBookmarkTextRef(boolean) : org.obeonetwork.m2doc.element.MBookmarkTextRef

Inserts a text bookmark reference

Parameter

• id: The ID of the bookmark reference
• optional: If true, the reference is omitted if the corresponding bookmark doesn’t exists

Example

• ‘Art1’.asBookmarkPageRef(true)
  • a bookmark reference with the ID ‘Art1’ with the bookmark text only if a bookmark with ID ‘Art1’ exists

String.asBookmark(String) : org.obeonetwork.m2doc.element.MBookmark

Converts a String to a bookmark declaration

Parameter

• text: The label of the bookmark declaration
• id: The ID of the bookmark declaration

Example

• ‘Definition of Artifact1’.asBookmark(‘Art1’)
  • a bookmark with the ID ‘Art1’ the label ‘Definition of Artifact1’

String.asLink(String) : org.obeonetwork.m2doc.element.MHyperLink

Converts a String to an hyperlink

Parameter

• text: The label of the link
• url: The destination of the link

Example

• ‘My website’.asLink(‘https://www.example.org’)
  • a link to https://www.example.org with the label My website

String.asLink(String, String) : org.obeonetwork.m2doc.element.MHyperLink

Converts a String to an hyperlink

Parameter

• text: The label of the link
• url: The destination of the link
• toolTip: The tool tip of the link

Example

• ‘My website’.asLink(‘https://www.example.org’, ‘My tool tip’)
  • a link to https://www.example.org with the label My website with a tool tip