Class Position

Posición

Es una referencia a una ubicación en la pestaña del documento, relativa a un elemento específico. El cursor del usuario se representa como un Position, entre otros usos. Las secuencias de comandos solo pueden acceder al cursor del usuario que las ejecuta, y solo si están vinculadas al documento. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Métodos

MétodoTipo de datos que se muestraDescripción breve
getElement()ElementObtiene el elemento que contiene este Position.
getOffset()IntegerObtiene la ubicación relativa de este Position dentro del elemento que lo contiene.
getSurroundingText()TextCrea un elemento Text artificial que representa el texto y el formato del Paragraph o ListItem que contiene el Position, ya sea directamente o a través de una cadena de elementos secundarios.
getSurroundingTextOffset()IntegerObtiene el desplazamiento de este Position dentro del elemento Text que devuelve getSurroundingText().
insertBookmark()BookmarkCrea e inserta un nuevo Bookmark en este Position.
insertInlineImage(image)InlineImage|nullCrea e inserta un nuevo InlineImage en este Position a partir del blob de imagen especificado.
insertText(text)Text|nullInserta el texto especificado en este Position.

Documentación detallada

getElement()

Obtiene el elemento que contiene este Position. Será un elemento Text o un elemento contenedor, como Paragraph. En ambos casos, la posición relativa dentro del elemento se puede determinar con getOffset().

Volver

Element: Es el contenedor o el elemento Text en el que se encuentra este objeto Position.

getOffset()

Obtiene la ubicación relativa de este Position dentro del elemento que lo contiene. Si el elemento es un elemento Text, el desplazamiento es la cantidad de caracteres que hay antes del Position (es decir, el índice del carácter que se encuentra después de este Position); para cualquier otro elemento, el desplazamiento es la cantidad de elementos secundarios que hay antes de este Position dentro del mismo elemento contenedor (es decir, el índice del elemento secundario que se encuentra después del Position).

Volver

Integer: Para los elementos Text, la cantidad de caracteres antes de este Position; para otros elementos, la cantidad de elementos secundarios antes de este Position dentro del mismo elemento contenedor

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingText()

Crea un elemento Text artificial que representa el texto y el formato del Paragraph o ListItem que contiene el Position, ya sea directamente o a través de una cadena de elementos secundarios. Para determinar la compensación de Position en el elemento Text que se devolvió, usa getSurroundingTextOffset().

Volver

Text: Es un elemento equivalente al resultado de llamar a editAsText() en el Paragraph o ListItem que contiene el Position, ya sea directamente o a través de una cadena de elementos secundarios.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getSurroundingTextOffset()

Obtiene el desplazamiento de este Position dentro del elemento Text que devuelve getSurroundingText(). El desplazamiento es la cantidad de caracteres antes del Position (es decir, el índice del carácter después de este Position).

Volver

Integer: Es la cantidad de caracteres que hay antes de este Position en el Paragraph o ListItem que contiene el Position, ya sea directamente o a través de una cadena de elementos secundarios.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertBookmark()

Crea e inserta un nuevo Bookmark en este Position.

Volver

Bookmark: El nuevo favorito

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertInlineImage(image)

Crea e inserta un nuevo InlineImage en este Position a partir del blob de imagen especificado.

Parámetros

NombreTipoDescripción
imageBlobSourceSon los datos de la imagen que se insertarán en este Position.

Volver

InlineImage|null: Es el nuevo elemento de imagen o null si el elemento en el que se encuentra este Position no permite insertar imágenes.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertText(text)

Inserta el texto especificado en este Position. Este método crea un nuevo elemento Text, incluso si la cadena se inserta dentro de un elemento Text existente, de modo que sea fácil aplicar estilo al nuevo elemento.

Parámetros

NombreTipoDescripción
textStringEs la cadena que se insertará en este Position.

Volver

Text|null: Es el nuevo elemento de texto o null si el elemento en el que se encuentra este Position no permite insertar texto.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents