Class Position

Pozycja

Odwołanie do lokalizacji na karcie dokumentu względem określonego elementu. Kursor użytkownika jest reprezentowany jako Position (pozycja). Skrypty mogą uzyskiwać dostęp tylko do kursora 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, który zawiera tę Position.
getOffset()IntegerPobiera względną lokalizację tej Position w elemencie, który ją zawiera.
getSurroundingText()TextTworzy sztuczny element Text, który reprezentuje tekst i formatowanie elementu Paragraph lub ListItem zawierającego Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych.
getSurroundingTextOffset()IntegerPobiera przesunięcie tego Position w elemencie Text zwróconym przez getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowy element Bookmark w tej Position.
insertInlineImage(image)InlineImage|nullTworzy i wstawia nowy element InlineImage w tej Position z określonego obiektu blob obrazu.
insertText(text)Text|nullWstawia określony tekst w tej Position.

Szczegółowa dokumentacja

getElement()

Pobiera element, który zawiera tę Position. Będzie to element Text lub element kontenera, taki jak Paragraph. W obu przypadkach względną pozycję w elemencie można określić za pomocą getOffset().

Powrót

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


getOffset()

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

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 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 zawierającego Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych. Aby określić przesunięcie Position w zwróconym elemencie Text, użyj getSurroundingTextOffset().

Powrót

Text – element równoważny wynikowi wywołania editAsText() w elemencie Paragraph lub ListItem zawierającym Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

getSurroundingTextOffset()

Pobiera przesunięcie tego Position w elemencie Text zwróconym przez getSurroundingText(). Przesunięcie to liczba znaków przed Position (czyli indeks znaku po tej Position).

Powrót

Integer – liczba znaków przed tą Position w elemencie Paragraph lub ListItem zawierającym Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

insertBookmark()

Tworzy i wstawia nowy element Bookmark w tej Position.

Powrót

Bookmark – nowa zakładka

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 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 tej Position z określonego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu do wstawienia w tej Position

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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

insertText(text)

Wstawia określony tekst w tej Position. Ta metoda tworzy nowy Text element, nawet jeśli ciąg jest wstawiany w istniejącym Text elemencie, aby ułatwić stylizowanie nowego elementu.

Parametry

NazwaTypOpis
textStringciąg znaków do wstawienia w tej Position

Powrót

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

Autoryzacja

Skrypty, które używają tej metody, wymagają autoryzacji z co najmniej 1 z tych zakresów:

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