setDocumentFormat.js

Area: Document

The shortest example: a combo box of raster formats backed by RasterFormat, and on OK it simply assigns doc.format = <format>. A good illustration that many document properties are plain assignable fields, not commands.

Source: setDocumentFormat.js

Example scripts

setDocumentFormat.js

Download setDocumentFormat.js

setDocumentFormat.js
/*
BSD 3-Clause License

Copyright (c) 2026, Canva Pty Ltd.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

const {Dialog, DialogResult} = require('/dialog.js');
const {Document} = require('/document.js');
const {RasterFormat} = require('/rasterobject.js');

const Formats = [
    ["RGB/8", RasterFormat.RGBA8],
    ["RGB/16", RasterFormat.RGBA16],
    ["RGB/32 (HDR)", RasterFormat.RGBAUF],
    ["Grey/8", RasterFormat.IA8],
    ["Grey/16", RasterFormat.IA16],
    ["CMYK/8", RasterFormat.CMYKA8],
    ["LAB/16", RasterFormat.LABA16]
];

function buildDialog() {
    const dlg = Dialog.create("Set Document Format");
    const grp = dlg.addColumn().addGroup();
    const combo = grp.addComboBox("New Format:", Formats.map(f => f[0]));
    dlg.getFormat = () => {
        return Formats[combo.selectedIndex][1];
    };
    
    return dlg;
}

function main() {
    const doc = Document.current;
    if (!doc) {
        alert("This script requires an open document");
        return;
    }
    const dlg = buildDialog();
    if (dlg.runModal().equals(DialogResult.Ok)) {
        doc.format = dlg.getFormat();
    }
}

module.exports.main = main;

Example scripts​

setDocumentFormat.js​

Example scripts

setDocumentFormat.js