เครื่องมือสร้างที่ใช้สร้างออบเจ็กต์ Range
จากองค์ประกอบเอกสาร
// Change the user's selection to a range that includes every table in the document. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
addElement(element) | RangeBuilder | เพิ่ม Element ทั้งหมดไปยัง RangeBuilder นี้ |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | เพิ่มองค์ประกอบ Text บางส่วนลงใน RangeBuilder นี้ |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | เพิ่มองค์ประกอบทั้งหมด 2 รายการ รวมถึงองค์ประกอบทั้งหมดระหว่างองค์ประกอบเหล่านั้นลงใน RangeBuilder นี้ |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | เพิ่มองค์ประกอบ Text บางส่วนและองค์ประกอบทั้งหมดระหว่าง 2 รายการลงใน RangeBuilder |
addRange(range) | RangeBuilder | เพิ่มเนื้อหาของ Range อื่นไปยัง RangeBuilder นี้ |
build() | Range | สร้าง Range จากการตั้งค่าที่ใช้กับเครื่องมือสร้าง |
getRangeElements() | RangeElement[] | รับองค์ประกอบทั้งหมดใน Range นี้ ซึ่งรวมถึงองค์ประกอบ Text บางส่วน (เช่น ในกรณีของการเลือกที่รวมเพียงส่วนหนึ่งขององค์ประกอบ Text ) |
เอกสารประกอบโดยละเอียด
addElement(element)
เพิ่ม Element
ทั้งหมดไปยัง RangeBuilder
นี้
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
element | Element | องค์ประกอบที่จะเพิ่ม |
รีเทิร์น
RangeBuilder
— เครื่องมือสร้างนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
เพิ่มองค์ประกอบ Text
บางส่วนลงใน RangeBuilder
นี้
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
textElement | Text | องค์ประกอบของข้อความที่จะเพิ่มบางส่วน |
startOffset | Integer | จำนวนอักขระก่อนอักขระแรกที่จะรวม (ซึ่งก็คือดัชนีของอักขระตัวแรกในช่วง) |
endOffsetInclusive | Integer | จำนวนอักขระก่อนอักขระตัวสุดท้ายที่จะรวม (ซึ่งก็คือดัชนีของอักขระตัวสุดท้ายในช่วง) |
รีเทิร์น
RangeBuilder
— เครื่องมือสร้างนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startElement, endElementInclusive)
เพิ่มองค์ประกอบทั้งหมด 2 รายการ รวมถึงองค์ประกอบทั้งหมดระหว่างองค์ประกอบเหล่านั้นลงใน RangeBuilder
นี้
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
startElement | Element | องค์ประกอบแรกที่จะเพิ่ม |
endElementInclusive | Element | องค์ประกอบสุดท้ายที่จะเพิ่ม |
รีเทิร์น
RangeBuilder
— เครื่องมือสร้างนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)
เพิ่มองค์ประกอบ Text
บางส่วนและองค์ประกอบทั้งหมดระหว่าง 2 รายการลงใน RangeBuilder
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
startTextElement | Text | องค์ประกอบของข้อความแรกที่จะเพิ่มบางส่วน |
startOffset | Integer | จำนวนอักขระก่อนอักขระแรกของ startTextElement ที่จะรวม (ซึ่งก็คือดัชนีของอักขระตัวแรกในช่วง) |
endTextElementInclusive | Text | องค์ประกอบของข้อความสุดท้ายที่จะเพิ่มบางส่วน |
endOffsetInclusive | Integer | จำนวนอักขระก่อนอักขระสุดท้ายของ endTextElementInclusive ที่จะรวม (ซึ่งก็คือดัชนีของอักขระตัวสุดท้ายในช่วง) |
รีเทิร์น
RangeBuilder
— เครื่องมือสร้างนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addRange(range)
เพิ่มเนื้อหาของ Range
อื่นไปยัง RangeBuilder
นี้
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
range | Range | ช่วงที่ควรเพิ่มองค์ประกอบ |
รีเทิร์น
RangeBuilder
— เครื่องมือสร้างนี้สำหรับการทำเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
build()
getRangeElements()
รับองค์ประกอบทั้งหมดใน Range
นี้ ซึ่งรวมถึงองค์ประกอบ Text
บางส่วน (เช่น ในกรณีของการเลือกที่รวมเพียงส่วนหนึ่งขององค์ประกอบ Text
) หากต้องการทราบว่าองค์ประกอบ Text
รวมอยู่ในช่วงเพียงบางส่วนหรือไม่ โปรดดูที่ RangeElement.isPartial()
รีเทิร์น
RangeElement[]
— อาร์เรย์ขององค์ประกอบตามลำดับที่ปรากฏในเอกสาร
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents