Выбор элементов в презентации

Выбором является все, что в данный момент выбрано на открытой странице презентации, например выделенный фрагмент текста или таблица. В этом руководстве рассказывается, как получить и настроить выделение в активной презентации с помощью Apps Script.

Выбор представляет собой снимок того, что было при запуске сценария. Если пользователь щелкнет мышью и выбор изменится во время выполнения сценария, эти изменения не будут отражены.

Выборки и тип выборки

Вы можете прочитать выборку, используя класс Selection . Класс имеет различные методы для получения выбранных объектов в зависимости от типа выбранных объектов.

Перечисление SelectionType представляет конкретный тип выбранных объектов. Например, если пользователь выделил какой-либо текст в фигуре, типом выделения будет ТЕКСТ . В этом случае вы можете получить выделенный диапазон текста, используя selection.getTextRange() .

Вы также можете получить объект, содержащий выделение; продолжая приведенный выше пример, вы можете получить фигуру, содержащую выделенный текст, используя selection.getPageElementRange().getPageElements()[0] . Аналогично, страница, содержащая включающую фигуру, является текущей активной страницей; чтобы получить эту страницу, используйте selection.getCurrentPage() .

Читаем подборку

Чтобы прочитать выборку, используйте метод Presentation.getSelection(), как показано в следующем примере:

слайды/выбор/selection.gs
const selection = SlidesApp.getActivePresentation().getSelection();

Чтение текущей страницы

Чтобы получить текущую страницу , которую просматривает пользователь, используйте методы getSelection() и getCurrentPage() следующим образом:

слайды/выбор/selection.gs
const currentPage = SlidesApp.getActivePresentation().getSelection().getCurrentPage();

Обратите внимание, что текущая страница может быть любого из следующих типов:

На текущей странице может быть выбран один или несколько объектов, а SelectionType определяет тип выбора.

Чтение выборки на основе типа выборки

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

слайды/выбор/selection.gs
const selection = SlidesApp.getActivePresentation().getSelection();
const selectionType = selection.getSelectionType();
let currentPage;
switch (selectionType) {
  case SlidesApp.SelectionType.NONE:
    console.log('Nothing selected');
    break;
  case SlidesApp.SelectionType.CURRENT_PAGE:
    currentPage = selection.getCurrentPage();
    console.log('Selection is a page with ID: ' + currentPage.getObjectId());
    break;
  case SlidesApp.SelectionType.PAGE_ELEMENT:
    const pageElements = selection.getPageElementRange().getPageElements();
    console.log('There are ' + pageElements.length + ' page elements selected.');
    break;
  case SlidesApp.SelectionType.TEXT:
    const tableCellRange = selection.getTableCellRange();
    if (tableCellRange !== null) {
      const tableCell = tableCellRange.getTableCells()[0];
      console.log('Selected text is in a table at row ' +
        tableCell.getRowIndex() + ', column ' +
        tableCell.getColumnIndex());
    }
    const textRange = selection.getTextRange();
    if (textRange.getStartIndex() === textRange.getEndIndex()) {
      console.log('Text cursor position: ' + textRange.getStartIndex());
    } else {
      console.log('Selection is a text range from: ' + textRange.getStartIndex() + ' to: ' +
        textRange.getEndIndex() + ' is selected');
    }
    break;
  case SlidesApp.SelectionType.TABLE_CELL:
    const tableCells = selection.getTableCellRange().getTableCells();
    const table = tableCells[0].getParentTable();
    console.log('There are ' + tableCells.length + ' table cells selected.');
    break;
  case SlidesApp.SelectionType.PAGE:
    const pages = selection.getPageRange().getPages();
    console.log('There are ' + pages.length + ' pages selected.');
    break;
  default:
    break;
}

Чтение выделенного текста

Вы можете прочитать выделенный текст с помощью метода Selection.getTextRange() . Существует два типа выделения текста:

  • Выбор диапазона : если фигура содержит текст «Привет» и выбран «Он», возвращаемый диапазон имеет startIndex=0 и endIndex=2.
  • Выбор курсора : если фигура содержит текст «Привет», а курсор находится после «H» («Привет | привет»), возвращаемый диапазон представляет собой пустой диапазон с startIndex=1 и endIndex=1.

Изменение выделения

Скрипт может изменить выбор пользователя. Любые изменения выбора, которые сценарий вносит в презентацию, отражаются в последующих операциях выбора на протяжении всего выполнения сценария.

Изменения выбора отражаются в браузере пользователя только после завершения выполнения сценария или при вызове Presentation.saveAndClose() .

Выбор текущей страницы

Страницу в активной презентации можно выбрать в качестве текущей, вызвав метод selectAsCurrentPage() . Этот метод удаляет любой предыдущий элемент страницы, страницу или выделение текста. Таким образом, использование этого метода на текущей странице позволяет вам отменить выбор любого текущего выбора на странице. Например:

слайды/выбор/selection.gs
// Select the first slide as the current page selection and remove any previous selection.
  const selection = SlidesApp.getActivePresentation().getSelection();
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  slide.selectAsCurrentPage();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.CURRENT_PAGE
// selection.getCurrentPage() = slide
//

Выбор элемента страницы

Чтобы выбрать элемент страницы на странице, используйте метод PageElement.select() . Это также отменяет выбор любых ранее выбранных элементов страницы.

Например:

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const pageElement = slide.getPageElements()[0];
  // Only select this page element and remove any previous selection.
  pageElement.select();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.PAGE_ELEMENT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements()[0] = pageElement
//

Выбор нескольких элементов страницы

Чтобы добавить к выделению дополнительные элементы страницы, используйте метод PageElement.select(false) . Все элементы страницы должны находиться на текущей странице.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  // First select the slide page, as the current page selection.
  slide.selectAsCurrentPage();
  // Then select all the page elements in the selected slide page.
  const pageElements = slide.getPageElements();
  for (let i = 0; i < pageElements.length; i++) {
    pageElements[i].select(false);
  }
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.PAGE_ELEMENT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements() = pageElements
//

Преобразование выделения

Изменения, выполняемые вашим сценарием, могут преобразовать текущий выбор, так что выбранное изменится в результате редактирования. Например:

  1. Предположим, у вас выбраны две фигуры A и B.
  2. Затем ваш скрипт удаляет фигуру A.
  3. В результате выделение преобразуется в соответствии с редактированием, так что выделяется только форма B.

В следующем примере показано, как можно преобразовать выделение путем манипулирования выбранными элементами страницы.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const shape1 = slide.getPageElements()[0].asShape();
  const shape2 = slide.getPageElements()[1].asShape();
  // Select both the shapes.
  shape1.select();
  shape2.select(false);
  // State of selection
  //
  // selection.getSelectionType() = SlidesApp.SelectionType.PAGE_ELEMENT
  // selection.getCurrentPage() = slide
  // selection.getPageElementRange().getPageElements() = [shape1, shape2]
  //
  // Remove one shape.
  shape2.remove();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.PAGE_ELEMENT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements() = [shape1]
//

Выбор текста

Текст, содержащийся в фигуре или в ячейке таблицы, можно выбрать с помощью метода TextRange.select() . Если текст содержится в фигуре, эта фигура также выбирается. Если текст содержится в ячейке таблицы, то выбираются как эта ячейка таблицы, так и включающая ее таблица.

Это также устанавливает родительскую страницу в качестве текущей страницы.

Выбор диапазона в фигуре

В следующем примере показано, как выделить диапазон внутри текста, содержащегося в фигуре.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const shape = slide.getPageElements()[0].asShape();
  shape.getText().setText('Hello');
  // Range selection: Select the text range 'He'.
  shape.getText().getRange(0, 2).select();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.TEXT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements()[0] = shape
// selection.getTextRange().getStartIndex() = 0
// selection.getTextRange().getEndIndex() = 2
//

Выбор курсора в фигуре

В следующем примере показано, как выделить курсором текст, содержащийся в фигуре.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const shape = slide.getPageElements()[0].asShape();
  shape.getText().setText('Hello');
  // Cursor selection: Place the cursor after 'H' like 'H|ello'.
  shape.getText().getRange(1, 1).select();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.TEXT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements()[0] = shape
// selection.getTextRange().getStartIndex() = 1
// selection.getTextRange().getEndIndex() = 1
//

Выбор диапазона в ячейке таблицы

В следующем примере показано, как сделать выбор диапазона в тексте, содержащемся в ячейке таблицы.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const table = slide.getPageElements()[0].asTable();
  const tableCell = table.getCell(0, 1);
  tableCell.getText().setText('Hello');
  // Range selection: Select the text range 'He'.
  tableCell.getText().getRange(0, 2).select();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.TEXT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements()[0] = table
// selection.getTableCellRange().getTableCells()[0] = tableCell
// selection.getTextRange().getStartIndex() = 0
// selection.getTextRange().getEndIndex() = 2
//

Выбор курсора в TableCell

В следующем примере показано, как выделить курсором текст, содержащийся в ячейке таблицы.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const table = slide.getPageElements()[0].asTable();
  const tableCell = table.getCell(0, 1);
  tableCell.getText().setText('Hello');
  // Cursor selection: Place the cursor after 'H' like 'H|ello'.
  tableCell.getText().getRange(1, 1).select();
// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.TEXT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements()[0] = table
// selection.getTableCellRange().getTableCells()[0] = tableCell
// selection.getTextRange().getStartIndex() = 1
// selection.getTextRange().getEndIndex() = 1
//

Преобразование выделения с текстовым редактированием

В следующем примере показано, как можно преобразовать выделение путем редактирования выделенного текста.

слайды/выбор/selection.gs
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  const shape = slide.getPageElements()[0].asShape();
  const textRange = shape.getText();
  textRange.setText('World');
  // Select all the text 'World'.
  textRange.select();
  // State of selection
  //
  // selection.getSelectionType() = SlidesApp.SelectionType.TEXT
  // selection.getCurrentPage() = slide
  // selection.getPageElementRange().getPageElements()[0] = shape
  // selection.getTextRange().getStartIndex() = 0
  // selection.getTextRange().getEndIndex() = 6
  //
  // Add some text to the shape, and the selection will be transformed.
  textRange.insertText(0, 'Hello ');

// State of selection
//
// selection.getSelectionType() = SlidesApp.SelectionType.TEXT
// selection.getCurrentPage() = slide
// selection.getPageElementRange().getPageElements()[0] = shape
// selection.getTextRange().getStartIndex() = 0
// selection.getTextRange().getEndIndex() = 12
//

Отмена выбора

Не существует явных методов для отмены выделения текста или элементов страницы. Однако этого результата можно добиться с помощью методов Page.selectAsCurrentPage() или pageElement.select() .

Выберите текущую страницу

В следующем примере показано, как отменить выбор любых текущих элементов на странице, установив эту страницу в качестве текущей.

слайды/выбор/selection.gs
// Unselect one or more page elements already selected.
//
// In case one or more page elements in the first slide are selected, setting the
// same (or any other) slide page as the current page would do the unselect.
//
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  slide.selectAsCurrentPage();

Выберите элемент страницы

В следующем примере показано, как отменить выбор любых текущих элементов на странице, выбрав один элемент страницы и удалив тем самым все остальные элементы из выбора.

слайды/выбор/selection.gs
// Unselect one or more page elements already selected.
//
// In case one or more page elements in the first slide are selected,
// selecting any pageElement in the first slide (or any other pageElement) would
// do the unselect and select that pageElement.
//
  const slide = SlidesApp.getActivePresentation().getSlides()[0];
  slide.getPageElements()[0].select();