Wrapper รอบ Element
ที่มีออฟเซ็ตเริ่มต้นและสิ้นสุดได้ ออฟเซ็ตเหล่านี้ช่วยให้ช่วงอักขระภายในองค์ประกอบ Text
สามารถแสดงในผลการค้นหา การเลือกเอกสาร และช่วงที่ตั้งชื่อแล้ว
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
getElement() | Element | รับ Element ที่สอดคล้องกับ RangeElement นี้ |
getEndOffsetInclusive() | Integer | รับตำแหน่งของจุดสิ้นสุดของช่วงบางส่วนภายในองค์ประกอบช่วง |
getStartOffset() | Integer | รับตำแหน่งของจุดเริ่มต้นของช่วงบางส่วนภายในองค์ประกอบช่วง |
isPartial() | Boolean | กำหนดว่าองค์ประกอบช่วงนี้ครอบคลุมองค์ประกอบทั้งองค์ประกอบหรือการเลือกอักขระบางส่วนขององค์ประกอบ |
เอกสารประกอบโดยละเอียด
getElement()
รับ Element
ที่สอดคล้องกับ RangeElement
นี้
// Log debug information about a range element. Logger.log('Element type: ' + rangeElement.getElement().getType()); if (rangeElement.isPartial()) { Logger.log('The character range begins at ' + rangeElement.getStartOffset()); Logger.log('The character range ends at ' + rangeElement.getEndOffsetInclusive()); } else { Logger.log('The entire range element is included.'); }
รีเทิร์น
Element
— องค์ประกอบที่สอดคล้องกับ RangeElement
นี้
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
รับตำแหน่งของจุดสิ้นสุดของช่วงบางส่วนภายในองค์ประกอบช่วง หากองค์ประกอบเป็นองค์ประกอบ Text
และ isPartial()
แสดงผล true
ออฟเซ็ตคือจำนวนอักขระก่อนอักขระตัวสุดท้ายในช่วง (ซึ่งก็คือดัชนีของอักขระสุดท้ายในช่วง) ในกรณีอื่นๆ เมธอดนี้จะแสดง -1
รีเทิร์น
Integer
— สำหรับองค์ประกอบ Text
จำนวนอักขระก่อนอักขระตัวสุดท้ายในช่วง สำหรับองค์ประกอบอื่นๆ -1
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getStartOffset()
รับตำแหน่งของจุดเริ่มต้นของช่วงบางส่วนภายในองค์ประกอบช่วง หากองค์ประกอบเป็นองค์ประกอบ Text
และ isPartial()
แสดงผล true
ออฟเซ็ตคือจำนวนอักขระก่อนจุดเริ่มต้นของช่วง (ซึ่งก็คือดัชนีของอักขระแรกในช่วง) ในกรณีอื่นๆ เมธอดนี้จะแสดงผล -1
รีเทิร์น
Integer
— สำหรับองค์ประกอบ Text
จำนวนอักขระก่อนจุดเริ่มต้นของช่วง สำหรับองค์ประกอบอื่นๆ -1
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isPartial()
กำหนดว่าองค์ประกอบช่วงนี้ครอบคลุมองค์ประกอบทั้งองค์ประกอบหรือการเลือกอักขระบางส่วนขององค์ประกอบ คุณกำหนดจุดเริ่มต้นและจุดสิ้นสุดของช่วงขององค์ประกอบช่วงบางส่วนได้โดยใช้ getStartOffset()
และ getEndOffsetInclusive()
ตามลำดับ
รีเทิร์น
Boolean
— true
หากรวมองค์ประกอบบางส่วนไว้แล้ว false
หากไม่รวมองค์ประกอบ
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents