หน้านี้ได้รับการแปลโดย Cloud Translation API

Class Position

การอ้างอิงไปยังตำแหน่งในแท็บเอกสารที่สัมพันธ์กับองค์ประกอบที่เฉพาะเจาะจง เคอร์เซอร์ของผู้ใช้ จะแสดงเป็น Position รวมถึงการใช้งานอื่นๆ สคริปต์จะเข้าถึงได้เฉพาะเคอร์เซอร์ของ ผู้ใช้ที่เรียกใช้สคริปต์ และเฉพาะเมื่อสคริปต์มีการเชื่อมโยงกับเอกสาร

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

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`getElement()`	`Element`	รับองค์ประกอบที่มี `Position` นี้
`getOffset()`	`Integer`	รับตำแหน่งที่เกี่ยวข้องของ `Position` ภายในองค์ประกอบที่มีตำแหน่งอยู่
`getSurroundingText()`	`Text`	สร้างองค์ประกอบ `Text` ปลอมซึ่งแสดงข้อความและการจัดรูปแบบของ `Paragraph` หรือ `ListItem` ที่มี `Position` ทั้งโดยตรงหรือผ่านเชนขององค์ประกอบย่อยก็ได้
`getSurroundingTextOffset()`	`Integer`	รับออฟเซ็ตของ `Position` นี้ภายในองค์ประกอบ `Text` ที่แสดงผลโดย `getSurroundingText()`
`insertBookmark()`	`Bookmark`	สร้างและแทรก `Bookmark` ใหม่ที่ `Position` นี้
`insertInlineImage(image)`	`InlineImage`	สร้างและแทรก `InlineImage` ใหม่ที่ `Position` นี้จากรูปภาพที่ระบุ BLOB
`insertText(text)`	`Text`	แทรกข้อความที่ระบุที่ `Position` นี้

เอกสารโดยละเอียด

`getElement()`

รับองค์ประกอบที่มี Position นี้ นี่อาจเป็น Text หรือองค์ประกอบคอนเทนเนอร์ เช่น Paragraph ไม่ว่าจะเป็นกรณีใด การเชื่อมโยง ตำแหน่งภายในองค์ประกอบจะกำหนดได้ด้วย getOffset()

รีเทิร์น

Element — คอนเทนเนอร์หรือองค์ประกอบ Text ที่มีออบเจ็กต์ Position นี้อยู่

`getOffset()`

รับตำแหน่งที่เกี่ยวข้องของ Position ภายในองค์ประกอบที่มีตำแหน่งอยู่ หาก องค์ประกอบเป็นองค์ประกอบ Text ค่าออฟเซ็ตคือจำนวนอักขระที่อยู่ก่อน Position (ซึ่งก็คือดัชนีของอักขระที่ตามหลัง Position นี้) สำหรับด้านอื่นๆ องค์ประกอบ ออฟเซ็ตคือจำนวนองค์ประกอบย่อยที่อยู่ก่อน Position นี้ภายใน องค์ประกอบคอนเทนเนอร์เดียวกัน (ซึ่งก็คือดัชนีขององค์ประกอบย่อยที่อยู่หลัง Position)

รีเทิร์น

Integer — สำหรับองค์ประกอบ Text จะใช้จำนวนอักขระก่อน Position นี้ สำหรับ องค์ประกอบอื่นๆ จำนวนองค์ประกอบย่อยที่อยู่ก่อน Position นี้ภายใน องค์ประกอบคอนเทนเนอร์

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

`getSurroundingText()`

สร้างองค์ประกอบ Text ปลอมซึ่งแสดงข้อความและการจัดรูปแบบของ Paragraph หรือ ListItem ที่มี Position ทั้งโดยตรงหรือผ่านเชนขององค์ประกอบย่อยก็ได้ หากต้องการหาออฟเซ็ตของ Position ในองค์ประกอบ Text ที่แสดงผล ให้ใช้ getSurroundingTextOffset()

รีเทิร์น

Text — องค์ประกอบเทียบเท่ากับผลลัพธ์ของการเรียก editAsText() ใน Paragraph หรือ ListItem ที่มี Position ไม่ว่าจะโดยตรงหรือผ่านเชนองค์ประกอบย่อย

การให้สิทธิ์

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

`getSurroundingTextOffset()`

รับออฟเซ็ตของ Position นี้ภายในองค์ประกอบ Text ที่แสดงผลโดย getSurroundingText() ออฟเซ็ตคือจำนวนอักขระที่อยู่ก่อน Position (คือดัชนีของอักขระที่ตามหลัง Position นี้)

รีเทิร์น

Integer — จำนวนอักขระก่อนหน้า Position นี้ใน Paragraph หรือ ListItem ที่มี Position ไม่ว่าจะโดยตรงหรือผ่านเชนขององค์ประกอบย่อย

การให้สิทธิ์

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

`insertBookmark()`

สร้างและแทรก Bookmark ใหม่ที่ Position นี้

รีเทิร์น

Bookmark — บุ๊กมาร์กใหม่

การให้สิทธิ์

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

`insertInlineImage(image)`

สร้างและแทรก InlineImage ใหม่ที่ Position นี้จากรูปภาพที่ระบุ BLOB

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`image`	`BlobSource`	ข้อมูลรูปภาพที่จะแทรกที่`Position`นี้

รีเทิร์น

InlineImage — องค์ประกอบรูปภาพใหม่ หรือ null หากองค์ประกอบที่มี Position นี้อยู่ ไม่อนุญาตให้แทรกภาพ

การให้สิทธิ์

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

`insertText(text)`

แทรกข้อความที่ระบุที่ Position นี้ วิธีนี้จะสร้าง Text ใหม่ แม้ว่าจะแทรกสตริงภายในองค์ประกอบ Text ที่มีอยู่เพื่อให้ จัดรูปแบบองค์ประกอบใหม่ได้ง่าย

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`text`	`String`	สตริงที่จะแทรกที่ `Position` นี้

รีเทิร์น

Text — องค์ประกอบข้อความใหม่ หรือ null หากองค์ประกอบที่มี Position นี้อยู่ ไม่อนุญาตให้แทรกข้อความ

การให้สิทธิ์

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