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

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`	สร้างและแทรก `InlineImage` ใหม่ใน `Position` นี้จาก Blob รูปภาพที่ระบุ
`insertText(text)`	`Text`	แทรกข้อความที่ระบุที่ `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 โดยตรงหรือผ่านเชนองค์ประกอบย่อย

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

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