การอ้างอิงตำแหน่งในเอกสารที่สัมพันธ์กับองค์ประกอบที่เฉพาะเจาะจง เคอร์เซอร์ของผู้ใช้จะแสดงเป็น 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
ในทั้ง 2 กรณี ระบบจะกำหนดตำแหน่งสัมพัทธ์ภายในองค์ประกอบได้ด้วย 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
โดยตรงหรือผ่านเชนองค์ประกอบย่อย
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 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()
insertInlineImage(image)
สร้างและแทรก InlineImage
ใหม่ที่ Position
นี้จาก Blob รูปภาพที่ระบุ
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
image | BlobSource | ข้อมูลรูปภาพที่จะแทรกที่ Position นี้ |
รีเทิร์น
InlineImage
— องค์ประกอบรูปภาพใหม่ หรือ null
หากองค์ประกอบที่ Position
นี้อยู่ไม่อนุญาตให้แทรกรูปภาพ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(text)
แทรกข้อความที่ระบุใน Position
นี้ วิธีนี้จะสร้างองค์ประกอบ Text
ใหม่ แม้ว่าจะมีการแทรกสตริงไว้ในองค์ประกอบ Text
ที่มีอยู่ เพื่อให้คุณจัดรูปแบบองค์ประกอบใหม่ได้ง่าย
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
text | String | สตริงที่จะแทรกที่ Position นี้ |
รีเทิร์น
Text
— องค์ประกอบข้อความใหม่ หรือ null
หากองค์ประกอบที่ Position
นี้อยู่ไม่อนุญาตให้แทรกข้อความ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents