Class Position

Zadbaj o dobrą organizację dzięki kolekcji Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
Pozycja

Odniesienie do lokalizacji w dokumencie względem określonego elementu. Kursor użytkownika jest oznaczony m.in. jako Position. Skrypty mają dostęp tylko do kursora użytkownika, który go uruchomił, i tylko wtedy, gdy skrypt jest powiązany z dokumentem.

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

Metody

MetodaZwracany typKrótki opis
getElement()ElementPobiera element zawierający ten element Position.
getOffset()IntegerPobiera względną lokalizację Position w elemencie, który go zawiera.
getSurroundingText()TextTworzy sztuczny element Text, który reprezentuje tekst i format elementu Paragraph lub ListItem, który zawiera element Position (bezpośrednio lub przez łańcuch elementów podrzędnych).
getSurroundingTextOffset()IntegerPobiera przesunięcie tego elementu Position w obrębie elementu Text zwróconego przez getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia Bookmark w tym miejscu: Position.
insertInlineImage(image)InlineImageTworzy i wstawia nowy element InlineImage w tym obiekcie Position z określonego obiektu 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 taki jak Paragraph. W obu przypadkach pozycję względnego elementu można określić za pomocą właściwości getOffset().

Zwróć

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


getOffset()

Pobiera względną lokalizację Position w elemencie, który go zawiera. Jeśli element jest elementem Text, przesunięcie jest liczbą znaków przed Position (czyli indeksem po tym elemencie Position). W przypadku innych elementów przesunięcie jest liczbą elementów podrzędnych poprzedzających ten element Position (czyli indeks elementu podrzędnego po Position).

Zwróć

Integer – w przypadku elementów Text jest to liczba znaków poprzedzająca ten element Position; w przypadku innych elementów liczba elementów podrzędnych poprzedzających ten element Position jest określona w tym samym elemencie kontenera

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 format elementu Paragraph lub ListItem, który zawiera element Position (bezpośrednio lub przez łańcuch elementów podrzędnych). Aby określić przesunięcie od Position w zwróconym elemencie Text, użyj funkcji getSurroundingTextOffset().

Zwróć

Text – element odpowiadający wynikowi wywołania metody Paragraph lub ListItem, które zawiera element Position, bezpośrednio lub przez łańcuch elementów podrzędnych.

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 obrębie elementu Text zwróconego przez getSurroundingText(). Przesunięcie to liczba znaków przed znakiem Position (czyli indeks po tym znaku Position).

Zwróć

Integer – liczba znaków przed wartością Position w kolumnie Paragraph lub ListItem, która zawiera wartość Position (bezpośrednio lub przez łańcuch elementów podrzędnych)

Autoryzacja

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

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

insertBookmark()

Tworzy i wstawia Bookmark w tym miejscu: Position.

Zwróć

Bookmark – nowa zakładka

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 obiekcie Position z określonego obiektu blob obrazu.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu do wstawienia jako Position

Zwróć

InlineImage – nowy element graficzny lub null, jeśli element, w którym znajduje się ten element Position, nie umożliwia wstawienia obrazów

Autoryzacja

Skrypty korzystające z tej metody wymagają autoryzacji przy użyciu 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 jest on wstawiony do istniejącego elementu Text, dzięki czemu można łatwo zmienić styl nowego elementu.

Parametry

NazwaTypOpis
textStringciąg, który ma zostać wstawiony w tym miejscu: Position

Zwróć

Text – nowy element tekstowy lub null, jeśli element, w którym znajduje się element Position, nie umożliwia wstawienia tekstu

Autoryzacja

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

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