Class Position

Pozycja

Odwołuje się do lokalizacji na karcie dokumentu względem konkretnego elementu. Kursor użytkownika jest reprezentowany przez Position, między innymi. Skrypty mogą uzyskać dostęp do kursora tylko w przypadku użytkownika, który uruchamia skrypt, i tylko wtedy, gdy skrypt jest powiązany z dokumentem. 

// 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.');
}

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera element zawierający ten element Position.
getOffset()IntegerPobiera względną pozycję tego Position w elemencie, który go zawiera.
getSurroundingText()TextTworzy sztuczny element Text, który reprezentuje tekst i formatowanie elementu Paragraph lub ListItem, który zawiera element Position, bezpośrednio lub za pomocą ciągu elementów podrzędnych.
getSurroundingTextOffset()IntegerPobiera przesunięcie tego elementu Position w elemencie Text zwracanym przez funkcję getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowe Bookmark w tym Position.
insertInlineImage(image)InlineImageTworzy i wstawia nowy element InlineImage w tym Position z wybranego pliku blob obrazu.
insertText(text)TextWstawia określony tekst w tym miejscu Position.

Szczegółowa dokumentacja

getElement()

Pobiera element zawierający ten element Position. Może to być element Text lub element kontenera, np. Paragraph. W obu przypadkach względną pozycję w elemencie można określić za pomocą atrybutu getOffset().

Powrót

Element – kontener lub element Text, w którym znajduje się obiekt Position

getOffset()

Pobiera względną pozycję tego Position w elemencie, który go zawiera. Jeśli element jest elementem Text, przesunięcie to liczba znaków przed Position (czyli indeks znaku po tym Position); w przypadku każdego innego elementu przesunięcie to liczba elementów podrzędnych przed tym Position w tym samym elemencie kontenera (czyli indeks elementu podrzędnego po tym Position).

Powrót

Integer – w przypadku elementów Text liczba znaków przed tym elementem Position; w przypadku innych elementów liczba elementów podrzędnych przed tym elementem Position w tym samym elemencie kontenera.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSurroundingText()

Tworzy sztuczny element Text, który reprezentuje tekst i formatowanie elementu Paragraph lub ListItem, który zawiera element Position, bezpośrednio lub za pomocą ciągu elementów podrzędnych. Aby określić przesunięcie Position w zwróconym elemencie Text, użyj atrybutu getSurroundingTextOffset().

Powrót

Text – element odpowiadający wynikowi wywołania funkcji editAsText() w elementach Paragraph lub ListItem, które zawierają element Position, bezpośrednio lub za pomocą łańcucha elementów podrzędnych.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

getSurroundingTextOffset()

Pobiera przesunięcie tego elementu Position w elemencie Text zwracanym przez funkcję getSurroundingText(). Odsunięcie to liczba znaków przed Position (czyli indeks znaku po tym Position).

Powrót

Integer – liczba znaków przed tym elementem Position w elemencie Paragraph lub ListItem, który zawiera element Position, bezpośrednio lub za pomocą ciągu elementów podrzędnych.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertBookmark()

Tworzy i wstawia nowe Bookmark w tym Position.

Powrót

Bookmark – nowa zakładka

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertInlineImage(image)

Tworzy i wstawia nowy element InlineImage w tym Position z wybranego pliku blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu do wstawienia w tym miejscu Position

Powrót

InlineImage – nowy element obrazu lub null, jeśli element, w którym znajduje się ten element Position, nie zezwala na wstawianie obrazów.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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

insertText(text)

Wstawia określony tekst w tym miejscu Position. Ta metoda tworzy nowy element Text, nawet jeśli ciąg znaków jest wstawiany w dotychczasowym elemencie Text, aby można było łatwo nadać nowemu elementowi styl.

Parametry

NazwaTypOpis
textStringciąg znaków do wstawienia w tym miejscu Position

Powrót

Text – nowy element tekstowy lub null, jeśli element, w którym znajduje się ten element Position, nie zezwala na wstawianie tekstu.

Autoryzacja

Skrypty, które korzystają z tej metody, wymagają autoryzacji z co najmniej jednym z tych zakresów:

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