Class RangeElement

RangeElement

Wrapper ของ Element ที่มีออฟเซ็ตเริ่มต้นและสิ้นสุดที่เป็นไปได้ การเลื่อนเหล่านี้ช่วยให้ช่วงอักขระภายในองค์ประกอบ Text แสดงในผลการค้นหา การเลือกเอกสาร และช่วงที่มีชื่อได้

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
getElement()Elementรับ Element ที่สอดคล้องกับ RangeElement นี้
getEndOffsetInclusive()Integerรับตําแหน่งของจุดสิ้นสุดของช่วงบางส่วนภายในองค์ประกอบช่วง
getStartOffset()Integerรับตําแหน่งของจุดเริ่มต้นของช่วงบางส่วนภายในองค์ประกอบช่วง
isPartial()Booleanระบุว่าองค์ประกอบช่วงนี้ครอบคลุมทั้งองค์ประกอบหรือการเลือกอักขระขององค์ประกอบเพียงบางส่วน

เอกสารประกอบโดยละเอียด

getElement()

รับ Element ที่สอดคล้องกับ RangeElement นี้ 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// 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