> 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/reference/runtime-options.md).

# Run-Time Option Reference

Run-time options are query parameters passed to the editor URL. Values should be URL encoded.

## Required options

| Option   | Purpose                               |
| -------- | ------------------------------------- |
| `client` | Client name for the account.          |
| `jobID`  | Job to load for the specified client. |

## General options

| Option             | Purpose                                            |
| ------------------ | -------------------------------------------------- |
| `locale`           | Editor UI locale. Default is `en_US`.              |
| `spellCheckLocale` | Reserved for spell checking.                       |
| `autoSaveInterval` | Seconds between autosaves. `0` disables autosave.  |
| `cacheFonts`       | Cache editor fonts in browser storage.             |
| `clearFontCache`   | Clear the browser font cache before loading fonts. |

## Appearance and workflow

<table data-search="false"><thead><tr><th>Option</th><th>Purpose</th></tr></thead><tbody><tr><td><code>theme</code></td><td><code>lightest</code>, <code>light</code>, <code>dark</code>, or <code>darkest</code>.</td></tr><tr><td><code>showFormatButton</code></td><td>Show the format palette button.</td></tr><tr><td><code>formatPaletteOpen</code></td><td>Open the format palette when the editor launches.</td></tr><tr><td><code>finishedButtonLabel</code></td><td>Custom Finished button text.</td></tr><tr><td><code>finishedConfirm</code></td><td>Confirmation text after clicking Finished.</td></tr><tr><td><code>pagesNotRenderedConfirm</code></td><td>Confirmation text when not all pages have rendered.</td></tr><tr><td><code>cancelLabel</code></td><td>Cancel button text.</td></tr><tr><td><code>cancelAlert</code></td><td>Cancel confirmation text and required cancel enabler.</td></tr><tr><td><code>allowPreview</code></td><td>Show or hide Preview.</td></tr><tr><td><code>allowStartOver</code></td><td>Show Start Over.</td></tr></tbody></table>

## Object and canvas options

<table data-search="false"><thead><tr><th>Option</th><th>Purpose</th></tr></thead><tbody><tr><td><code>showAddRectangle</code></td><td>Show Add Rectangle.</td></tr><tr><td><code>showDefaultColors</code></td><td>Show generic colors in color pickers.</td></tr><tr><td><code>limitToSpreadColors</code></td><td>Limit colors to selected-spread colors.</td></tr><tr><td><code>limitColors</code></td><td>Restrict manual color choices.</td></tr><tr><td><code>openZoomedIn</code></td><td>Open with the document filling the app area.</td></tr><tr><td><code>showNonPrintLayers</code></td><td>Show foreground, background, both, or no non-printing layers.</td></tr><tr><td><code>previewNonPrintLayers</code></td><td>Include non-printing layers in server preview.</td></tr><tr><td><code>launchWithHoverButtons</code></td><td>Highlight editable frames on load.</td></tr><tr><td><code>verticalGuides</code></td><td>Comma-separated vertical guide positions.</td></tr><tr><td><code>horizontalGuides</code></td><td>Comma-separated horizontal guide positions.</td></tr><tr><td><code>showCellBorders</code></td><td>Show cyan borders for table cells without strokes.</td></tr><tr><td><code>pasteboardAlpha</code></td><td>Opacity for page items outside page bounds.</td></tr></tbody></table>

## Image options

<table data-search="false"><thead><tr><th>Option</th><th>Purpose</th></tr></thead><tbody><tr><td><code>allowUpload</code></td><td>Show Add Image and allow local uploads.</td></tr><tr><td><code>placeImagesFullSize</code></td><td>Place replacement images at full defined dimensions.</td></tr><tr><td><code>imagePpiLimit</code></td><td>Minimum resolution used while sizing images.</td></tr><tr><td><code>resolutionAlert</code></td><td>Custom low-resolution alert text.</td></tr><tr><td><code>limitImageResize</code></td><td>Enforce PPI limit during resize.</td></tr><tr><td><code>enableImagePaletteOptions</code></td><td>Enable advanced image palette controls.</td></tr><tr><td><code>showGalleryOnEdit</code></td><td>Open gallery when editing an image.</td></tr></tbody></table>

## Gallery options

<table data-search="false"><thead><tr><th>Option</th><th>Purpose</th></tr></thead><tbody><tr><td><code>showSocialGalleries</code></td><td>Show all, none, or selected social galleries.</td></tr><tr><td><code>galleryConnector</code></td><td>Image gallery connector URL.</td></tr><tr><td><code>galleryQualifiers</code></td><td>XML qualifiers passed to the gallery connector.</td></tr><tr><td><code>showUploadPane</code></td><td>Show the Computer tab in the Image Gallery Browser.</td></tr><tr><td><code>userID</code></td><td>User ID passed to gallery qualifier handling.</td></tr><tr><td><code>allowImageFiltering</code></td><td>Filter gallery content by frame name and keywords.</td></tr><tr><td><code>showSocialTemplateBackground</code></td><td>Social galleries for full-page background replacement.</td></tr><tr><td><code>templateBackgroundConnector</code></td><td>Background replacement gallery connector.</td></tr><tr><td><code>templateBackgroundQualifiers</code></td><td>Background replacement gallery qualifiers.</td></tr><tr><td><code>allowTemplateBackgroundUpload</code></td><td>Allow background image upload.</td></tr></tbody></table>

## Text options

<table data-search="false"><thead><tr><th>Option</th><th>Purpose</th></tr></thead><tbody><tr><td><code>allowNewText</code></td><td>Show Add Text.</td></tr><tr><td><code>textFrameResize</code></td><td>Resize behavior for new text frames: <code>off</code>, <code>height</code>, <code>width</code>, or <code>both</code>.</td></tr><tr><td><code>defaultTextWidth</code></td><td>Initial width for new text frames.</td></tr><tr><td><code>defaultTextHeight</code></td><td>Initial height for new text frames.</td></tr><tr><td><code>defaultFont</code></td><td>Font family for Add Text.</td></tr><tr><td><code>defaultFontStyle</code></td><td>Font style for Add Text.</td></tr><tr><td><code>newTextSize</code></td><td>Point size for Add Text.</td></tr><tr><td><code>allowTextScaling</code></td><td>Reserved for scaling auto-expand text frames.</td></tr><tr><td><code>showTextPalette</code></td><td>Show text or styles palette while editing text.</td></tr><tr><td><code>maxFontSize</code></td><td>Maximum font size in points.</td></tr><tr><td><code>useStylePalette</code></td><td>Use document styles instead of direct text properties.</td></tr><tr><td><code>useStylesForTables</code></td><td>Automatically use styles palette for table text.</td></tr><tr><td><code>showGlyphButton</code></td><td>Show the glyph button.</td></tr><tr><td><code>initialGlyphSize</code></td><td>Initial glyph palette font size.</td></tr><tr><td><code>showOversetWarning</code></td><td>Warn on finish when text is overset.</td></tr></tbody></table>

## Page and miscellaneous options

<table data-search="false"><thead><tr><th>Option</th><th>Purpose</th></tr></thead><tbody><tr><td><code>pageHeight</code></td><td>Resize page height in points.</td></tr><tr><td><code>pageWidth</code></td><td>Resize page width in points.</td></tr><tr><td><code>allowPageEditing</code></td><td>Allow adding, deleting, and changing page layouts.</td></tr><tr><td><code>allowPageMoving</code></td><td>Allow page thumbnail drag reordering.</td></tr><tr><td><code>initialPage</code></td><td>Page shown when the editor opens.</td></tr><tr><td><code>showPagePalette</code></td><td>Show the pages palette and button.</td></tr><tr><td><code>selectNonSelectable</code></td><td>Allow interaction with non-selectable objects.</td></tr><tr><td><code>sizeTableToFrameWidth</code></td><td>Resize table columns proportionally after column changes.</td></tr><tr><td><code>editLockedFrames</code></td><td>Allow editing frames locked in PrintUI Frame Options.</td></tr><tr><td><code>showPositionFields</code></td><td>Show exact frame position and size fields.</td></tr></tbody></table>


---

# 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/reference/runtime-options.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.