XLSX: Работа с комментариями на странице XLSX-документа

В этом разделе

UI-контрол WebSpreadsheetEditorControlJS позволяет работать (просматривать, добавлять, редактировать и удалять) с комментариями к ячейкам на листе XLSX-документа в веб-браузере.
Комментарии к ячейкам можно изменять вручную с помощью мыши/клавиатуры или программным способом.

Добавление комментария к выделенной ячейке на листе XLSX-документа.

Если вы хотите добавить комментарий к выделенной ячейке на листе XLSX-документа с помощью мыши, выполните следующие действия:

Нажмите на вкладку "Review" в UI-контроле WebSpreadsheetDocumentEditorControlJS.
Нажмите кнопку "Insert comment". Откроется диалоговое окно "Insert comment". Введите имя автора комментария и установите флажок "Show author", если имя автора должно отображаться рядом с комментарием. Затем введите текст комментария и нажмите кнопку "OK". Диалоговое окно закроется, и комментарий будет добавлен к выделенной ячейке.

Вот JavaScript код, который демонстрирует, как добавить комментарий к выделенной ячейке на листе XLSX-документа:

JavaScript

// _spreadsheetDocumentEditorControl is an instance of WebSpreadsheetDocumentEditorControlJS class

// get spreadsheet editor
var spreadsheetEditorControl = _spreadsheetDocumentEditorControl.get_SpreadsheetEditorControl();


// prepare parameters of comment

// comment author
var commentAuthor = "Persona";
// a value indicating whether author name must be shown in comment
var showAuthor = true;
// comment text
var commentText = "Test comment text";

// add comment to the focused cell
spreadsheetEditorControl.insertComment(commentAuthor, showAuthor, commentText);

Редактирование комментария к выделенной ячейке на листе XLSX-документа.

Если вы хотите отредактировать комментарий к выделенной ячейке на листе XLSX-документа с помощью мыши, выполните следующие действия:

Нажмите на вкладку "Review" в UI-контроле WebSpreadsheetDocumentEditorControlJS.
Нажмите на комментарий, который необходимо отредактировать.
Нажмите кнопку "Edit comment". Откроется диалоговое окно "Edit comment". При необходимости измените имя автора комментария. При необходимости измените состояние флажка "Show author". При необходимости измените текст комментария. Затем нажмите кнопку "OK" - диалоговое окно закроется, и комментарий будет обновлён.

Вот JavaScript код, который демонстрирует, как изменить комментарий к выделенной ячейке на листе XLSX-документа:

JavaScript

// _spreadsheetDocumentEditorControl is an instance of WebSpreadsheetDocumentEditorControlJS class

// get spreadsheet editor
var spreadsheetEditorControl = _spreadsheetDocumentEditorControl.get_SpreadsheetEditorControl();

// if focused cell does not have comment
if (!spreadsheetEditorControl.get_IsCellHasComment()) {
    throw new Error("Focused cell does not have comment.");
}


// prepare parameters of comment

// get the author ("Persona") of focused comment
var author = spreadsheetEditorControl.get_CommentAuthor();
// change the author
author += "2";

// get a value indicating whether author name must be shown in comment
var showAuthor = spreadsheetEditorControl.get_CommentShowAuthor();

// get the text ("Test comment text") of focused comment
var text = spreadsheetEditorControl.get_CommentShowText();
// change the text
text = "Edited " + text;


// edit comment for focused cell
spreadsheetEditorControl.editComment(author, showAuthor, text);

Изменение размера комментария к выделенной ячейке на листе XLSX-документа.

Если вы хотите изменить размер комментария к выделенной ячейке на листе XLSX-документа с помощью мыши, выполните следующие действия:

Нажмите на комментарий, размер которого требуется изменить. Вы увидите 8 точек изменения размера, позволяющих изменить размер комментария с помощью мыши.
Щёлкните по любой точке изменения размера и переместите мышь, чтобы изменить размер комментария.

Перемещение комментария к выделенной ячейке на листе XLSX-документа.

Если вы хотите переместить (изменить положение) комментарий к выделенной ячейке на листе XLSX-документа с помощью мыши, выполните следующие действия:

Наведите курсор мыши на комментарий. Вы увидите курсор перемещения.
Щёлкните по комментарию и переместите мышь в новое положение комментария.

Изменение свойств шрифта выделенного комментария на листе XLSX-документа.

Если вы хотите изменить свойства шрифта для выделенного комментария на листе XLSX-документа с помощью мыши, выполните следующие действия:

Нажмите на вкладку "Home" в UI-контроле WebSpreadsheetDocumentEditorControlJS.
Нажмите на комментарий, который требуется изменить.
Используйте выпадающие элементы "Font name" и "Font size", если вы хотите изменить шрифт выделенного комментария.
Нажмите кнопки "Bold text", "Italic text", "Underline text" или "Strikethrought text", если хотите использовать жирный шрифт/курсив/подчёркивание/зачёркивание для текста выделенного комментария.
Используйте инструмент выбора цвета "Font color", если вы хотите изменить цвет текста выделенного комментария.

Вот JavaScript код, который демонстрирует, как изменить свойства шрифта для выделенного комментария на листе XLSX-документа:

JavaScript

// _spreadsheetDocumentEditorControl is an instance of WebSpreadsheetDocumentEditorControlJS class

// get spreadsheet editor
var spreadsheetEditorControl = _spreadsheetDocumentEditorControl.get__spreadsheetDocumentEditorControl();

// if comment is not focused
if (!spreadsheetEditorControl.get_IsCommentFocused()) {
    // if focused cell has comment
    if (spreadsheetEditorControl.get_IsCellHasComment()) {
        // focus the comment of focused cell
        spreadsheetEditorControl.focusCommentFromFocusedCell();
    }
    else {
        throw new Error("Focused cell does not have comment.");
    }
}

// get the font name for focused comment
var fontName = _spreadsheetDocumentEditorControl.get_FontName();
// set new font name
_spreadsheetDocumentEditorControl.set_FontName("Impact");

// get the font size for focused comment
var fontSize = _spreadsheetDocumentEditorControl.get_FontSize();
// set new font size
_spreadsheetDocumentEditorControl.set_FontSize(16);


// get the bold text status for focused comment
var isBold = _spreadsheetDocumentEditorControl.get_IsFontBold();
// set new boldness status
_spreadsheetDocumentEditorControl.set_IsFontBold(true);

// get the italic text status for focused comment
var isItalic = _spreadsheetDocumentEditorControl.get_IsFontItalic();
// set new italic text status
_spreadsheetDocumentEditorControl.set_IsFontItalic(true);

// get the underline text status for focused comment
var isUnderline = _spreadsheetDocumentEditorControl.get_IsFontUnderline();
// set new underline text status
_spreadsheetDocumentEditorControl.set_IsFontUnderline(true);

// get the strikeout text status for focused comment
var isStrikeout = _spreadsheetDocumentEditorControl.get_IsFontStrikeout();
// set new strikeout text status
_spreadsheetDocumentEditorControl.set_IsFontStrikeout(true);


// get font color (for example, "rgba(0,0,0,1)") for focused comment
var fontColor = _spreadsheetDocumentEditorControl.get_FontColor();

// get a string that represents HTML color ("black", "red", "transparent", "rgb(255,255,255)", "rgba(255,255,255,0.5)")
var htmlColor = "teal";
// set new font color
_spreadsheetDocumentEditorControl.set_FontColor(htmlColor);

Изменение свойств текста выделенного комментария на листе XLSX-документа.

Если вы хотите изменить свойства текста выделенного комментария на листе XLSX-документа с помощью мыши, выполните следующие действия:

Используйте кнопки "Align left", "Center" и "Align right", если требуется изменить горизонтальное выравнивание текста выделенного комментария.
Нажмите на комментарий, который требуется изменить.
Используйте кнопки "Top align", "Middle align" и "Bottom align", если требуется изменить вертикальное выравнивание текста выделенного комментария.
Вот JavaScript код, который демонстрирует, как изменить свойства текста выделенного комментария на листе XLSX-документа:

Изменение цвета фона выделенного комментария на листе XLSX-документа.

JavaScript

// _spreadsheetDocumentEditorControl is an instance of WebSpreadsheetDocumentEditorControlJS class

// get spreadsheet editor
var spreadsheetEditorControl = _spreadsheetDocumentEditorControl.get__spreadsheetDocumentEditorControl();

// if comment not focused
if (!spreadsheetEditorControl.get_IsCommentFocused()) {
    // if focused cell has comment
    if (spreadsheetEditorControl.get_IsCellHasComment()) {
        // focus the comment of focused cell
        spreadsheetEditorControl.focusCommentFromFocusedCell();
    }
    else {
        throw new Error("Focused cell does not have comment.");
    }
}

// get the text horizontal alignment for focused comment
var textHorizontalAlign = _spreadsheetDocumentEditorControl.get_TextHorizontalAlign();

// create value that defines horizontal alignment
var horizontalAlign = Vintasoft.Imaging.Office.WebTextHorizontalAlignEnumJS("Center");
// set new text horizontal alignment
_spreadsheetDocumentEditorControl.set_TextHorizontalAlign(horizontalAlign);


// get the text vertical alignment for focused comment
var textVerticalAlign = _spreadsheetDocumentEditorControl.get_TextVerticalAlign();

// create value that defines vertical alignment
var verticalAlign = Vintasoft.Imaging.Office.WebTextVerticalAlignEnumJS("Bottom");
// set new text vertical alignment
_spreadsheetDocumentEditorControl.set_TextVerticalAlign(verticalAlign);

Если вы хотите изменить цвет фона выделенного комментария на листе XLSX-документа с помощью мыши, выполните следующие действия:

Нажмите на комментарий, который необходимо изменить.

Используйте кнопки "Align left", "Center" и "Align right", если требуется изменить горизонтальное выравнивание текста выделенного комментария.
Нажмите на комментарий, который требуется изменить.
Используйте инструмент выбора цвета "Fill color".

Вот JavaScript код, который демонстрирует, как изменить цвет фона выделенного комментария на листе XLSX-документа:

JavaScript

// _spreadsheetDocumentEditorControl is an instance of WebSpreadsheetDocumentEditorControlJS class

// get spreadsheet editor
var spreadsheetEditorControl = _spreadsheetDocumentEditorControl.get_SpreadsheetEditorControl();

// if comment is not focused
if (!spreadsheetEditorControl.get_IsCommentFocused()) {
    // if focused cell has comment
    if (spreadsheetEditorControl.get_IsCellHasComment()) {
        // focus the comment of focused cell
        spreadsheetEditorControl.focusCommentFromFocusedCell();
    }
    else {
        throw new Error("Focused cell does not have comment.");
    }
}

// get the background color (for example, "rgba(255,255,225,1)") of focused comment
var backgroundColor = _spreadsheetDocumentEditorControl.get_FillColor();

// create a string that represents HTML color ("black", "red", "transparent", "rgb(255,255,255)", "rgba(255,255,255,0.5)")
var htmlColor = "rgb(200,150,200)";
// set new background color for focused comment
_spreadsheetDocumentEditorControl.set_FillColor(htmlColor);

Удаление комментария к выделенной ячейке на листе XLSX-документа.

Если вы хотите удалить выделенный комментарий на листе XLS-документа, выполните следующие действия:

Нажмите на вкладку "Review" в UI-контроле WebSpreadsheetDocumentEditorControlJS.
Нажмите на комментарий, который необходимо удалить.
Нажмите кнопку "Delete comment", и комментарий будет удалён.

Вот JavaScript-код, который демонстрирует, как удалить комментарий активной ячейки на XLSX-листе:

JavaScript

// _spreadsheetDocumentEditorControl is an instance of WebSpreadsheetDocumentEditorControlJS class

// get spreadsheet editor
var spreadsheetEditorControl = _spreadsheetDocumentEditorControl.get_SpreadsheetEditorControl();

// if focused cell does not have comment
if (!spreadsheetEditorControl.get_IsCellHasComment()) {
    throw new Error("Focused cell does not have comment.");
}

// delete comment in focused cell
spreadsheetEditorControl.deleteComment();

Отправить отзыв