Skip to main content

changeTextStyle

This function modifies the visual style of the selected text. If no text is selected, the current word is used by default.

Prompts​

  • Make this text bold and underlined
  • Underline this text
  • Strike out this text
  • Set the font size of this text to 18
  • Make this text non-italic

Function registration​

let func = new RegisteredFunction();
func.name = "changeTextStyle";
func.params = [
    "bold (boolean): whether to make the text bold",
    "italic (boolean): whether to make the text italic",
    "underline (boolean): whether to underline the text",
    "strikeout (boolean): whether to strike out the text",
    "fontSize (number): font size to apply to the selected text"
];

func.examples = [
    "If you need to make selected text bold and italic, respond with:" +
    "[functionCalling (changeTextStyle)]: {\"bold\": true, \"italic\": true }",

    "If you need to underline the selected text, respond with:" +
    "[functionCalling (changeTextStyle)]: {\"underline\": true }",

    "If you need to strike out the selected text, respond with:" +
    "[functionCalling (changeTextStyle)]: {\"strikeout\": true }",

    "If you need to set the font size of selected text to 18, respond with:" +
    "[functionCalling (changeTextStyle)]: {\"fontSize\": 18 }",

    "If you need to make selected text bold, respond with:" +
    "[functionCalling (changeTextStyle)]: {\"bold\": true }",

    "If you need to make selected text non-italic, respond with:" +
    "[functionCalling (changeTextStyle)]: {\"italic\": false }"
];

Parameters​

NameTypeExampleDescription
boldbooleantrueSpecifies whether to make the text bold.
italicbooleantrueSpecifies whether to make the text italic.
underlinebooleantrueSpecifies whether to underline the text.
strikeoutbooleantrueSpecifies whether to strike out the text.
fontSizenumber18The font size to apply to the selected text.

Function execution​

func.call = async function(params) {
    Asc.scope.bold = params.bold;
    Asc.scope.italic = params.italic;
    Asc.scope.underline = params.underline;
    Asc.scope.strikeout = params.strikeout;
    Asc.scope.fontSize = params.fontSize;
    await Asc.Editor.callCommand(function(){
        let doc = Api.GetDocument();
        let range = doc.GetRangeBySelect();
        if (!range || "" === range.GetText())
        {
            doc.SelectCurrentWord();
            range = doc.GetRangeBySelect();
        }

        if (!range)
            return;

        if (undefined !== Asc.scope.bold)
            range.SetBold(Asc.scope.bold);

        if (undefined !== Asc.scope.italic)
            range.SetItalic(Asc.scope.italic);

        if (undefined !== Asc.scope.underline)
            range.SetUnderline(Asc.scope.underline);

        if (undefined !== Asc.scope.strikeout)
            range.SetStrikeout(Asc.scope.strikeout);

        if (undefined !== Asc.scope.fontSize)
            range.SetFontSize(Asc.scope.fontSize);
    });
};

return func;

Methods used: GetDocument, GetRangeBySelect, GetText, SelectCurrentWord, SetBold, SetItalic, SetUnderline, SetStrikeout, SetFontSize, Asc.scope object

Result​

changeTextStyle changeTextStyle