ActionCalls>= v1.23.0

ActionCalls:

{
  document.undo(): ActionCall;
  document.redo(): ActionCall;
  document.export-pdf(): ActionCall;
  document.export-docx(): ActionCall;
  document.export-markdown(): ActionCall;
  document.export-rtf(): ActionCall;
  document.export-odt(): ActionCall;
  edit.cut(): ActionCall;
  edit.copy(): ActionCall;
  edit.paste(): ActionCall;
  edit.paste-without-formatting(): ActionCall;
  edit.delete(): ActionCall;
  formatting.font-family(fontFamily: string): ActionCall;
  formatting.font-size(points: number): ActionCall;
  formatting.bold(value?: boolean): ActionCall;
  formatting.italic(value?: boolean): ActionCall;
  formatting.underline(value?: boolean): ActionCall;
  formatting.strikethrough(value?: boolean): ActionCall;
  formatting.subscript(value?: boolean): ActionCall;
  formatting.superscript(value?: boolean): ActionCall;
  formatting.text-color(color: `#${string}` | "none" | null): ActionCall;
  formatting.highlight-color(color: `#${string}` | "none" | null): ActionCall;
  formatting.clear(): ActionCall;
  insert.line-break(): ActionCall;
  insert.page-break(): ActionCall;
  insert.section-break-next-page(): ActionCall;
  insert.image(): ActionCall;
  insert.link(): ActionCall;
  insert.shape(): ActionCall;
  insert.text-box(): ActionCall;
  insert.field(rule: "pageNum" | "pageCount" | "toc"): ActionCall;
  insert.comment(): ActionCall;
  comment.reply(commentId: string, replyText: string): ActionCall;
  comment.edit(commentId: string, newText: string): ActionCall;
  comment.resolve(commentId: string): ActionCall;
  comment.delete(commentId: string): ActionCall;
  revision.accept(revisionId: string): ActionCall;
  revision.reject(revisionId: string): ActionCall;
  link.edit(): ActionCall;
  link.remove(): ActionCall;
  link.open(): ActionCall;
  link.copy(): ActionCall;
  table.insert(): ActionCall;
  table.delete(): ActionCall;
  table.insert-row-above(): ActionCall;
  table.insert-row-below(): ActionCall;
  table.insert-column-left(): ActionCall;
  table.insert-column-right(): ActionCall;
  table.delete-row(): ActionCall;
  table.delete-column(): ActionCall;
  table.merge-cells(): ActionCall;
  table.split-cells(): ActionCall;
  table.set-cell-background(color: `#${string}` | "none" | null): ActionCall;
  table.set-cell-border(side: CellBorderSide, color: `#${string}` | "none" | null): ActionCall;
  table.set-cell-border-width(side: CellBorderSide, points: number): ActionCall;
  table.set-cell-border-radius(corners: "outer" | "inner", points: number): ActionCall;
  table.set-cell-padding(side: BoxSide, points: number): ActionCall;
  table.set-wrapping(floating: boolean): ActionCall;
  table.set-indentation(points: number): ActionCall;
  table.set-column-width(width: number | null): ActionCall;
  view.zoom(percent: number): ActionCall;
  view.zoom-in(): ActionCall;
  view.zoom-out(): ActionCall;
  view.zoom-reset(): ActionCall;
  view.toggle-ruler(visible?: boolean): ActionCall;
  view.toggle-formatting-marks(visible?: boolean): ActionCall;
  view.open-command-palette(): ActionCall;
  view.find(): ActionCall;
  view.mode.edit(): ActionCall;
  view.mode.review(): ActionCall;
  view.mode.view(): ActionCall;
  layout.align-left(): ActionCall;
  layout.align-center(): ActionCall;
  layout.align-right(): ActionCall;
  layout.align-justify(): ActionCall;
  layout.increase-indent(): ActionCall;
  layout.decrease-indent(): ActionCall;
  layout.bulleted-list(): ActionCall;
  layout.numbered-list(): ActionCall;
  layout.apply-list-preset(preset: "Bullet" | "Diamond" | "Arrow" | "Star" | "Arrowhead" | "DecimalAndDot" | "LetterAndDot" | "RomanAndDot" | "DecimalAndParenthesis" | "DecimalZero" | "DecimalDeep"): ActionCall;
  layout.continue-numbering(): ActionCall;
  layout.line-spacing-single(): ActionCall;
  layout.line-spacing-1-5(): ActionCall;
  layout.line-spacing-double(): ActionCall;
  layout.line-spacing-at-least(points: number): ActionCall;
  layout.line-spacing-exactly(points: number): ActionCall;
  layout.line-spacing-multiple(factor: number): ActionCall;
  layout.space-before(points: number): ActionCall;
  layout.space-after(points: number): ActionCall;
  layout.contextual-spacing(value?: boolean): ActionCall;
  layout.page-size(size: "Letter" | "A4" | "A5" | "A6"): ActionCall;
  layout.page-orientation(orientation: "portrait" | "landscape"): ActionCall;
  layout.page-margin(side: BoxSide, points: number): ActionCall;
  layout.header-footer-different-first(enabled: boolean): ActionCall;
  layout.header-footer-different-odd-even(enabled: boolean): ActionCall;
  layout.header-footer-distance(part: "header" | "footer", points: number): ActionCall;
  layout.default-tab-stop(points: number): ActionCall;
  style.apply(styleId: string): ActionCall;
  style.apply-clear(styleId: string): ActionCall;
  style.update(styleId: string): ActionCall;
  shape.set-type(preset: ShapePreset): ActionCall;
  shape.set-fill-color(color: `#${string}` | null): ActionCall;
  shape.set-fill-transparency(percent: number): ActionCall;
  shape.set-outline-color(color: `#${string}` | null): ActionCall;
  shape.set-outline-width(points: number): ActionCall;
  shape.set-outline-transparency(percent: number): ActionCall;
  shape.set-text-padding(side: BoxSide, value: number, unit: Unit): ActionCall;
  shape.set-wrapping(mode: "inline" | "square" | "topAndBottom" | "behind" | "front"): ActionCall;
  object.set-wrapping(mode: "inline" | "square" | "topAndBottom" | "behind" | "front", offset?: { x: number; y: number }): ActionCall;
  object.arrange(order: "front" | "forward" | "back" | "backward"): ActionCall;
  field.update(): ActionCall;
  field.change(rule: "pageNum" | "pageCount"): ActionCall;
  spellcheck.replace(clusterBegin: number, clusterEnd: number, replacement: string): ActionCall;
  paragraph.set-shading(color: `#${string}` | "none" | null): ActionCall;
  paragraph.set-border-color(side: ParagraphBorderSide, color: `#${string}` | "none" | null): ActionCall;
  paragraph.set-border-width(side: ParagraphBorderSide, points: number): ActionCall;
  paragraph.set-border-radius(corners: "Outer" | "Inner", points: number): ActionCall;
  paragraph.set-indent(side: "left" | "right" | "first-line", points: number): ActionCall;
  paragraph.change-tab-stops(changes: { from?: { position: number; alignment: "left" | "center" | "right" | "decimal" | "bar"; leader: "none" | "dot" | "heavy" | "hyphen" | "middleDot" | "underscore" }; to?: { position: number; alignment: "left" | "center" | "right" | "decimal" | "bar"; leader: "none" | "dot" | "heavy" | "hyphen" | "middleDot" | "underscore" } }[]): ActionCall;
}

The built-in actions and the arguments they take. Each method is named by a BuiltInActionId and returns an ActionCall for editor.executeAction(). Use the actionCalls value to build calls.

Text and paragraph actions apply to the current selection. Distances are in points (1/72 inch) unless a parameter says otherwise.

Example

import { actionCalls } from '@nutrient-sdk/document-authoring';

await editor.executeAction(actionCalls['formatting.bold'](true));
await editor.executeAction(actionCalls['layout.page-margin']('l', 72));

Methods

document.undo()

document.undo(): ActionCall

Undoes the last change.

Returns

ActionCall

---

document.redo()

document.redo(): ActionCall

Redoes the last undone change.

Returns

ActionCall

---

document.export-pdf()

document.export-pdf(): ActionCall

Downloads the document as a PDF file.

Returns

ActionCall

---

document.export-docx()

document.export-docx(): ActionCall

Downloads the document as a DOCX file.

Returns

ActionCall

---

document.export-markdown()

document.export-markdown(): ActionCall

Downloads the document as a Markdown file.

Returns

ActionCall

---

document.export-rtf()

document.export-rtf(): ActionCall

Downloads the document as an RTF file.

Returns

ActionCall

---

document.export-odt()

document.export-odt(): ActionCall

Downloads the document as an ODT file.

Returns

ActionCall

---

edit.cut()

edit.cut(): ActionCall

Cuts the selected text to the clipboard. Runs when text is selected. Backs the Cut item of the context menu. Mod+X is handled by the editor directly and doesn’t run this action.

Returns

ActionCall

---

edit.copy()

edit.copy(): ActionCall

Copies the selected text to the clipboard. Runs when text is selected. Backs the Copy item of the context menu. Mod+C is handled by the editor directly and doesn’t run this action.

Returns

ActionCall

---

edit.paste()

edit.paste(): ActionCall

Pastes the clipboard content at the cursor. Runs when the document has a cursor. Backs the Paste item of the context menu. Mod+V is handled by the editor directly and doesn’t run this action.

Returns

ActionCall

---

edit.paste-without-formatting()

edit.paste-without-formatting(): ActionCall

Pastes the text on the clipboard at the cursor, without its formatting. Runs when the document has a cursor. Backs the Paste without formatting item of the context menu.

Returns

ActionCall

---

edit.delete()

edit.delete(): ActionCall

Deletes the selected text. Runs when text is selected. Backs the Delete item of the context menu. Backspace is handled by the editor directly and doesn’t run this action.

Returns

ActionCall

---

formatting.font-family()

formatting.font-family(fontFamily): ActionCall

Sets the font of the selected text.

Parameters

fontFamily

string

The font family name, such as 'Arial'. Must not be empty.

Returns

ActionCall

---

formatting.font-size()

formatting.font-size(points): ActionCall

Sets the font size of the selected text.

Parameters

points

number

The font size in points. Must be greater than 0.

Returns

ActionCall

---

formatting.bold()

formatting.bold(value?): ActionCall

Makes the selected text bold or removes bold.

Parameters

value?

boolean

true to apply bold, false to remove it. Omit to toggle it.

Returns

ActionCall

---

formatting.italic()

formatting.italic(value?): ActionCall

Makes the selected text italic or removes italic.

Parameters

value?

boolean

true to apply italic, false to remove it. Omit to toggle it.

Returns

ActionCall

---

formatting.underline()

formatting.underline(value?): ActionCall

Underlines the selected text or removes the underline.

Parameters

value?

boolean

true to apply the underline, false to remove it. Omit to toggle it.

Returns

ActionCall

---

formatting.strikethrough()

formatting.strikethrough(value?): ActionCall

Strikes through the selected text or removes the strikethrough.

Parameters

value?

boolean

true to apply the strikethrough, false to remove it. Omit to toggle it.

Returns

ActionCall

---

formatting.subscript()

formatting.subscript(value?): ActionCall

Makes the selected text subscript or puts it back on the baseline.

Parameters

value?

boolean

true to make the text subscript, false to put it on the baseline. Omit to toggle it.

Returns

ActionCall

---

formatting.superscript()

formatting.superscript(value?): ActionCall

Makes the selected text superscript or puts it back on the baseline.

Parameters

value?

boolean

true to make the text superscript, false to put it on the baseline. Omit to toggle it.

Returns

ActionCall

---

formatting.text-color()

formatting.text-color(color): ActionCall

Sets the color of the selected text.

Parameters

color

A hex color. 'none' or null removes the color set on the text, so it shows the color from its style.

`#${string}` | "none" | null

Returns

ActionCall

---

formatting.highlight-color()

formatting.highlight-color(color): ActionCall

Sets the highlight color of the selected text.

Parameters

color

An opaque hex color with 3 or 6 digits. 'none' sets no highlight, which also hides a highlight from the text’s style, as the toolbar does. null removes only the highlight set on the text, so a highlight from its style shows again.

`#${string}` | "none" | null

Returns

ActionCall

---

formatting.clear()

formatting.clear(): ActionCall

Removes the formatting set directly on the selected text and its paragraphs, but keeps their paragraph styles.

Returns

ActionCall

---

insert.line-break()

insert.line-break(): ActionCall

Inserts a line break at the cursor.

Returns

ActionCall

---

insert.page-break()

insert.page-break(): ActionCall

Inserts a page break at the cursor.

Returns

ActionCall

---

insert.section-break-next-page()

insert.section-break-next-page(): ActionCall

Inserts a section break at the cursor. The new section starts on the next page.

Returns

ActionCall

---

insert.image()

insert.image(): ActionCall

Opens a file picker and inserts the chosen PNG or JPEG image at the cursor.

Returns

ActionCall

---

insert.link()

insert.link(): ActionCall

Opens the link editor to add a hyperlink to the selection or at the cursor.

Returns

ActionCall

---

insert.shape()

insert.shape(): ActionCall

Inserts a rectangle shape at the cursor.

Returns

ActionCall

---

insert.text-box()

insert.text-box(): ActionCall

Inserts a text box at the cursor.

Returns

ActionCall

---

insert.field()

insert.field(rule): ActionCall

Inserts a field at the cursor.

Parameters

rule

'pageNum' for the current page number, 'pageCount' for the number of pages, or 'toc' for a table of contents.

"pageNum" | "pageCount" | "toc"

Returns

ActionCall

---

insert.comment()

insert.comment(): ActionCall

Opens the comment editor to comment on the selected text.

Returns

ActionCall

---

comment.reply()

comment.reply(commentId, replyText): ActionCall

Replies to a comment.

Parameters

commentId

string

The ID of the comment. Must not be empty.

replyText

string

The reply text. Must not be empty.

Returns

ActionCall

---

comment.edit()

comment.edit(commentId, newText): ActionCall

Changes the text of a comment or reply.

Parameters

commentId

string

The ID of the comment or reply. Must not be empty.

newText

string

The replacement text. Must not be empty.

Returns

ActionCall

---

comment.resolve()

comment.resolve(commentId): ActionCall

Resolves an open comment or reopens a resolved comment.

Parameters

commentId

string

The ID of the comment. Must not be empty.

Returns

ActionCall

---

comment.delete()

comment.delete(commentId): ActionCall

Deletes a comment or reply.

Parameters

commentId

string

The ID of the comment or reply. Must not be empty.

Returns

ActionCall

---

revision.accept()

revision.accept(revisionId): ActionCall

Accepts a tracked change. The built-in availability check consults canPerformTrackedChange; supplying a custom isEnabled replaces that check. Core still enforces the permission when the built-in handler runs.

Parameters

revisionId

string

The ID of the tracked change. Must not be empty.

Returns

ActionCall

---

revision.reject()

revision.reject(revisionId): ActionCall

Rejects a tracked change. The built-in availability check consults canPerformTrackedChange; supplying a custom isEnabled replaces that check. Core still enforces the permission when the built-in handler runs.

Parameters

revisionId

string

The ID of the tracked change. Must not be empty.

Returns

ActionCall

---

link.edit()

link.edit(): ActionCall

Opens the link editor for the link at the cursor. Runs when the cursor, or the start of the selection, is in a link. Backs the Edit button of the link toolbar and the Edit link item of the context menu.

Returns

ActionCall

---

link.remove()

link.remove(): ActionCall

Removes the link at the cursor and keeps its text. With text selected, removes the links from the selected text. Runs when the cursor, or the start of the selection, is in a link. Backs the Remove button of the link toolbar and the Remove link item of the context menu.

Returns

ActionCall

---

link.open()

link.open(): ActionCall

Opens the link at the cursor in a new browser tab. Opens http, https and mailto links, and adds https:// to a link without a scheme. Runs when the cursor, or the start of the selection, is in a link it can open. Backs the Open link item of the context menu. The link toolbar’s link and Alt+Enter open the link without running this action.

Returns

ActionCall

---

link.copy()

link.copy(): ActionCall

Copies the URL of the link at the cursor to the clipboard: the URL link.open would open, or the link as stored when link.open can’t open it. Runs when the cursor, or the start of the selection, is in a link. Backs the Copy button of the link toolbar and the Copy link URL item of the context menu.

Returns

ActionCall

---

table.insert()

table.insert(): ActionCall

Inserts a table with 3 rows and 3 columns at the cursor.

Returns

ActionCall

---

table.delete()

table.delete(): ActionCall

Deletes the table that contains the cursor.

Returns

ActionCall

---

table.insert-row-above()

table.insert-row-above(): ActionCall

Inserts a row above the current row.

Returns

ActionCall

---

table.insert-row-below()

table.insert-row-below(): ActionCall

Inserts a row below the current row.

Returns

ActionCall

---

table.insert-column-left()

table.insert-column-left(): ActionCall

Inserts a column to the left of the current column.

Returns

ActionCall

---

table.insert-column-right()

table.insert-column-right(): ActionCall

Inserts a column to the right of the current column.

Returns

ActionCall

---

table.delete-row()

table.delete-row(): ActionCall

Deletes the selected rows, or the row that contains the cursor.

Returns

ActionCall

---

table.delete-column()

table.delete-column(): ActionCall

Deletes the selected columns, or the column that contains the cursor.

Returns

ActionCall

---

table.merge-cells()

table.merge-cells(): ActionCall

Merges the selected cells into one cell.

Returns

ActionCall

---

table.split-cells()

table.split-cells(): ActionCall

Unmerges the merged cells in the selection.

Returns

ActionCall

---

table.set-cell-background()

table.set-cell-background(color): ActionCall

Sets the background color of the selected cells.

Parameters

color

A hex color. 'none' or null removes the background.

`#${string}` | "none" | null

Returns

ActionCall

---

table.set-cell-border()

table.set-cell-border(side, color): ActionCall

Sets the color of one border of the selected cells.

Parameters

side

CellBorderSide

The border to change.

color

A hex color. 'none' or null removes the border.

`#${string}` | "none" | null

Returns

ActionCall

---

table.set-cell-border-width()

table.set-cell-border-width(side, points): ActionCall

Sets the width of one border of the selected cells.

Parameters

side

CellBorderSide

The border to change.

points

number

The width in points. Must be 0 or more.

Returns

ActionCall

---

table.set-cell-border-radius()

table.set-cell-border-radius(corners, points): ActionCall

Rounds the corners of the selected cells.

Parameters

corners

'outer' for the corners on the outside of the selection, 'inner' for the corners where its cells meet.

"outer" | "inner"

points

number

The corner radius in points. Must be 0 or more.

Returns

ActionCall

---

table.set-cell-padding()

table.set-cell-padding(side, points): ActionCall

Sets the padding on one side of the selected cells.

Parameters

side

BoxSide

The side of the cells.

points

number

The padding in points. Must be 0 or more.

Returns

ActionCall

---

table.set-wrapping()

table.set-wrapping(floating): ActionCall

Makes the current table float, with text wrapping around it, or places it inline.

Parameters

floating

boolean

true to make the table float, false to place it inline with the text. A table inside a shape can’t float.

Returns

ActionCall

---

table.set-indentation()

table.set-indentation(points): ActionCall

Sets how far the current table is indented from the left margin.

Parameters

points

number

The indentation in points. A negative value moves the table into the margin.

Returns

ActionCall

---

table.set-column-width()

table.set-column-width(width): ActionCall

Sets the width of the current column.

Parameters

width

The width in points, greater than 0, or null for an automatic width.

number | null

Returns

ActionCall

---

view.zoom()

view.zoom(percent): ActionCall

Sets the zoom level.

Parameters

percent

number

The zoom level in percent, from 50 to 400.

Returns

ActionCall

---

view.zoom-in()

view.zoom-in(): ActionCall

Zooms in to the next zoom level.

Returns

ActionCall

---

view.zoom-out()

view.zoom-out(): ActionCall

Zooms out to the previous zoom level.

Returns

ActionCall

---

view.zoom-reset()

view.zoom-reset(): ActionCall

Sets the zoom level to 100%.

Returns

ActionCall

---

view.toggle-ruler()

view.toggle-ruler(visible?): ActionCall

Shows or hides the ruler. The Show ruler checkbox passes its checked state.

Parameters

visible?

boolean

true to show the ruler, false to hide it. Omit to toggle it.

Returns

ActionCall

---

view.toggle-formatting-marks()

view.toggle-formatting-marks(visible?): ActionCall

Shows or hides formatting marks, such as paragraph marks.

Parameters

visible?

boolean

true to show the marks, false to hide them. Omit to toggle them.

Returns

ActionCall

---

view.open-command-palette()

view.open-command-palette(): ActionCall

Opens the command palette.

Returns

ActionCall

---

view.find()

view.find(): ActionCall

Opens the find bar. The toolbar’s Find button runs this action to open the bar, but closes the bar without an action.

Returns

ActionCall

---

view.mode.edit()

view.mode.edit(): ActionCall

Switches the editor to edit mode, where changes apply directly.

Returns

ActionCall

---

view.mode.review()

view.mode.review(): ActionCall

Switches the editor to review mode, where changes are tracked.

Returns

ActionCall

---

view.mode.view()

view.mode.view(): ActionCall

Switches the editor to view mode, where the document is read-only.

Returns

ActionCall

---

layout.align-left()

layout.align-left(): ActionCall

Aligns the selected paragraphs to the left.

Returns

ActionCall

---

layout.align-center()

layout.align-center(): ActionCall

Centers the selected paragraphs.

Returns

ActionCall

---

layout.align-right()

layout.align-right(): ActionCall

Aligns the selected paragraphs to the right.

Returns

ActionCall

---

layout.align-justify()

layout.align-justify(): ActionCall

Justifies the selected paragraphs.

Returns

ActionCall

---

layout.increase-indent()

layout.increase-indent(): ActionCall

Increases the indentation of the selected paragraphs.

Returns

ActionCall

---

layout.decrease-indent()

layout.decrease-indent(): ActionCall

Decreases the indentation of the selected paragraphs.

Returns

ActionCall

---

layout.bulleted-list()

layout.bulleted-list(): ActionCall

Makes the selected paragraphs a bulleted list, or removes the list if it already is one.

Returns

ActionCall

---

layout.numbered-list()

layout.numbered-list(): ActionCall

Makes the selected paragraphs a numbered list, or removes the list if it already is one.

Returns

ActionCall

---

layout.apply-list-preset()

layout.apply-list-preset(preset): ActionCall

Makes the selected paragraphs a list in the given style.

Parameters

preset

A bullet style ('Bullet', 'Diamond', 'Arrow', 'Star', 'Arrowhead') or a numbering style (the other values).

"Bullet" | "Diamond" | "Arrow" | "Star" | "Arrowhead" | "DecimalAndDot" | "LetterAndDot" | "RomanAndDot" | "DecimalAndParenthesis" | "DecimalZero" | "DecimalDeep"

Returns

ActionCall

---

layout.continue-numbering()

layout.continue-numbering(): ActionCall

Makes the current numbered list continue the numbering of the list before it.

Returns

ActionCall

---

layout.line-spacing-single()

layout.line-spacing-single(): ActionCall

Sets single line spacing on the selected paragraphs.

Returns

ActionCall

---

layout.line-spacing-1-5()

layout.line-spacing-1-5(): ActionCall

Sets 1.5 line spacing on the selected paragraphs.

Returns

ActionCall

---

layout.line-spacing-double()

layout.line-spacing-double(): ActionCall

Sets double line spacing on the selected paragraphs.

Returns

ActionCall

---

layout.line-spacing-at-least()

layout.line-spacing-at-least(points): ActionCall

Sets a minimum line height on the selected paragraphs. Taller lines keep their height.

Parameters

points

number

The minimum line height in points. Must be greater than 0.

Returns

ActionCall

---

layout.line-spacing-exactly()

layout.line-spacing-exactly(points): ActionCall

Sets a fixed line height on the selected paragraphs.

Parameters

points

number

The line height in points. Must be greater than 0.

Returns

ActionCall

---

layout.line-spacing-multiple()

layout.line-spacing-multiple(factor): ActionCall

Sets the line spacing of the selected paragraphs as a multiple of single spacing.

Parameters

factor

number

The multiple of single spacing, such as 1.15. Must be greater than 0.

Returns

ActionCall

---

layout.space-before()

layout.space-before(points): ActionCall

Sets the space above the selected paragraphs.

Parameters

points

number

The space in points. Must be 0 or more.

Returns

ActionCall

---

layout.space-after()

layout.space-after(points): ActionCall

Sets the space below the selected paragraphs.

Parameters

points

number

The space in points. Must be 0 or more.

Returns

ActionCall

---

layout.contextual-spacing()

layout.contextual-spacing(value?): ActionCall

Leaves out the space between the selected paragraphs and adjacent paragraphs of the same style, or adds it back.

Parameters

value?

boolean

true to leave the space out, false to add it back. Omit to toggle it.

Returns

ActionCall

---

layout.page-size()

layout.page-size(size): ActionCall

Sets the page size of the current section.

Parameters

size

The paper size.

"Letter" | "A4" | "A5" | "A6"

Returns

ActionCall

---

layout.page-orientation()

layout.page-orientation(orientation): ActionCall

Sets the page orientation of the current section.

Parameters

orientation

The page orientation.

"portrait" | "landscape"

Returns

ActionCall

---

layout.page-margin()

layout.page-margin(side, points): ActionCall

Sets the page margin on one edge of the current section. The ruler runs it when you drag a margin.

Parameters

side

BoxSide

The page edge.

points

number

Distance from the edge, in points. Must be 0 or more.

Returns

ActionCall

---

layout.header-footer-different-first()

layout.header-footer-different-first(enabled): ActionCall

Gives the first page of the current section its own header and footer, or stops doing so. Runs while the cursor is in a header or footer, outside review mode.

Parameters

enabled

boolean

true to give the first page its own header and footer, false to stop.

Returns

ActionCall

---

layout.header-footer-different-odd-even()

layout.header-footer-different-odd-even(enabled): ActionCall

Gives odd and even pages different headers and footers in the whole document, or stops doing so. Runs while the cursor is in a header or footer, outside review mode.

Parameters

enabled

boolean

true to use different headers and footers, false to stop.

Returns

ActionCall

---

layout.header-footer-distance()

layout.header-footer-distance(part, points): ActionCall

Sets the distance between the page edge and the header or footer of the current section. Runs while the cursor is in a header or footer.

Parameters

part

'header' for the distance from the top edge to the header, 'footer' for the distance from the bottom edge to the footer.

"header" | "footer"

points

number

The distance in points. Must be 0 or more.

Returns

ActionCall

---

layout.default-tab-stop()

layout.default-tab-stop(points): ActionCall

Sets the document’s default tab stop interval. Backs the ruler’s default spacing popover.

Parameters

points

number

The interval in points. Must be greater than 0.

Returns

ActionCall

---

style.apply()

style.apply(styleId): ActionCall

Applies a paragraph style to the selected paragraphs.

Parameters

styleId

string

The ID of a style in the document, such as 'Heading 1'.

Returns

ActionCall

---

style.apply-clear()

style.apply-clear(styleId): ActionCall

Applies a paragraph style to the selected paragraphs and removes the formatting set directly on them.

Parameters

styleId

string

The ID of a style in the document, such as 'Heading 1'.

Returns

ActionCall

---

style.update()

style.update(styleId): ActionCall

Changes a style to match the formatting of the selection.

Parameters

styleId

string

The ID of a style in the document, such as 'Heading 1'.

Returns

ActionCall

---

shape.set-type()

shape.set-type(preset): ActionCall

Changes the shape type of the selected shape.

Parameters

preset

ShapePreset

A preset name: 'rect', 'roundRect', 'ellipse', 'triangle', 'rtTriangle', 'diamond', 'parallelogram', 'trapezoid', 'pentagon', 'hexagon', 'octagon', 'star5', 'heart', 'cloud', 'rightArrow', 'leftArrow', 'upArrow', 'downArrow', 'leftRightArrow' or 'wedgeRectCallout'. The selected shape’s current preset is also accepted. Other members of Programmatic.ShapePreset type-check but are rejected at runtime.

Returns

ActionCall

---

shape.set-fill-color()

shape.set-fill-color(color): ActionCall

Sets the fill color of the selected shape. The fill keeps its transparency.

Parameters

color

A hex color, or null to remove the fill.

`#${string}` | null

Returns

ActionCall

---

shape.set-fill-transparency()

shape.set-fill-transparency(percent): ActionCall

Sets the transparency of the selected shape’s fill. Runs when the shape has a fill color.

Parameters

percent

number

From 0 (opaque) to 100 (fully transparent).

Returns

ActionCall

---

shape.set-outline-color()

shape.set-outline-color(color): ActionCall

Sets the outline color of the selected shape.

Parameters

color

A hex color, or null to remove the outline.

`#${string}` | null

Returns

ActionCall

---

shape.set-outline-width()

shape.set-outline-width(points): ActionCall

Sets the outline width of the selected shape.

Parameters

points

number

The width in points. Must be 0 or more. 0 removes the outline.

Returns

ActionCall

---

shape.set-outline-transparency()

shape.set-outline-transparency(percent): ActionCall

Sets the transparency of the selected shape’s outline. Runs when the outline has a color.

Parameters

percent

number

From 0 (opaque) to 100 (fully transparent).

Returns

ActionCall

---

shape.set-text-padding()

shape.set-text-padding(side, value, unit): ActionCall

Sets the space between one edge of the selected shape and its text.

Parameters

side

BoxSide

The edge of the shape.

value

number

The space, in unit. Must be 0 or more.

unit

Unit

The unit of value.

Returns

ActionCall

---

shape.set-wrapping()

shape.set-wrapping(mode): ActionCall

Sets how the selected shape sits in the text.

Parameters

mode

'inline' places the shape in the line of text. The other modes make it float: 'square' wraps text around its box, 'topAndBottom' keeps text above and below it, and 'behind' and 'front' place it behind or in front of the text. A shape inside another shape can only be 'inline'.

"inline" | "square" | "topAndBottom" | "behind" | "front"

Returns

ActionCall

---

object.set-wrapping()

object.set-wrapping(mode, offset?): ActionCall

Sets how the selected image or shape sits in the text. Runs when an image or shape is selected, unless it is inline inside a shape’s text. Backs the Text Wrapping menu of the context menu.

Parameters

mode

'inline' places the object in the line of text. The other modes make it float: 'square' wraps text around its box, 'topAndBottom' keeps text above and below it, and 'behind' and 'front' place it behind or in front of the text. An object inside a shape’s text can only be 'inline'.

"inline" | "square" | "topAndBottom" | "behind" | "front"

offset?

Where an inline object goes when it starts to float, in points from the top left corner of the page. Omit to place it in that corner.

x

number

y

number

Returns

ActionCall

---

object.arrange()

object.arrange(order): ActionCall

Moves the selected floating image or shape in front of or behind the other floating objects. Runs when the selected object floats. Backs the Bring to Front and Send to Back menus of the context menu.

Parameters

order

'front' moves the object in front of all the others, 'forward' one step forward, 'backward' one step back, and 'back' behind all the others.

"front" | "forward" | "back" | "backward"

Returns

ActionCall

---

field.update()

field.update(): ActionCall

Updates the value of the field at the cursor, such as a table of contents. Runs when the cursor is in a field, except a page number or page count field in a header or footer, which updates on every page. Backs the Update field item of the context menu.

Returns

ActionCall

---

field.change()

field.change(rule): ActionCall

Changes the type of the field at the cursor. Runs when the cursor is in a page number or page count field. Backs the Edit field menu of the context menu.

Parameters

rule

'pageNum' for the current page number or 'pageCount' for the number of pages.

"pageNum" | "pageCount"

Returns

ActionCall

---

spellcheck.replace()

spellcheck.replace(clusterBegin, clusterEnd, replacement): ActionCall

Replaces a misspelled word in the paragraph at the cursor. Backs the spelling suggestions of the context menu and of the popup that opens when you click a misspelled word.

Parameters

clusterBegin

number

Where the word starts, as a character cluster index in the paragraph. A whole number, 0 or more.

clusterEnd

number

Where the word ends, as a character cluster index in the paragraph. A whole number, 0 or more.

replacement

string

The text to put in place of the word. Must not be empty.

Returns

ActionCall

---

paragraph.set-shading()

paragraph.set-shading(color): ActionCall

Sets the background color of the selected paragraphs.

Parameters

color

A hex color. 'none' or null removes the background.

`#${string}` | "none" | null

Returns

ActionCall

---

paragraph.set-border-color()

paragraph.set-border-color(side, color): ActionCall

Sets the color of one border of the selected paragraphs. A border without a width gets a width of 1 point.

Parameters

side

ParagraphBorderSide

The border to change.

color

A hex color, or null to remove the border. With 'none', the border keeps its width but has no color.

`#${string}` | "none" | null

Returns

ActionCall

---

paragraph.set-border-width()

paragraph.set-border-width(side, points): ActionCall

Sets the width of one border of the selected paragraphs.

Parameters

side

ParagraphBorderSide

The border to change.

points

number

The width in points. Must be 0 or more.

Returns

ActionCall

---

paragraph.set-border-radius()

paragraph.set-border-radius(corners, points): ActionCall

Rounds the corners of the border around the selected paragraphs.

Parameters

corners

'Outer' for the outer corners of the border, 'Inner' for the corners where consecutive bordered paragraphs meet.

"Outer" | "Inner"

points

number

The corner radius in points. Must be 0 or more.

Returns

ActionCall

---

paragraph.set-indent()

paragraph.set-indent(side, points): ActionCall

Sets an indent of the paragraphs at the caret or in the selection. Backs the ruler markers. A first-line position left of the left indent creates a hanging indent.

Parameters

side

The indent to set.

"left" | "right" | "first-line"

points

number

The position in points from the left margin, or from the right margin for the right indent. Negative positions are allowed.

Returns

ActionCall

---

paragraph.change-tab-stops()

paragraph.change-tab-stops(changes): ActionCall

Changes the tab stops of the paragraphs at the caret or in the selection. Backs the ruler’s tab stop markers and popovers. Positions are in points from the left margin.

Parameters

changes

object[]

A non-empty list. Each change needs from, to, or both. to alone adds a stop, from alone removes a stop matching its position, alignment and leader, and both replace it. A single removal or update leaves paragraphs without a matching stop unchanged; multiple changes rewrite the stops of every selected paragraph.

Returns

ActionCall