Class Position

ตำแหน่ง

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

// Insert some text at the cursor position and make it bold.
const 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.
  const 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 นี้ภายในองค์ประกอบที่มี Position
getSurroundingText()Textสร้างองค์ประกอบ Text เทียมที่แสดงข้อความและการจัดรูปแบบของ Paragraph หรือ ListItem ที่มี Position ไม่ว่าจะโดยตรงหรือผ่านเชนขององค์ประกอบย่อย
getSurroundingTextOffset()Integerรับออฟเซ็ตของ Position นี้ภายในองค์ประกอบ Text ที่ getSurroundingText() แสดงผล
insertBookmark()Bookmarkสร้างและแทรกBookmarkใหม่ที่Positionนี้
insertInlineImage(image)InlineImage|nullสร้างและแทรก InlineImage ใหม่ที่ Position นี้จากออบเจ็กต์ขนาดใหญ่ของรูปภาพที่ระบุ
insertText(text)Text|nullแทรกข้อความที่ระบุที่ Position นี้

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

getElement()

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

รีเทิร์น

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

getOffset()

รับตำแหน่งสัมพัทธ์ของ Position นี้ภายในองค์ประกอบที่มี 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 ไม่ว่าจะโดยตรงหรือผ่านห่วงโซ่องค์ประกอบย่อย

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

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

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

getSurroundingTextOffset()

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

รีเทิร์น

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

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

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

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

insertBookmark()

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

รีเทิร์น

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

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

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

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

insertInlineImage(image)

สร้างและแทรก InlineImage ใหม่ที่ Position นี้จากออบเจ็กต์ขนาดใหญ่ของรูปภาพที่ระบุ

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

insertText(text)

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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