เครื่องมือสร้างที่ใช้ในการสร้างออบเจ็กต์ 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
นี้
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
element | Element | องค์ประกอบที่จะเพิ่ม |
ไปกลับ
RangeBuilder
— เครื่องมือสร้างนี้สําหรับเชน
การให้สิทธิ์
สคริปต์ที่ใช้วิธีนี้ต้องได้รับสิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
addElement(textElement, startOffset, endOffsetInclusive)
เพิ่มเอลิเมนต์ Text
บางส่วนลงใน RangeBuilder
นี้
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
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
นี้
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
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
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
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
นี้
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
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