Class Position

Posición

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

// Insert some text at the cursor position and make it bold.
var 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.
  var 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 elemento. 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 muestra getSurroundingText().
insertBookmark()BookmarkCrea e inserta un nuevo Bookmark en este Position.
insertInlineImage(image)InlineImageCrea e inserta un nuevo InlineImage en este Position a partir de la imagen especificada. el BLOB.
insertText(text)TextInserta el texto especificado en este Position.

Documentación detallada

getElement()

Obtiene el elemento que contiene este Position. Será un Text o un elemento contenedor, como Paragraph. En cualquier caso, el valor relativo la posición en el elemento se puede determinar con getOffset().

Volver

Element: Es el contenedor o 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 botón es un elemento Text, el desplazamiento es la cantidad de caracteres antes de Position (es decir, el índice del carácter después de este Position); para cualquier otro , el desplazamiento es el número de elementos secundarios antes de este Position dentro del mismo elemento contenedor (es decir, el índice del elemento secundario después de Position)

Volver

Integer: para elementos Text, la cantidad de caracteres antes de este Position para otros elementos, la cantidad de elementos secundarios antes de este Position dentro de la misma 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 elemento. Paragraph o ListItem que contiene el Position, ya sea directamente o a través de una cadena de elementos secundarios. Para determinar el desplazamiento de Position en el elemento Text que se muestra, usa getSurroundingTextOffset().

Volver

Text: Es un elemento equivalente al resultado de llamar a editAsText(). en el Paragraph o el 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 muestra getSurroundingText(). El desplazamiento es la cantidad de caracteres antes de Position. (es decir, el índice del carácter después de este Position).

Volver

Integer: Es la cantidad de caracteres antes de este Position en el Paragraph o el 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 de la imagen especificada. el BLOB.

Parámetros

NombreTipoDescripción
imageBlobSourcelos datos de imagen que se insertarán en Position

Volver

InlineImage: Es el nuevo elemento de imagen, o null si el elemento en el que se encuentra este Position. ubicado 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 Text nuevo. incluso si la cadena se inserta dentro de un elemento Text existente, de modo que se es fácil diseñar el elemento nuevo.

Parámetros

NombreTipoDescripción
textStringla cadena que se insertará en este Position

Volver

Text: 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