> For the complete documentation index, see [llms.txt](https://docs.santacruzsoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.santacruzsoftware.com/printui/guides/control-editor-behavior.md).

# Control Editor Behavior

Developers and host systems control many editor behaviors through run-time options passed when the editor opens.

## Required launch values

Every editor launch must identify the client and job. The job ID must belong to the specified client.

Use URL encoding for values that contain spaces, slashes, backslashes, XML, or special characters.

## Common control areas

<table data-search="false"><thead><tr><th>Area</th><th>Examples</th></tr></thead><tbody><tr><td>Appearance</td><td>Theme, Finished label, Cancel label, confirmation text, format palette state.</td></tr><tr><td>Tools</td><td>Add Image, Add Text, Add Rectangle, Preview, Start Over, page editing, page moving.</td></tr><tr><td>Text</td><td>Text palette, styles palette, glyph button, default add-text font, max font size, overset warning.</td></tr><tr><td>Images</td><td>Uploads, gallery connector, social galleries, image filtering, PPI limit, replacement behavior.</td></tr><tr><td>Colors</td><td>Default colors, document colors, spread colors, manual color entry.</td></tr><tr><td>Canvas</td><td>Initial page, zoom behavior, guides, non-printing layers, pasteboard alpha, cell borders.</td></tr><tr><td>Localization</td><td>Editor locale and localized default labels.</td></tr></tbody></table>

## Strict editing example

For a tightly controlled brand template, a host system might hide Add Text, Add Image, Add Rectangle, restrict colors to document colors, use the styles palette, hide direct text formatting, and warn about overset text on finish.

## Flexible editing example

For a self-service creative workflow, a host system might allow uploads, new text, new rectangles, default colors, page editing, page moving, image palette options, and preview choices.

## Completion handling

The parent page must handle `printui_finished`. If canceling is enabled, handle `printui_cancel` as well. These messages are sent from the editor iframe to the embedding page.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.santacruzsoftware.com/printui/guides/control-editor-behavior.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.