หน้านี้ได้รับการแปลโดย 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 ในทั้ง 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 ทั้งแบบโดยตรงหรือผ่านชุดองค์ประกอบย่อย

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

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