Simple token list renderer using Aspose.Words to produce a file from a normal Microsoft Word file. Supported document types for the template are: DOC, DOCX, RTF and ODF. The format of the generated file is configurable.

Report Parameters (${...})

The word document may contain parameters as normal text elements that are replaced. Those parameters have the form ${ParamName}.

This renderer also supports arbitrary MessageFormat patterns for all input parameters; for example ${Now,date,short} will effectively be interpreted as MessageFormat {0,date,short} with the single parameter Now from the parameter map. For more information about MessageFormat, please consult the MessageFormat javadoc.

There are multiple predefined properties that are always added to the parameter map:

1. ${ListId} contains the token list's ID
2. ${DateString} contains the current date already formatted as string
3. ${Now} contains the current date as Date object
4. ${ExpirationDate} contains the token list's expiration date already formatted as string
5. ${ExpirationDateObject} contains the token list's expiration date as Date object
6. ${ListGenerationDate} contains the token list's generation date as Date object
7. ${NumberOfTokens} contains the total number of tokens in the current list
8. ${T*} contains a single token value, where * is an integer starting at zero. So the first token value will always be ${T0} whereas the 100th token will be ${T99}

Some of the above parameters contain a timestamp and can be used for both date and time display. Since this represents a Date object, it can be formatted directly using MessageFormat, for example:
${Now,date,short} displays a short date using the user's locale; for example: 09.01.12.
Alternatively, a date format can be specified in a SimpleDateFormat compatible form, for example:
${Now,date,dd.MM.yyyy} resulting in 09.01.2012.

This token list renderer allows to pass arbitrary parameters to the conversion engine: the parameter map passed to the renderTokenList() method is forwarded to the report engine. Thus, when placing the parameter Salutation with value "Dear Mr. Smith" into the parameter map when calling this renderer, you can display this value in the document using ${Salutation}.

Adding images is also supported by adding an instance of BufferedImage to the parameter map. This image replaces the entire text node where the parameter was found and is inserted as an inline image. Make sure there's enough place for that image in the template document.

Handling Multiple Languages

You can have this renderer use different documents for rendering depending on a language.
There must always be a default template configured which is used if there's no specific template defined for the passed-in language. Additionally you can define a specific template for every language expected.
Templates are read in when the renderer is initialized and are kept in memory by the renderer. Thus, reusing the renderer instance improves efficiency as the document needn't be re-parsed on every call.

type: WordTemplateTokenListRenderer
id: WordTemplateTokenListRenderer-xxxxxx
displayName: 
comment: 
properties:
  defaultTemplate:
  saveOptions:
  template:
  tokensPerRow: 10
  zeroBasedRowIndices: false