template-out-generate-clean

A sheet-level flag for output worksheets: before filling, Zen deletes the template worksheet (if it exists) and recreates it blank, so the generated output lands in a clean worksheet instead of being merged into the user's template.

pebblestream:template-out-generate-clean

Use it when the pebble generates the whole worksheet itself (a report built from
scratch) rather than writing into an existing template layout.

Syntax

pebblestream:template-out-generate-clean
  • No arguments.
  • Placed on any cell of the output worksheet.
  • Requires template-name on the same worksheet — the name
    still identifies which worksheet to (re)create and fill.

Consequences

  • Because the recreated worksheet has no headers to locate,
    template-out-header cannot be used on such a sheet
    — combining them fails with template-out-clean-conflict. Anchor every column
    with template-out-cell instead.
  • The template worksheet may be missing from the user's workbook entirely;
    the fill tolerates that and simply creates it.
  • Since the worksheet starts blank, the stored styles from
    template-out-style are applied without first
    clearing existing formatting (there is none).

Example

Output worksheet Generated that rebuilds the Report worksheet from scratch:

columnheadercomment
AA1pebblestream:template-out-cell
BA2pebblestream:template-out-cell

plus, on any cell of the sheet:

pebblestream:template-name:Report
pebblestream:template-out-generate-clean

Errors

ErrorCause
dir-too-many-argsArguments were supplied.
template-out-clean-conflictThe sheet also uses template-out-header.
missing-the-template-name-directiveThe sheet has no template-name.

Related


Did this page help you?