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 una 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étodo	Tipo de datos que se devuelve	Descripción breve
getElement()	Element	Obtiene el elemento que contiene esta Position.
getOffset()	Integer	Obtiene la ubicación relativa de esta Position dentro del elemento que la contiene.
getSurroundingText()	Text	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.
getSurroundingTextOffset()	Integer	Obtiene el desplazamiento de este Position dentro del elemento Text que muestra getSurroundingText().
insertBookmark()	Bookmark	Crea e inserta un nuevo Bookmark en esta Position.
insertInlineImage(image)	InlineImage|null	Crea e inserta un nuevo InlineImage en esta Position desde el blob de imagen especificado.
insertText(text)	Text|null	Inserta el texto especificado en esta Position.

Documentación detallada

getElement()

Obtiene el elemento que contiene esta Position. Puede 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().

Volver

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

---

getOffset()

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

Volver

Integer — para los elementos Text, es la cantidad de caracteres antes de esta Position. Para otros elementos, es la cantidad de elementos secundarios antes de esta 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 permisos:

• 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 la 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 ListItem que contiene la 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 permisos:

• 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 la Position (es decir, el índice del carácter después de esta Position).

Volver

Integer: Es la cantidad de caracteres antes de esta Position en el Paragraph o ListItem que contiene la 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 permisos:

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

---

insertBookmark()

Crea e inserta un nuevo Bookmark en esta Position.

Volver

Bookmark: Es el nuevo marcador.

Autorización

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

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

---

insertInlineImage(image)

Crea e inserta un nuevo InlineImage en esta Position desde el blob de imagen especificado.

Parámetros

Nombre	Tipo	Descripción
image	BlobSource	Son los datos de la imagen que se insertarán en esta Position.

Volver

InlineImage|null: Es el nuevo elemento de imagen o null si el elemento en el que se encuentra esta 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 permisos:

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

---

insertText(text)

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

Parámetros

Nombre	Tipo	Descripción
text	String	Es la cadena que se insertará en esta Position.

Volver

Text|null — 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 permisos:

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