Seleccionar elementos dentro de una presentación

La selección es lo que se selecciona actualmente en una página de presentación abierta, como un tramo de texto destacado o una tabla. En esta guía, se explica cómo obtener y establecer la selección en una presentación activa con Apps Script.

Una secuencia de comandos solo puede acceder a la selección del usuario que la ejecuta.

La selección es una instantánea de lo que era cuando se inició el guion. Si el usuario hace clic y la selección cambia mientras se ejecuta la secuencia de comandos, esos cambios no se reflejarán.

Selecciones y tipo de selección

Puedes leer la selección con la clase Selection. La clase tiene varios métodos para obtener los objetos seleccionados según el tipo de objetos seleccionados.

La enumeración SelectionType representa el tipo específico de objetos seleccionados. Por ejemplo, si el usuario seleccionó texto en una forma, el tipo de selección será TEXT. En este caso, puedes recuperar el rango de texto seleccionado con el método selection.getTextRange().

También puedes recuperar el objeto que contiene la selección. Continuando con el ejemplo anterior, podrías recuperar la forma que contiene el texto seleccionado con selection.getPageElementRange().getPageElements()[0]. Del mismo modo, la página que contiene la forma envolvente es la página activa actual. Para recuperar esa página, usa selection.getCurrentPage().

Cómo leer la selección

Para leer la selección, usa el método Presentation.getSelection(), como se muestra en el siguiente ejemplo:

slides/selection/selection.gs

Ver en GitHub

const selection = SlidesApp.getActivePresentation().getSelection();

Lectura de la página actual

Para recuperar el objeto Page actual que está viendo el usuario, usa los métodos getSelection() y getCurrentPage() de la siguiente manera:

slides/selection/selection.gs

Ver en GitHub

const currentPage = SlidesApp.getActivePresentation().getSelection().getCurrentPage();

Ten en cuenta que la página actual puede ser cualquiera de los siguientes tipos:

• Diapositiva
• Master
• Diseño

La página actual puede tener uno o más objetos seleccionados, y SelectionType determina el tipo de selección.

Lectura de la selección según el tipo de selección

En el siguiente ejemplo, se muestra cómo puedes usar el tipo de selección para leer la selección actual de una manera adecuada para el tipo.

slides/selection/selection.gs

Ver en GitHub

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;
}

Lectura de selecciones de texto

Puedes leer la selección de texto con el método Selection.getTextRange(). Existen dos tipos de selección de texto:

• Selección de rango: Si una forma contiene el texto "Hola" y se selecciona "Ho", el rango devuelto tiene startIndex=0 y endIndex=2.
• Selección con el cursor: Si una forma contiene el texto "Hola" y el cursor se encuentra después de la "H" ("H|ola"), el rango devuelto es un rango vacío con startIndex=1 y endIndex=1.

Cómo modificar la selección

La secuencia de comandos puede modificar la selección del usuario. Cualquier cambio de selección que realice la secuencia de comandos en la presentación se reflejará en las operaciones de selección posteriores durante la ejecución de la secuencia de comandos.

Los cambios en la selección se reflejan en el navegador del usuario solo después de que se completa la ejecución de la secuencia de comandos o cuando se llama a Presentation.saveAndClose().

Cómo seleccionar la página actual

Se puede seleccionar una página de la presentación activa como la página actual llamando al método selectAsCurrentPage(). Este método quita cualquier elemento de página, página o selección de texto anterior. Por lo tanto, usar este método en la página actual te permite anular cualquier selección actual en la página. Por ejemplo:

slides/selection/selection.gs

Ver en GitHub

// 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
//

Cómo seleccionar un elemento de la página

Para seleccionar un elemento de la página, usa el método PageElement.select(). Esta acción también anula la selección de los elementos de la página que se hayan seleccionado anteriormente.

Los métodos select() y select(true) son equivalentes.

Por ejemplo:

slides/selection/selection.gs

Ver en GitHub

  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
//

Cómo seleccionar varios elementos de la página

Para agregar elementos de página adicionales a la selección, usa el método PageElement.select(false). Todos los elementos de la página deben estar en la página actual.

slides/selection/selection.gs

Ver en GitHub

  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
//

Cómo transformar la selección

Las ediciones que realiza tu secuencia de comandos pueden transformar la selección actual, de modo que lo que se selecciona cambia como resultado de la edición. Por ejemplo:

1. Supongamos que tienes seleccionadas dos formas, A y B.
2. A continuación, la secuencia de comandos quita la forma A.
3. Como resultado, la selección se transforma en función de la edición, de modo que solo se selecciona la forma B.

En el siguiente ejemplo, se muestra cómo se puede transformar la selección manipulando los elementos de la página seleccionados.

slides/selection/selection.gs

Ver en GitHub

  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]
//

Cómo seleccionar texto

El texto contenido en una forma o en una celda de una tabla se puede seleccionar con el método TextRange.select(). Si el texto está dentro de una forma, también se selecciona esa forma. Si el texto está contenido en una celda de la tabla, se seleccionan tanto esa celda como la tabla que la contiene.

Esto también establece la página principal como la página actual.

Selección de rango en una forma

En el siguiente ejemplo, se muestra cómo realizar una selección de rango dentro del texto contenido en una forma.

slides/selection/selection.gs

Ver en GitHub

  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
//

Selección del cursor en una forma

En el siguiente ejemplo, se muestra cómo hacer una selección de cursor dentro del texto contenido en una forma.

slides/selection/selection.gs

Ver en GitHub

  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
//

Selección de rango en una celda de tabla

En el siguiente ejemplo, se muestra cómo realizar una selección de rango dentro del texto que se encuentra en una celda de la tabla.

slides/selection/selection.gs

Ver en GitHub

  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
//

Selección del cursor en TableCell

En el siguiente ejemplo, se muestra cómo hacer una selección de cursor dentro del texto contenido en una celda de la tabla.

slides/selection/selection.gs

Ver en GitHub

  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
//

Transformación de selección con ediciones de texto

En el siguiente ejemplo, se muestra cómo se puede transformar la selección editando el texto seleccionado.

slides/selection/selection.gs

Ver en GitHub

  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
//

Anular la selección

No hay métodos explícitos para anular la selección de texto o elementos de página. Sin embargo, este resultado se puede lograr con los métodos Page.selectAsCurrentPage() o pageElement.select().

Selecciona una página actual

En el siguiente ejemplo, se muestra cómo anular las selecciones actuales en una página estableciendo esa página como la actual.

slides/selection/selection.gs

Ver en GitHub

// 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();

Selecciona un elemento de la página

En el siguiente ejemplo, se muestra cómo anular las selecciones actuales en una página seleccionando un elemento de página y, de este modo, quitar todos los demás elementos de la selección.

slides/selection/selection.gs

Ver en GitHub

// 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();