หน้านี้ได้รับการแปลโดย Cloud Translation API

Class Body

เนื้อหาของแท็บในเอกสาร Google เอกสาร Body อาจมี ListItem องค์ประกอบ Paragraph, Table และ TableOfContents สำหรับข้อมูลเพิ่มเติมเกี่ยวกับ โครงสร้างเอกสาร โปรดดูคู่มือเพื่อ Google เอกสาร

ตามปกติ Body จะมีเนื้อหาแบบเต็มแท็บ ยกเว้นองค์ประกอบ HeaderSection, FooterSection และองค์ประกอบ FootnoteSection

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph("A paragraph.");
body.appendPageBreak();

เมธอด

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`appendHorizontalRule()`	`HorizontalRule`	สร้างและเพิ่ม `HorizontalRule` ใหม่
`appendImage(image)`	`InlineImage`	สร้างและเพิ่ม `InlineImage` ใหม่จาก Blob ของรูปภาพที่ระบุ
`appendImage(image)`	`InlineImage`	เพิ่ม `InlineImage` ที่ระบุ
`appendListItem(listItem)`	`ListItem`	เพิ่ม `ListItem` ที่ระบุ
`appendListItem(text)`	`ListItem`	สร้างและเพิ่ม `ListItem` ใหม่ที่มีเนื้อหาข้อความที่ระบุ
`appendPageBreak()`	`PageBreak`	สร้างและเพิ่ม `PageBreak` ใหม่
`appendPageBreak(pageBreak)`	`PageBreak`	เพิ่ม `PageBreak` ที่ระบุ
`appendParagraph(paragraph)`	`Paragraph`	เพิ่ม `Paragraph` ที่ระบุ
`appendParagraph(text)`	`Paragraph`	สร้างและเพิ่ม `Paragraph` ใหม่ที่มีเนื้อหาข้อความที่ระบุ
`appendTable()`	`Table`	สร้างและเพิ่ม `Table` ใหม่
`appendTable(cells)`	`Table`	เพิ่ม `Table` ใหม่ที่มี `TableCell` ต่อท้ายค่าสตริงที่ระบุแต่ละค่า
`appendTable(table)`	`Table`	เพิ่ม `Table` ที่ระบุ
`clear()`	`Body`	ล้างเนื้อหาขององค์ประกอบ
`copy()`	`Body`	แสดงผลสำเนาที่แยกส่วนลึกขององค์ประกอบปัจจุบัน
`editAsText()`	`Text`	รับองค์ประกอบปัจจุบันเวอร์ชัน`Text` เพื่อแก้ไข
`findElement(elementType)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ
`findElement(elementType, from)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ โดยเริ่มจาก ระบุ `RangeElement` แล้ว
`findText(searchPattern)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุโดยใช้นิพจน์ทั่วไป
`findText(searchPattern, from)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุ โดยเริ่มต้นจาก ผลการค้นหา
`getAttributes()`	`Object`	ดึงแอตทริบิวต์ขององค์ประกอบ
`getChild(childIndex)`	`Element`	เรียกข้อมูลองค์ประกอบย่อยที่ดัชนีย่อยที่ระบุ
`getChildIndex(child)`	`Integer`	เรียกดัชนีย่อยสำหรับองค์ประกอบย่อยที่ระบุ
`getHeadingAttributes(paragraphHeading)`	`Object`	ดึงข้อมูลชุดแอตทริบิวต์สำหรับ `ParagraphHeading` ที่ระบุ
`getImages()`	`InlineImage[]`	เรียกดู `InlineImages` ทั้งหมดที่อยู่ในส่วนนี้
`getListItems()`	`ListItem[]`	เรียกดู `ListItems` ทั้งหมดที่อยู่ในส่วนนี้
`getMarginBottom()`	`Number`	ดึงขอบด้านล่าง เป็นคะแนน
`getMarginLeft()`	`Number`	ดึงข้อมูลระยะขอบด้านซ้าย หน่วยเป็นคะแนน
`getMarginRight()`	`Number`	ดึงข้อมูลขอบด้านขวา
`getMarginTop()`	`Number`	ดึงข้อมูลขอบด้านบน
`getNumChildren()`	`Integer`	ดึงจำนวนเด็ก
`getPageHeight()`	`Number`	ดึงความสูงของหน้า หน่วยเป็นจุด
`getPageWidth()`	`Number`	ดึงข้อมูลความกว้างของหน้าเว็บ เป็นจุด
`getParagraphs()`	`Paragraph[]`	เรียกดู `Paragraphs` ทั้งหมดที่อยู่ในส่วนนี้ (รวมถึง `ListItems`)
`getParent()`	`ContainerElement`	เรียกข้อมูลองค์ประกอบหลักขององค์ประกอบ
`getTables()`	`Table[]`	เรียกดู `Tables` ทั้งหมดที่อยู่ในส่วนนี้
`getText()`	`String`	เรียกคืนเนื้อหาขององค์ประกอบเป็นสตริงข้อความ
`getTextAlignment()`	`TextAlignment`	ปรับการจัดข้อความ
`getType()`	`ElementType`	เรียกข้อมูล `ElementType` ขององค์ประกอบ
`insertHorizontalRule(childIndex)`	`HorizontalRule`	สร้างและแทรก `HorizontalRule` ใหม่ที่ดัชนีที่ระบุ
`insertImage(childIndex, image)`	`InlineImage`	สร้างและแทรก `InlineImage` จาก Blob รูปภาพที่ระบุที่ ดัชนี
`insertImage(childIndex, image)`	`InlineImage`	แทรก `InlineImage` ที่ระบุที่ดัชนีที่ระบุ
`insertListItem(childIndex, listItem)`	`ListItem`	แทรก `ListItem` ที่ระบุที่ดัชนีที่ระบุ
`insertListItem(childIndex, text)`	`ListItem`	สร้างและแทรก `ListItem` ใหม่ที่ดัชนีที่ระบุ โดยมีค่าที่ระบุ เนื้อหาข้อความ
`insertPageBreak(childIndex)`	`PageBreak`	สร้างและแทรก `PageBreak` ใหม่ที่ดัชนีที่ระบุ
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	แทรก `PageBreak` ที่ระบุที่ดัชนีที่ระบุ
`insertParagraph(childIndex, paragraph)`	`Paragraph`	แทรก `Paragraph` ที่ระบุที่ดัชนีที่ระบุ
`insertParagraph(childIndex, text)`	`Paragraph`	สร้างและแทรก `Paragraph` ใหม่ที่ดัชนีที่ระบุ โดยมีค่าที่ระบุ เนื้อหาข้อความ
`insertTable(childIndex)`	`Table`	สร้างและแทรก `Table` ใหม่ที่ดัชนีที่ระบุ
`insertTable(childIndex, cells)`	`Table`	สร้างและแทรก `Table` ใหม่ซึ่งมีเซลล์ที่ระบุที่ดัชนีที่ระบุ
`insertTable(childIndex, table)`	`Table`	แทรก `Table` ที่ระบุที่ดัชนีที่ระบุ
`removeChild(child)`	`Body`	นำองค์ประกอบย่อยที่ระบุออก
`replaceText(searchPattern, replacement)`	`Element`	แทนที่ทุกรายการของรูปแบบข้อความที่ระบุด้วยสตริงการแทนที่ที่กำหนด โดยใช้ข้อความปกติ นิพจน์
`setAttributes(attributes)`	`Body`	ตั้งค่าแอตทริบิวต์ขององค์ประกอบ
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	ตั้งค่าแอตทริบิวต์สำหรับ `ParagraphHeading` ที่ระบุ
`setMarginBottom(marginBottom)`	`Body`	ตั้งค่าระยะขอบด้านล่างเป็นจุด
`setMarginLeft(marginLeft)`	`Body`	ตั้งค่าระยะขอบด้านซ้าย หน่วยเป็นจุด
`setMarginRight(marginRight)`	`Body`	ตั้งค่าระยะขอบด้านขวา หน่วยเป็นจุด
`setMarginTop(marginTop)`	`Body`	ตั้งค่าระยะขอบบน
`setPageHeight(pageHeight)`	`Body`	กำหนดความสูงของหน้าเว็บเป็นจุด
`setPageWidth(pageWidth)`	`Body`	กำหนดความกว้างของหน้าเว็บเป็นจุด
`setText(text)`	`Body`	ตั้งค่าเนื้อหาเป็นข้อความธรรมดา
`setTextAlignment(textAlignment)`	`Body`	ตั้งค่าการจัดข้อความ

วิธีการที่เลิกใช้งานแล้ว

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`getFootnotes()`	`Footnote[]`	เรียกดู `Footnotes` ทั้งหมดที่อยู่ในส่วนนี้
`getLinkUrl()`	`String`	ดึงข้อมูล URL ของลิงก์
`getNextSibling()`	`Element`	เรียกข้อมูลองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ
`getPreviousSibling()`	`Element`	ดึงองค์ประกอบระดับเดียวกันก่อนหน้านี้ขององค์ประกอบ
`isAtDocumentEnd()`	`Boolean`	กำหนดว่าองค์ประกอบอยู่ที่ส่วนท้ายของ `Document` หรือไม่
`setLinkUrl(url)`	`Body`	ตั้งค่า URL ของลิงก์

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

`appendHorizontalRule()`

สร้างและเพิ่ม HorizontalRule ใหม่

HorizontalRule จะอยู่ใน Paragraph ใหม่

รีเทิร์น

HorizontalRule — กฎแนวนอนใหม่

การให้สิทธิ์

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendImage(image)`

สร้างและเพิ่ม InlineImage ใหม่จาก Blob ของรูปภาพที่ระบุ

รูปภาพจะอยู่ใน Paragraph ใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`image`	`BlobSource`	ข้อมูลรูปภาพ

รีเทิร์น

InlineImage — รูปภาพที่ต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendImage(image)`

เพิ่ม InlineImage ที่ระบุ

InlineImage จะอยู่ใน Paragraph ใหม่

ใช้ appendImage เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ InlineImage ที่มีอยู่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`image`	`InlineImage`	ข้อมูลรูปภาพ

รีเทิร์น

InlineImage — รูปภาพที่ต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendListItem(listItem)`

เพิ่ม ListItem ที่ระบุ

ใช้ appendListItem เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ ListItem ที่มีอยู่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`listItem`	`ListItem`	รายการที่จะต่อท้าย

รีเทิร์น

ListItem — รายการต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendListItem(text)`

สร้างและเพิ่ม ListItem ใหม่ที่มีเนื้อหาข้อความที่ระบุ

ระบบจะเพิ่มรายการที่อยู่ต่อเนื่องกันเพื่อเป็นส่วนหนึ่งของรายการเดียวกัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`text`	`String`	เนื้อหาข้อความของรายการ

รีเทิร์น

ListItem — รายการใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendPageBreak()`

สร้างและเพิ่ม PageBreak ใหม่

PageBreak จะอยู่ใน Paragraph ใหม่

รีเทิร์น

PageBreak — ตัวแบ่งหน้าใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendPageBreak(pageBreak)`

เพิ่ม PageBreak ที่ระบุ

PageBreak จะอยู่ใน Paragraph ใหม่

ใช้ appendPageBreak เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ PageBreak ที่มีอยู่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`pageBreak`	`PageBreak`	ตัวแบ่งหน้าที่จะเพิ่ม

รีเทิร์น

PageBreak — ตัวแบ่งหน้าที่ต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendParagraph(paragraph)`

เพิ่ม Paragraph ที่ระบุ

ใช้ appendParagraph เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ Paragraph ที่มีอยู่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`paragraph`	`Paragraph`	ย่อหน้าที่จะต่อท้าย

รีเทิร์น

Paragraph — ย่อหน้าที่ต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendParagraph(text)`

สร้างและเพิ่ม Paragraph ใหม่ที่มีเนื้อหาข้อความที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`text`	`String`	เนื้อหาข้อความของย่อหน้า

รีเทิร์น

Paragraph — ย่อหน้าใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable()`

สร้างและเพิ่ม Table ใหม่

วิธีนี้จะใส่ย่อหน้าว่างต่อท้ายตารางด้วย เนื่องจากเอกสารใน Google เอกสาร ต้องไม่ลงท้ายด้วยตาราง

รีเทิร์น

Table — ตารางใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable(cells)`

เพิ่ม Table ใหม่ที่มี TableCell ต่อท้ายค่าสตริงที่ระบุแต่ละค่า

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`cells`	`String[][]`	เนื้อหาข้อความของเซลล์ตารางที่จะเพิ่มลงในตารางใหม่

รีเทิร์น

Table — ตารางที่ต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`appendTable(table)`

เพิ่ม Table ที่ระบุ

ใช้ appendTable เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ Table ที่มีอยู่ วิธีนี้จะใส่ย่อหน้าว่างต่อท้ายตารางด้วย เนื่องจากเอกสารใน Google เอกสาร ต้องไม่ลงท้ายด้วยตาราง

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`table`	`Table`	ตารางที่จะต่อท้าย

รีเทิร์น

Table — ตารางที่ต่อท้าย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`clear()`

ล้างเนื้อหาขององค์ประกอบ

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

`copy()`

แสดงผลสำเนาที่แยกส่วนลึกขององค์ประกอบปัจจุบัน

ระบบจะคัดลอกองค์ประกอบย่อยที่อยู่ในองค์ประกอบดังกล่าวด้วย องค์ประกอบใหม่ไม่มีองค์ประกอบ หลัก

รีเทิร์น

Body — สำเนาใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`editAsText()`

รับองค์ประกอบปัจจุบันเวอร์ชันText เพื่อแก้ไข

ใช้ editAsText เพื่อจัดการเนื้อหาองค์ประกอบแบบ Rich Text โหมด editAsText จะไม่สนใจองค์ประกอบที่ไม่ใช่ข้อความ (เช่น InlineImage และ HorizontalRule)

ระบบจะนำองค์ประกอบย่อยที่อยู่แบบเต็มในช่วงข้อความที่ถูกลบออกจากองค์ประกอบดังกล่าว

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

รีเทิร์น

Text — เวอร์ชันข้อความขององค์ประกอบปัจจุบัน

`findElement(elementType)`

ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`elementType`	`ElementType`	ประเภทขององค์ประกอบที่จะค้นหา

รีเทิร์น

RangeElement — ผลการค้นหาที่ระบุตำแหน่งขององค์ประกอบการค้นหา

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findElement(elementType, from)`

ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ โดยเริ่มจาก ระบุ RangeElement แล้ว

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`elementType`	`ElementType`	ประเภทขององค์ประกอบที่จะค้นหา
`from`	`RangeElement`	ผลการค้นหาที่จะค้นหา

รีเทิร์น

RangeElement — ผลการค้นหาที่ระบุตำแหน่งถัดไปขององค์ประกอบการค้นหา

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern)`

ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุโดยใช้นิพจน์ทั่วไป

ระบบยังไม่รองรับฟีเจอร์นิพจน์ทั่วไปของ JavaScript บางส่วนอย่างสมบูรณ์ เช่น แคปเจอร์กรุ๊ปและตัวปรับแต่งโหมด

รูปแบบนิพจน์ทั่วไปที่ระบุจะถูกจับคู่กับบล็อกข้อความแต่ละบล็อกแยกกัน ที่มีอยู่ในองค์ประกอบปัจจุบัน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`searchPattern`	`String`	รูปแบบที่จะค้นหา

รีเทิร์น

RangeElement — ผลการค้นหาที่ระบุตำแหน่งของข้อความค้นหา หรือไม่มีข้อมูล หากไม่มี การจับคู่ที่ตรงกัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern, from)`

ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุ โดยเริ่มต้นจาก ผลการค้นหา

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`searchPattern`	`String`	รูปแบบที่จะค้นหา
`from`	`RangeElement`	ผลการค้นหาที่จะค้นหาจาก

รีเทิร์น

RangeElement — ผลการค้นหาที่ระบุตำแหน่งถัดไปของข้อความค้นหา หรือไม่มีข้อมูลหากไม่มี การจับคู่ที่ตรงกัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getAttributes()`

ดึงแอตทริบิวต์ขององค์ประกอบ

ผลลัพธ์คือออบเจ็กต์ที่มีพร็อพเพอร์ตี้สำหรับแอตทริบิวต์ขององค์ประกอบที่ถูกต้องแต่ละรายการ โดยที่แต่ละรายการ ชื่อพร็อพเพอร์ตี้สอดคล้องกับรายการในการแจกแจง DocumentApp.Attribute

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

รีเทิร์น

Object — แอตทริบิวต์ขององค์ประกอบ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChild(childIndex)`

เรียกข้อมูลองค์ประกอบย่อยที่ดัชนีย่อยที่ระบุ

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีขององค์ประกอบย่อยที่จะดึงข้อมูล

รีเทิร์น

Element — องค์ประกอบย่อยในดัชนีที่ระบุ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getChildIndex(child)`

เรียกดัชนีย่อยสำหรับองค์ประกอบย่อยที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`child`	`Element`	องค์ประกอบย่อยที่จะดึงข้อมูลดัชนี

รีเทิร์น

Integer — ดัชนีย่อย

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getHeadingAttributes(paragraphHeading)`

ดึงข้อมูลชุดแอตทริบิวต์สำหรับ ParagraphHeading ที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`paragraphHeading`	`ParagraphHeading`	ส่วนหัวที่มีแอตทริบิวต์

รีเทิร์น

Object — แมปของแอตทริบิวต์และค่าปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getImages()`

เรียกดู InlineImages ทั้งหมดที่อยู่ในส่วนนี้

รีเทิร์น

InlineImage[] — รูปภาพส่วน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getListItems()`

เรียกดู ListItems ทั้งหมดที่อยู่ในส่วนนี้

รีเทิร์น

ListItem[] — รายการส่วน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginBottom()`

ดึงขอบด้านล่าง เป็นคะแนน

รีเทิร์น

Number — ขอบล่างเป็นคะแนน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginLeft()`

ดึงข้อมูลระยะขอบด้านซ้าย หน่วยเป็นคะแนน

รีเทิร์น

Number — ขอบซ้าย เป็นคะแนน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginRight()`

ดึงข้อมูลขอบด้านขวา

รีเทิร์น

Number — ระยะขอบด้านขวา เป็นคะแนน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getMarginTop()`

ดึงข้อมูลขอบด้านบน

รีเทิร์น

Number — ขอบบน เป็นคะแนน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNumChildren()`

ดึงจำนวนเด็ก

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log("There are " + body.getNumChildren() +
    " elements in the tab's body.");

รีเทิร์น

Integer — จำนวนเด็ก

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPageHeight()`

ดึงความสูงของหน้า หน่วยเป็นจุด

รีเทิร์น

Number — ความสูงของหน้า หน่วยเป็นจุด

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPageWidth()`

ดึงข้อมูลความกว้างของหน้าเว็บ เป็นจุด

รีเทิร์น

Number — ความกว้างของหน้า หน่วยเป็นจุด

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParagraphs()`

เรียกดู Paragraphs ทั้งหมดที่อยู่ในส่วนนี้ (รวมถึง ListItems)

รีเทิร์น

Paragraph[] — ย่อหน้าหัวข้อ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParent()`

เรียกข้อมูลองค์ประกอบหลักขององค์ประกอบ

องค์ประกอบหลักมีองค์ประกอบปัจจุบัน

รีเทิร์น

ContainerElement — องค์ประกอบระดับบนสุด

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getTables()`

เรียกดู Tables ทั้งหมดที่อยู่ในส่วนนี้

รีเทิร์น

Table[] — ตารางส่วน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getText()`

เรียกคืนเนื้อหาขององค์ประกอบเป็นสตริงข้อความ

รีเทิร์น

String — เนื้อหาขององค์ประกอบเป็นสตริงข้อความ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getTextAlignment()`

ปรับการจัดข้อความ ประเภทการตรวจสอบความสอดคล้องที่ใช้ได้ ได้แก่ DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT และ DocumentApp.TextAlignment.SUPERSCRIPT

รีเทิร์น

TextAlignment — ประเภทการจัดข้อความ หรือ null ถ้าข้อความมีข้อความหลายประเภท การจัดข้อความ หรือหากไม่เคยมีการตั้งค่าการจัดข้อความ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getType()`

เรียกข้อมูล ElementType ขององค์ประกอบ

ใช้ getType() เพื่อระบุประเภทที่แน่นอนขององค์ประกอบที่ระบุ

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

รีเทิร์น

ElementType — ประเภทองค์ประกอบ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertHorizontalRule(childIndex)`

สร้างและแทรก HorizontalRule ใหม่ที่ดัชนีที่ระบุ

HorizontalRule จะอยู่ใน Paragraph ใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรกองค์ประกอบ

รีเทิร์น

HorizontalRule — กฎแนวนอนใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertImage(childIndex, image)`

สร้างและแทรก InlineImage จาก Blob รูปภาพที่ระบุที่ ดัชนี

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรกองค์ประกอบ
`image`	`BlobSource`	ข้อมูลรูปภาพ

รีเทิร์น

InlineImage — รูปภาพที่แทรกในบรรทัด

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertImage(childIndex, image)`

แทรก InlineImage ที่ระบุที่ดัชนีที่ระบุ

รูปภาพจะอยู่ใน Paragraph ใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรกองค์ประกอบ
`image`	`InlineImage`	รูปภาพที่จะแทรก

รีเทิร์น

InlineImage — รูปภาพที่แทรกในบรรทัด

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertListItem(childIndex, listItem)`

แทรก ListItem ที่ระบุที่ดัชนีที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก
`listItem`	`ListItem`	รายการที่จะแทรก

รีเทิร์น

ListItem — รายการรายการที่แทรก

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertListItem(childIndex, text)`

สร้างและแทรก ListItem ใหม่ที่ดัชนีที่ระบุ โดยมีค่าที่ระบุ เนื้อหาข้อความ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก
`text`	`String`	เนื้อหาข้อความของรายการ

รีเทิร์น

ListItem — รายการใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertPageBreak(childIndex)`

สร้างและแทรก PageBreak ใหม่ที่ดัชนีที่ระบุ

PageBreak จะอยู่ใน Paragraph ใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรกองค์ประกอบ

รีเทิร์น

PageBreak — ตัวแบ่งหน้าใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertPageBreak(childIndex, pageBreak)`

แทรก PageBreak ที่ระบุที่ดัชนีที่ระบุ

PageBreak จะอยู่ใน Paragraph ใหม่

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรกองค์ประกอบ
`pageBreak`	`PageBreak`	ตัวแบ่งหน้าที่จะแทรก

รีเทิร์น

PageBreak — ตัวแบ่งหน้าที่แทรก

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertParagraph(childIndex, paragraph)`

แทรก Paragraph ที่ระบุที่ดัชนีที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก
`paragraph`	`Paragraph`	ย่อหน้าที่จะแทรก

รีเทิร์น

Paragraph — ย่อหน้าที่แทรก

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertParagraph(childIndex, text)`

สร้างและแทรก Paragraph ใหม่ที่ดัชนีที่ระบุ โดยมีค่าที่ระบุ เนื้อหาข้อความ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก
`text`	`String`	เนื้อหาข้อความของย่อหน้า

รีเทิร์น

Paragraph — ย่อหน้าใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex)`

สร้างและแทรก Table ใหม่ที่ดัชนีที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก

รีเทิร์น

Table — ตารางใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex, cells)`

สร้างและแทรก Table ใหม่ซึ่งมีเซลล์ที่ระบุที่ดัชนีที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก
`cells`	`String[][]`	เนื้อหาข้อความของเซลล์ตารางที่จะเพิ่มลงในตารางใหม่

รีเทิร์น

Table — ตารางใหม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertTable(childIndex, table)`

แทรก Table ที่ระบุที่ดัชนีที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`childIndex`	`Integer`	ดัชนีที่จะแทรก
`table`	`Table`	ตารางที่จะแทรก

รีเทิร์น

Table — ตารางที่แทรก

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeChild(child)`

นำองค์ประกอบย่อยที่ระบุออก

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`child`	`Element`	องค์ประกอบย่อยที่จะนำออก

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`replaceText(searchPattern, replacement)`

แทนที่ทุกรายการของรูปแบบข้อความที่ระบุด้วยสตริงการแทนที่ที่กำหนด โดยใช้ข้อความปกติ นิพจน์

ระบบจะส่งรูปแบบการค้นหาเป็นสตริง ไม่ใช่ออบเจ็กต์นิพจน์ทั่วไปของ JavaScript ด้วยเหตุนี้ คุณจึงต้องไม่ใช้เครื่องหมายแบ็กสแลชในรูปแบบนี้

วิธีนี้ใช้เมตริก RE2 ของ Google ตามปกติ ไลบรารีนิพจน์ซึ่งจำกัดไวยากรณ์ที่รองรับ

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`searchPattern`	`String`	รูปแบบนิพจน์ทั่วไปที่จะค้นหา
`replacement`	`String`	ข้อความที่จะใช้แทนที่

รีเทิร์น

Element — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAttributes(attributes)`

ตั้งค่าแอตทริบิวต์ขององค์ประกอบ

พารามิเตอร์แอตทริบิวต์ที่ระบุต้องเป็นออบเจ็กต์ที่ชื่อพร็อพเพอร์ตี้แต่ละชื่อเป็นรายการใน การแจงนับ DocumentApp.Attribute และค่าพร็อพเพอร์ตี้แต่ละค่าคือค่าใหม่ ใช้แล้ว

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`attributes`	`Object`	แอตทริบิวต์ขององค์ประกอบ

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setHeadingAttributes(paragraphHeading, attributes)`

ตั้งค่าแอตทริบิวต์สำหรับ ParagraphHeading ที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`paragraphHeading`	`ParagraphHeading`	หัวเรื่องที่ควรตั้งค่าแอตทริบิวต์
`attributes`	`Object`	การแมปแอตทริบิวต์และค่าที่ต้องการกำหนด

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginBottom(marginBottom)`

ตั้งค่าระยะขอบด้านล่างเป็นจุด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`marginBottom`	`Number`	ขอบล่างเป็นจุด

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginLeft(marginLeft)`

ตั้งค่าระยะขอบด้านซ้าย หน่วยเป็นจุด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`marginLeft`	`Number`	ขอบซ้าย หน่วยเป็นจุด

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginRight(marginRight)`

ตั้งค่าระยะขอบด้านขวา หน่วยเป็นจุด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`marginRight`	`Number`	ขอบด้านขวา

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setMarginTop(marginTop)`

ตั้งค่าระยะขอบบน

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`marginTop`	`Number`	ระยะขอบบน เป็นจุด

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setPageHeight(pageHeight)`

กำหนดความสูงของหน้าเว็บเป็นจุด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`pageHeight`	`Number`	ความสูงของหน้าเว็บเป็นจุด

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setPageWidth(pageWidth)`

กำหนดความกว้างของหน้าเว็บ หน่วยเป็นจุด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`pageWidth`	`Number`	ความกว้างของหน้า หน่วยเป็นจุด

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setText(text)`

ตั้งค่าเนื้อหาเป็นข้อความธรรมดา

หมายเหตุ: เนื้อหาที่มีอยู่จะถูกล้าง

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`text`	`String`	เนื้อหาข้อความใหม่

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setTextAlignment(textAlignment)`

ตั้งค่าการจัดข้อความ ประเภทการตรวจสอบความสอดคล้องที่ใช้ได้ ได้แก่ DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT และ DocumentApp.TextAlignment.SUPERSCRIPT

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`textAlignment`	`TextAlignment`	ประเภทการจัดข้อความที่จะใช้

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

วิธีการที่เลิกใช้งานแล้ว

`getFootnotes()`

เลิกใช้งานแล้ว องค์ประกอบนี้ต้องไม่มี Footnote

เรียกดู Footnotes ทั้งหมดที่อยู่ในส่วนนี้

รีเทิร์น

Footnote[] — เชิงอรรถของหัวข้อ

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getLinkUrl()`

เลิกใช้งานแล้ว ใช้ลิงก์ไปยังองค์ประกอบแทนการนำลิงก์ไปยังทั้งส่วนไปใช้ ภายในส่วนนั้นแทน

ดึงข้อมูล URL ของลิงก์

รีเทิร์น

String — URL ของลิงก์ หรือค่าว่างหากองค์ประกอบมีค่าหลายค่าสำหรับแอตทริบิวต์นี้

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNextSibling()`

เลิกใช้งานแล้ว องค์ประกอบนี้ไม่มีข้างเคียง

เรียกข้อมูลองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ

ข้างเคียงมีระดับบนเดียวกันและตามหลังองค์ประกอบปัจจุบัน

รีเทิร์น

Element — องค์ประกอบข้างเคียงถัดไป

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPreviousSibling()`

เลิกใช้งานแล้ว องค์ประกอบนี้ไม่มีข้างเคียง

ดึงองค์ประกอบระดับเดียวกันก่อนหน้านี้ขององค์ประกอบ

รายการข้างเคียงก่อนหน้านี้มีระดับบนสุดเดียวกันและอยู่ก่อนองค์ประกอบปัจจุบัน

รีเทิร์น

Element — องค์ประกอบข้างเคียงก่อนหน้า

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`isAtDocumentEnd()`

เลิกใช้งานแล้ว วิธีนี้ไม่น่าเชื่อถือสำหรับ HeaderSection

กำหนดว่าองค์ประกอบอยู่ที่ส่วนท้ายของ Document หรือไม่

รีเทิร์น

Boolean — องค์ประกอบอยู่ที่ส่วนท้ายของแท็บหรือไม่

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLinkUrl(url)`

ตั้งค่า URL ของลิงก์

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`url`	`String`	URL ของลิงก์

รีเทิร์น

Body — องค์ประกอบปัจจุบัน

การให้สิทธิ์

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents