Class Position

Posisi

Referensi ke lokasi di tab dokumen, relatif terhadap elemen tertentu. Kursor pengguna direpresentasikan sebagai Position, di antara penggunaan lainnya. Skrip hanya dapat mengakses kursor yang menjalankan skrip, dan hanya jika skrip terikat ke dokumen.

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

Metode

MetodeJenis hasil yang ditampilkanDeskripsi singkat
getElement()ElementMendapatkan elemen yang berisi Position ini.
getOffset()IntegerMendapatkan lokasi relatif Position ini dalam elemen yang memuatnya.
getSurroundingText()TextMembuat elemen Text buatan yang mewakili teks dan pemformatan Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan.
getSurroundingTextOffset()IntegerMendapatkan offset Position ini dalam elemen Text yang ditampilkan oleh getSurroundingText().
insertBookmark()BookmarkMembuat dan menyisipkan Bookmark baru di Position ini.
insertInlineImage(image)InlineImageMembuat dan menyisipkan InlineImage baru di Position ini dari gambar yang ditentukan blob.
insertText(text)TextMenyisipkan teks yang ditentukan di Position ini.

Dokumentasi mendetail

getElement()

Mendapatkan elemen yang berisi Position ini. File ini akan berupa Text atau elemen container seperti Paragraph. Dalam kedua kasus tersebut, nilai posisi dalam elemen dapat ditentukan dengan getOffset().

Pulang pergi

Element — penampung atau elemen Text tempat objek Position ini berada


getOffset()

Mendapatkan lokasi relatif Position ini dalam elemen yang memuatnya. Jika adalah elemen Text, offset adalah jumlah karakter sebelum Position (yaitu, indeks karakter setelah Position ini); untuk yang lainnya , offset adalah jumlah elemen turunan sebelum Position ini dalam elemen container yang sama (yaitu, indeks elemen turunan setelah Position).

Pulang pergi

Integer — untuk elemen Text, jumlah karakter sebelum Position ini; untuk elemen lainnya, jumlah elemen turunan sebelum Position ini dalam jumlah elemen container

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getSurroundingText()

Membuat elemen Text buatan yang mewakili teks dan pemformatan Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan. Untuk menentukan offset Position dalam elemen Text yang ditampilkan, gunakan getSurroundingTextOffset().

Pulang pergi

Text — elemen yang setara dengan hasil pemanggilan editAsText() di Paragraph atau ListItem yang berisi Position, baik secara langsung maupun melalui rantai elemen turunan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

getSurroundingTextOffset()

Mendapatkan offset Position ini dalam elemen Text yang ditampilkan oleh getSurroundingText(). Offset adalah jumlah karakter sebelum Position (yaitu, indeks karakter setelah Position ini).

Pulang pergi

Integer — jumlah karakter sebelum Position ini dalam Paragraph atau ListItem yang berisi Position, baik secara langsung atau melalui rantai elemen turunan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

insertBookmark()

Membuat dan menyisipkan Bookmark baru di Position ini.

Pulang pergi

Bookmark — bookmark baru

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

insertInlineImage(image)

Membuat dan menyisipkan InlineImage baru di Position ini dari gambar yang ditentukan blob.

Parameter

NamaJenisDeskripsi
imageBlobSourcedata gambar yang akan disisipkan di Position ini

Pulang pergi

InlineImage — elemen gambar baru, atau null jika elemen tempat Position ini berada terletak tidak memungkinkan gambar disisipkan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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

insertText(text)

Menyisipkan teks yang ditentukan di Position ini. Metode ini membuat Text baru , meskipun jika string disisipkan dalam elemen Text yang sudah ada, sehingga string mudah untuk menata gaya elemen baru tersebut.

Parameter

NamaJenisDeskripsi
textStringstring yang akan disisipkan pada Position ini

Pulang pergi

Text — elemen teks baru, atau null jika elemen tempat Position ini berada terletak tidak memungkinkan teks disisipkan

Otorisasi

Skrip yang menggunakan metode ini memerlukan otorisasi dengan satu atau beberapa cakupan berikut:

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