Class Position

Pozycja

Odwołanie do lokalizacji na karcie dokumentu względem konkretnego elementu. Kursor użytkownika jest reprezentowany między innymi jako Position. 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.
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 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 Paragraph lub ListItem, który zawiera element Position (bezpośrednio lub przez łańcuch elementów podrzędnych).
getSurroundingTextOffset()IntegerPobiera przesunięcie wartości Position w elemencie Text zwróconym przez funkcję getSurroundingText().
insertBookmark()BookmarkTworzy i wstawia nowy element Bookmark w tym miejscu: Position.
insertInlineImage(image)InlineImageTworzy i wstawia nowy element InlineImage w: Position na podstawie określonego obrazu blob.
insertText(text)TextWstawia określony tekst w tym miejscu: Position.

Szczegółowa dokumentacja

getElement()

Pobiera element zawierający Position. To będzie Text lub kontenera, np. Paragraph. W każdym z tych przypadków pozycję w elemencie można określić za pomocą funkcji getOffset().

Powrót

Element – kontener lub element Text, w którym znajduje się 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 Position (czyli indeks znaku po Position); w przypadku innych elementu, przesunięcie to liczba elementów podrzędnych przed tym Position w ten sam element kontenera (czyli indeks elementu podrzędnego po Position).

Powrót

Integer – w przypadku elementów Text jest to liczba znaków przed Position; w przypadku innych elementów, liczbę elementów podrzędnych przed elementem Position w obrębie tego samego element kontenera

Autoryzacja

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 Paragraph lub ListItem, który zawiera element Position (bezpośrednio lub przez łańcuch elementów podrzędnych). Aby określić przesunięcie elementu Position w zwróconym elemencie Text, użyj funkcji getSurroundingTextOffset().

Powrót

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

Autoryzacja

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 wartości Position w elemencie Text zwróconym przez funkcję getSurroundingText(). Przesunięcie to liczba znaków przed kolumną Position (czyli indeks znaku po znaku Position).

Powrót

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

Autoryzacja

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 miejscu: Position.

Powrót

Bookmark – nowa zakładka

Autoryzacja

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 element InlineImage w: Position na podstawie określonego obrazu blob.

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ę Position Lokalizacja nie pozwala na wstawianie obrazów

Autoryzacja

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 tym miejscu: Position. Ta metoda tworzy nowy Text nawet wtedy, gdy ciąg jest wstawiony w istniejącym elemencie Text, tak aby był łatwo dostosować styl nowego elementu.

Parametry

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

Powrót

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

Autoryzacja

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