Class Position

Pozycja

Odwołanie do lokalizacji w dokumencie względem określonego elementu. Kursor użytkownika jest reprezentowany m.in. jako Position. Skrypty mają dostęp tylko do kursora użytkownika, który uruchamia skrypt, i tylko wtedy, gdy 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 element Position.
getOffset()IntegerPobiera względną lokalizację obiektu 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 przez łańcuch elementów podrzędnych).
getSurroundingTextOffset()IntegerPobiera przesunięcie tego elementu (Position) w elemencie Text zwróconym przez funkcję getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowy element Bookmark w tym obiekcie Position.
insertInlineImage(image)InlineImageTworzy i wstawia nowy obiekt InlineImage w tym obiekcie Position z określonego obrazu bloba.
insertText(text)TextWstawia określony tekst w elemencie Position.

Szczegółowa dokumentacja

getElement()

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

Powroty

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


getOffset()

Pobiera względną lokalizację obiektu 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 elemencie Position). W przypadku każdego innego elementu przesunięcie to liczba elementów podrzędnych przed elementem Position w tym samym elemencie kontenera (czyli indeks elementu podrzędnego po elemencie Position).

Powroty

Integer – w przypadku elementów Text liczba znaków poprzedzających ten Position; w przypadku innych elementów liczba elementów podrzędnych przed tym elementem: Position w tym samym elemencie kontenera

Upoważnienie

Skrypty korzystające 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 zawierającego element Position (bezpośrednio lub przez łańcuch elementów podrzędnych). Aby określić przesunięcie elementu Position w zwracanym elemencie Text, użyj funkcji getSurroundingTextOffset().

Powroty

Text – element odpowiadający wynikowi wywołania editAsText() w obiekcie Paragraph lub ListItem, który zawiera Position (bezpośrednio lub przez łańcuch elementów podrzędnych)

Upoważnienie

Skrypty korzystające 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 zwróconym przez funkcję getSurroundingText(). Przesunięcie to liczba znaków przed znakiem Position (czyli indeksem znaku po tym elemencie Position).

Powroty

Integer – liczba znaków przed elementem Position w elemencie Paragraph lub ListItem, który zawiera element Position (bezpośrednio lub przez łańcuch elementów podrzędnych).

Upoważnienie

Skrypty korzystające 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 nowy element Bookmark w tym obiekcie Position.

Powroty

Bookmark – nowa zakładka

Upoważnienie

Skrypty korzystające 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 obiekt InlineImage w tym obiekcie Position z określonego obrazu bloba.

Parametry

NazwaTypOpis
imageBlobSourcedane obrazu do wstawienia w tym miejscu: Position

Powroty

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

Upoważnienie

Skrypty korzystające 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 elemencie Position. Ta metoda tworzy nowy element Text, nawet jeśli ciąg znaków jest wstawiony w istniejącym elemencie Text, co ułatwia stylizowanie nowego elementu.

Parametry

NazwaTypOpis
textStringciąg do wstawienia w tym elemencie: Position

Powroty

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

Upoważnienie

Skrypty korzystające 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