PaginationServices

Services available for pagination. See document examples.

• PaginationServices
  • String.asPagination() : org.obeonetwork.m2doc.element.MPagination
    • Parameter
    • Example
  • String.asStyle(String) : org.obeonetwork.m2doc.element.MParagraph
    • Parameter
    • Example
  • org.obeonetwork.m2doc.element.MTable.asStyle(String) : org.obeonetwork.m2doc.element.MTable
    • Parameter
    • Example

String.asPagination() : org.obeonetwork.m2doc.element.MPagination

Converts a String to an hyperlink

Parameter

• paginationElement: The name of the pagination element: ‘newTableOfContent’, ‘newPage’, ‘newParagraph’, ‘newColumn’, ‘newTextWrapping’

Example

• ‘newPage’.asPagination()
  • insert a page break

String.asStyle(String) : org.obeonetwork.m2doc.element.MParagraph

Converts a String with a given style if the style exists in the template, this service will insert a new paragraph. You can add styled text in comment to make sure they are present.

Parameter

• text: The text
• style: The style ID

Example

• ‘Section 1’.asStyle(‘Title1’)
  • insert ‘Section 1’ as style ‘Titre1’ in a new paragraph if the style exists in the template.

org.obeonetwork.m2doc.element.MTable.asStyle(String) : org.obeonetwork.m2doc.element.MTable

Converts a MTable with a given style if the style exists in the template. You can add styled text in blockcomment to make sure they are present.

Parameter

• table: The MTable
• styleID: The style ID

Example

• myTable.asStyle(‘Title1’)
  • set the given style to myTable.