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