Class Position

Pozycja

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

Szczegółowa dokumentacja

getElement()

Pobiera element, który zawiera ten obiekt Position. Może to być Textelement lub element kontenera, np. Paragraph. W obu przypadkach względną pozycję w elemencie można określić za pomocą parametru getOffset().

Powrót

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

getOffset()

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 element 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() na elemencie Paragraph lub ListItem, który zawiera element Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 zwróconym przez getSurroundingText(). Przesunięcie to liczba znaków przed znakiem Position (czyli indeks znaku po tym znaku Position).

Powrót

Integer – liczba znaków przed tym znakiem Position w elemencie Paragraph lub ListItem, który zawiera znak Position bezpośrednio lub za pomocą łańcucha elementów podrzędnych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 tym Position.

Powrót

Bookmark – nowa zakładka.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 miejscu Position z określonego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu do wstawienia w tym miejscu Position.

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego 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 istniejącym elemencie Text, dzięki czemu łatwo jest stylować nowy element.

Parametry

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

Powrót

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

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji z użyciem co najmniej jednego z tych zakresów:

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