Skip to main content

insertPage

This function inserts a new page into the document at a specified location.

Prompts​

  • Insert a page at the current location
  • Add a page at the end of the document
  • Add a page at the start of the document

Function registration​

let func = new RegisteredFunction();
func.name = "insertPage";
func.params = [
    "location (string): where to insert the new page ('current', 'start', or 'end')"
];

func.examples = [
    "If you need to insert blank page to the current location, respond with:" +
    "[functionCalling (insertPage)]: {\"location\": \"current\"}",

    "If you need to add page to the end of the document, respond with:" +
    "[functionCalling (insertPage)]: {\"location\": \"end\"}",

    "If you need to add page to the start of the document, respond with:" +
    "[functionCalling (insertPage)]: {\"location\": \"start\"}"
];

Parameters​

NameTypeExampleDescription
locationstring"current"Specifies where to insert a new page ("current", "start", or "end").

Function execution​

func.call = async function(params) {
    Asc.scope.location = params.location;

    await Asc.Editor.callCommand(function(){
        let doc = Api.GetDocument();
        if ("start" === Asc.scope.location)
            doc.MoveCursorToStart();
        else if ("end" === Asc.scope.location)
            doc.MoveCursorToEnd();

        Api.GetDocument().InsertBlankPage();
    });
};

return func;

Methods used: GetDocument, MoveCursorToStart, MoveCursorToEnd, InsertBlankPage, Asc.scope object

Result​

insertPage insertPage