Se usó la API de Cloud Translation para traducir esta página.

Class Position

Es una referencia a una ubicación en el documento en relación con 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 ejecuta la secuencia de comandos, y solo si 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étodo	Tipo de datos que se muestra	Descripción breve
`getElement()`	`Element`	Obtiene el elemento que contiene este `Position`.
`getOffset()`	`Integer`	Obtiene la ubicación relativa de este `Position` dentro del elemento que lo contiene.
`getSurroundingText()`	`Text`	Crea un elemento `Text` artificial que representa el texto y el formato del `Paragraph` o el `ListItem` que contiene el `Position`, ya sea directamente o a través de una cadena de elementos secundarios.
`getSurroundingTextOffset()`	`Integer`	Obtiene el desplazamiento de este `Position` dentro del elemento `Text` que muestra `getSurroundingText()`.
`insertBookmark()`	`Bookmark`	Crea y, luego, inserta un nuevo `Bookmark` en este `Position`.
`insertInlineImage(image)`	`InlineImage`	Crea y, luego, inserta un `InlineImage` nuevo en este `Position` del BLOB de imágenes especificado.
`insertText(text)`	`Text`	Inserta 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 cualquier caso, la posición relativa dentro del elemento se puede determinar con getOffset().

Devolvedor

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 antes del Position (es decir, el índice del carácter después de este Position); para cualquier otro elemento, el desplazamiento es la cantidad de elementos secundarios antes de este Position dentro del mismo elemento del contenedor (es decir, el índice del elemento secundario después del Position).

Devolvedor

Integer: Para elementos Text, la cantidad de caracteres antes de este Position. En el caso de 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 el 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().

Devolvedor

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).

Devolvedor

Integer: Es la cantidad de caracteres antes de este Position en 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 y, luego, inserta un nuevo Bookmark en este Position.

Devolvedor

Bookmark: Es 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 y, luego, inserta un InlineImage nuevo en este Position del BLOB de imágenes especificado.

Parámetros

Nombre	Tipo	Descripción
`image`	`BlobSource`	los datos de imagen que se insertarán en este `Position`

Devolvedor

InlineImage: Es el nuevo elemento de imagen o null si el elemento en el que se encuentra Position no permite que se inserten 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 elemento Text nuevo, incluso si la string se inserta dentro de un elemento Text existente, para que sea fácil darle estilo al elemento nuevo.

Parámetros

Nombre	Tipo	Descripción
`text`	`String`	La cadena que se insertará en este `Position`

Devolvedor

Text: Es el nuevo elemento de texto o null si el elemento en el que se encuentra este Position no permite que se inserte 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