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

Class ListItem

องค์ประกอบที่แสดงรายการในลิสต์ ListItem คือ Paragraph ที่เชื่อมโยงกับรหัสรายการ ListItem อาจมีองค์ประกอบ Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak และ Text ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างเอกสารได้ในคู่มือการขยายการใช้งาน Google เอกสาร

ListItems ไม่สามารถมีอักขระขึ้นบรรทัดใหม่ อักขระขึ้นบรรทัดใหม่ ("\n") จะถูกแปลงเป็นอักขระขึ้นบรรทัดใหม่ ("\r")

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

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

// Append a new list item to the body.
var item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([
  ['Cell 1', 'Cell 2']
]);

// Append a second list item with the same list ID. The two items are treated as the same list,
// despite not being consecutive.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

วิธีการ

วิธีการ	ประเภทการแสดงผล	รายละเอียดแบบย่อ
`addPositionedImage(image)`	`PositionedImage`	สร้างและแทรก `PositionedImage` ใหม่จาก Blob ของรูปภาพที่ระบุ
`appendHorizontalRule()`	`HorizontalRule`	สร้างและต่อท้าย `HorizontalRule` ใหม่
`appendInlineImage(image)`	`InlineImage`	สร้างและต่อท้าย `InlineImage` ใหม่จาก Blob ของรูปภาพที่ระบุ
`appendInlineImage(image)`	`InlineImage`	เพิ่ม `InlineImage` ที่ให้มาด้วย
`appendPageBreak()`	`PageBreak`	สร้างและต่อท้าย `PageBreak` ใหม่
`appendPageBreak(pageBreak)`	`PageBreak`	เพิ่ม `PageBreak` ที่ให้มาด้วย
`appendText(text)`	`Text`	สร้างและต่อท้ายองค์ประกอบ `Text` ใหม่ด้วยเนื้อหาที่ระบุ
`appendText(text)`	`Text`	เพิ่มองค์ประกอบ `Text` ที่ระบุ
`clear()`	`ListItem`	ล้างเนื้อหาขององค์ประกอบ
`copy()`	`ListItem`	แสดงผลสำเนาแบบเจาะลึกขององค์ประกอบปัจจุบันที่แยกออกมา
`editAsText()`	`Text`	รับองค์ประกอบปัจจุบันเวอร์ชัน `Text` เพื่อแก้ไข
`findElement(elementType)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบสำหรับองค์ประกอบสืบทอดของประเภทที่ระบุ
`findElement(elementType, from)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบสำหรับองค์ประกอบสืบทอดของประเภทที่ระบุ โดยเริ่มจาก `RangeElement` ที่ระบุ
`findText(searchPattern)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุโดยใช้นิพจน์ทั่วไป
`findText(searchPattern, from)`	`RangeElement`	ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุ โดยเริ่มจากผลการค้นหาที่ระบุ
`getAlignment()`	`HorizontalAlignment`	เรียกข้อมูล `HorizontalAlignment`
`getAttributes()`	`Object`	เรียกแอตทริบิวต์ขององค์ประกอบ
`getChild(childIndex)`	`Element`	เรียกองค์ประกอบย่อยที่ดัชนีย่อยที่ระบุ
`getChildIndex(child)`	`Integer`	เรียกดัชนีย่อยสำหรับองค์ประกอบย่อยที่ระบุ
`getGlyphType()`	`GlyphType`	ดึง `GlyphType` ของรายการ
`getHeading()`	`ParagraphHeading`	เรียกข้อมูล `ParagraphHeading`
`getIndentEnd()`	`Number`	ดึงการเยื้องท้ายบรรทัด เป็นจุด
`getIndentFirstLine()`	`Number`	ดึงการเยื้องบรรทัดแรก เป็นจุด
`getIndentStart()`	`Number`	เรียกการเยื้องเริ่มต้น
`getLineSpacing()`	`Number`	ดึงระยะห่างระหว่างบรรทัด หน่วยเป็นจุด
`getLinkUrl()`	`String`	เรียก URL ของลิงก์
`getListId()`	`String`	เรียกรหัสรายการ
`getNestingLevel()`	`Integer`	เรียกระดับการซ้อนของรายการ
`getNextSibling()`	`Element`	เรียกองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ
`getNumChildren()`	`Integer`	ดึงจำนวนเด็ก
`getParent()`	`ContainerElement`	เรียกองค์ประกอบระดับบนขององค์ประกอบ
`getPositionedImage(id)`	`PositionedImage`	รับ `PositionedImage` จากรหัสรูปภาพ
`getPositionedImages()`	`PositionedImage[]`	รับออบเจ็กต์ `PositionedImage` ทั้งหมดที่ตรึงไว้ในย่อหน้า
`getPreviousSibling()`	`Element`	เรียกองค์ประกอบข้างเคียงก่อนหน้าขององค์ประกอบ
`getSpacingAfter()`	`Number`	ดึงระยะห่างหลังองค์ประกอบเป็นจุด
`getSpacingBefore()`	`Number`	ดึงระยะห่างก่อนองค์ประกอบเป็นจุด
`getText()`	`String`	เรียกเนื้อหาขององค์ประกอบเป็นสตริงข้อความ
`getTextAlignment()`	`TextAlignment`	รับการจัดข้อความ
`getType()`	`ElementType`	ดึงข้อมูล `ElementType` ขององค์ประกอบ
`insertHorizontalRule(childIndex)`	`HorizontalRule`	สร้างและแทรก `HorizontalRule` ที่ดัชนีที่ระบุ
`insertInlineImage(childIndex, image)`	`InlineImage`	สร้างและแทรก `InlineImage` ใหม่จาก Blob ของรูปภาพที่ระบุที่ดัชนีที่ระบุ
`insertInlineImage(childIndex, image)`	`InlineImage`	แทรก `InlineImage` ที่ระบุที่ดัชนีที่ระบุ
`insertPageBreak(childIndex)`	`PageBreak`	สร้างและแทรก `PageBreak` ใหม่ที่ดัชนีที่ระบุ
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	แทรก `PageBreak` ที่ระบุที่ดัชนีที่ระบุ
`insertText(childIndex, text)`	`Text`	สร้างและแทรกองค์ประกอบของข้อความใหม่ที่ดัชนีที่ระบุ
`insertText(childIndex, text)`	`Text`	แทรกองค์ประกอบ `Text` ที่ให้ไว้ในดัชนีที่ระบุพร้อมกับเนื้อหาข้อความที่ระบุ
`isAtDocumentEnd()`	`Boolean`	ระบุว่าองค์ประกอบอยู่ที่ส่วนท้ายของ `Document` หรือไม่
`isLeftToRight()`	`Boolean`	เรียกดูการตั้งค่าจากซ้ายไปขวา
`merge()`	`ListItem`	ผสานรวมองค์ประกอบกับข้างเคียงที่อยู่ก่อนหน้าซึ่งเป็นประเภทเดียวกัน
`removeChild(child)`	`ListItem`	นำองค์ประกอบย่อยที่ระบุออก
`removeFromParent()`	`ListItem`	นำองค์ประกอบออกจากระดับบนสุด
`removePositionedImage(id)`	`Boolean`	นำ `PositionedImage` ออกตามรหัสของรูปภาพ
`replaceText(searchPattern, replacement)`	`Element`	แทนที่รายการทั้งหมดของรูปแบบข้อความที่ระบุด้วยสตริงการแทนที่หนึ่งๆ โดยใช้นิพจน์ทั่วไป
`setAlignment(alignment)`	`ListItem`	ตั้งค่า `HorizontalAlignment`
`setAttributes(attributes)`	`ListItem`	ตั้งค่าแอตทริบิวต์ขององค์ประกอบ
`setGlyphType(glyphType)`	`ListItem`	ตั้งค่า `GlyphType` ของรายการ
`setHeading(heading)`	`ListItem`	ตั้งค่า `ParagraphHeading`
`setIndentEnd(indentEnd)`	`ListItem`	ตั้งค่าการเยื้องสิ้นสุด เป็นจุด
`setIndentFirstLine(indentFirstLine)`	`ListItem`	ตั้งค่าการเยื้องบรรทัดแรก ในหน่วย Point
`setIndentStart(indentStart)`	`ListItem`	ตั้งค่าการเยื้องเริ่มต้น เป็นจุด
`setLeftToRight(leftToRight)`	`ListItem`	ตั้งค่าจากซ้ายไปขวา
`setLineSpacing(multiplier)`	`ListItem`	ตั้งค่าการเว้นระยะห่างระหว่างบรรทัด เป็นจำนวนที่ระบุจำนวนบรรทัดที่จะใช้สำหรับการเว้นระยะห่าง
`setLinkUrl(url)`	`ListItem`	ตั้งค่า URL ของลิงก์
`setListId(listItem)`	`ListItem`	ตั้งค่ารหัสรายการ
`setNestingLevel(nestingLevel)`	`ListItem`	ตั้งค่าระดับการซ้อนของรายการ
`setSpacingAfter(spacingAfter)`	`ListItem`	กำหนดระยะห่างหลังองค์ประกอบในหน่วยจุด
`setSpacingBefore(spacingBefore)`	`ListItem`	กําหนดระยะห่างก่อนองค์ประกอบ หน่วยเป็นจุด
`setText(text)`	`void`	ตั้งค่าเนื้อหาของรายการเป็นข้อความ
`setTextAlignment(textAlignment)`	`ListItem`	ตั้งค่าการจัดข้อความ

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

`addPositionedImage(image)`

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

พารามิเตอร์

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

รีเทิร์น

PositionedImage — รูปภาพที่วางตำแหน่งใหม่

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

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

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

`appendHorizontalRule()`

สร้างและต่อท้าย HorizontalRule ใหม่

รีเทิร์น

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

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

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

`appendInlineImage(image)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`appendInlineImage(image)`

เพิ่ม InlineImage ที่ให้มาด้วย

พารามิเตอร์

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

รีเทิร์น

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

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

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

`appendPageBreak()`

สร้างและต่อท้าย PageBreak ใหม่

หมายเหตุ: PageBreaks อาจไม่อยู่ใน TableCells ถ้าองค์ประกอบปัจจุบันอยู่ในเซลล์ตาราง จะมีการส่งข้อยกเว้น

รีเทิร์น

PageBreak — องค์ประกอบตัวแบ่งหน้าใหม่

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

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

`appendPageBreak(pageBreak)`

เพิ่ม PageBreak ที่ให้มาด้วย

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`pageBreak`	`PageBreak`	ตัวแบ่งหน้าที่จะต่อท้าย

รีเทิร์น

PageBreak — องค์ประกอบตัวแบ่งหน้าที่ต่อท้าย

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

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

`appendText(text)`

สร้างและต่อท้ายองค์ประกอบ Text ใหม่ด้วยเนื้อหาที่ระบุ

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`text`	`String`	เนื้อหาข้อความ

รีเทิร์น

Text — องค์ประกอบข้อความใหม่

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

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

`appendText(text)`

เพิ่มองค์ประกอบ Text ที่ระบุ

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`text`	`Text`	องค์ประกอบของข้อความที่จะต่อท้าย

รีเทิร์น

Text — องค์ประกอบของข้อความที่ต่อท้าย

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

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

`clear()`

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

รีเทิร์น

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

`copy()`

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

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

รีเทิร์น

ListItem — สำเนาใหม่

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

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().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)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`findElement(elementType, from)`

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().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;
  }
}

พารามิเตอร์

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

รีเทิร์น

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

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

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

`findText(searchPattern)`

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

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`searchPattern`	`String`	รูปแบบที่ต้องการค้นหา

รีเทิร์น

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

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

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

`findText(searchPattern, from)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`getAlignment()`

เรียกข้อมูล HorizontalAlignment

รีเทิร์น

HorizontalAlignment — การจัดข้อความ

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

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

`getAttributes()`

เรียกแอตทริบิวต์ขององค์ประกอบ

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

var body = DocumentApp.getActiveDocument().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)`

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
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.");
}

พารามิเตอร์

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

รีเทิร์น

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

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

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

`getChildIndex(child)`

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

พารามิเตอร์

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

รีเทิร์น

Integer — ดัชนีย่อย

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

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

`getGlyphType()`

ดึง GlyphType ของรายการ

รีเทิร์น

GlyphType — ประเภทรูปอักขระ

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

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

`getHeading()`

เรียกข้อมูล ParagraphHeading

รีเทิร์น

ParagraphHeading — ส่วนหัว

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

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

`getIndentEnd()`

ดึงการเยื้องท้ายบรรทัด เป็นจุด

รีเทิร์น

Number — การเยื้องท้ายบรรทัด ใน Point

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

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

`getIndentFirstLine()`

ดึงการเยื้องบรรทัดแรก เป็นจุด

รีเทิร์น

Number — การเยื้องบรรทัดแรก ในหน่วย Point

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

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

`getIndentStart()`

เรียกการเยื้องเริ่มต้น

รีเทิร์น

Number — การเยื้องต้นบรรทัด

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

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

`getLineSpacing()`

ดึงระยะห่างระหว่างบรรทัด หน่วยเป็นจุด

รีเทิร์น

Number — ระยะห่างระหว่างบรรทัด หน่วยเป็นจุด

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

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

`getLinkUrl()`

เรียก URL ของลิงก์

รีเทิร์น

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

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

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

`getListId()`

เรียกรหัสรายการ

รีเทิร์น

String — รหัสรายการ

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

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

`getNestingLevel()`

เรียกระดับการซ้อนของรายการ

โดยค่าเริ่มต้น รายการจะมีระดับการซ้อนเป็น 0 ระดับการซ้อนจะกำหนดรูปอักขระที่ใช้ในรายการ

รีเทิร์น

Integer — ระดับการซ้อน

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

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

`getNumChildren()`

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

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

รีเทิร์น

Integer — จำนวนเด็ก

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

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

`getPositionedImage(id)`

รับ PositionedImage จากรหัสรูปภาพ

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`id`	`String`	รหัสรูปภาพ

รีเทิร์น

PositionedImage — รูปภาพที่วางตำแหน่ง

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

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

`getPositionedImages()`

รับออบเจ็กต์ PositionedImage ทั้งหมดที่ตรึงไว้ในย่อหน้า

รีเทิร์น

PositionedImage[] — รายการรูปภาพที่วางตำแหน่ง

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

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

`getSpacingAfter()`

ดึงระยะห่างหลังองค์ประกอบเป็นจุด

รีเทิร์น

Number — ระยะห่างหลังองค์ประกอบ หน่วยเป็นจุด

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

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

`getSpacingBefore()`

ดึงระยะห่างก่อนองค์ประกอบเป็นจุด

รีเทิร์น

Number — ระยะห่างก่อนองค์ประกอบ หน่วยเป็นจุด

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

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 body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document 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 ที่ดัชนีที่ระบุ

พารามิเตอร์

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

รีเทิร์น

HorizontalRule — องค์ประกอบกฎแนวนอนใหม่

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

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

`insertInlineImage(childIndex, image)`

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

พารามิเตอร์

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

รีเทิร์น

InlineImage — องค์ประกอบรูปภาพที่แทรกในบรรทัด

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

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

`insertInlineImage(childIndex, image)`

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

พารามิเตอร์

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

รีเทิร์น

InlineImage — องค์ประกอบรูปภาพที่แทรกในบรรทัด

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

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

`insertPageBreak(childIndex)`

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

พารามิเตอร์

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

รีเทิร์น

PageBreak — องค์ประกอบตัวแบ่งหน้าใหม่

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

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

`insertPageBreak(childIndex, pageBreak)`

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

พารามิเตอร์

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

รีเทิร์น

PageBreak — องค์ประกอบตัวแบ่งหน้าที่แทรก

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

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

`insertText(childIndex, text)`

สร้างและแทรกองค์ประกอบของข้อความใหม่ที่ดัชนีที่ระบุ

พารามิเตอร์

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

รีเทิร์น

Text — องค์ประกอบข้อความใหม่

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

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

`insertText(childIndex, text)`

แทรกองค์ประกอบ Text ที่ให้ไว้ในดัชนีที่ระบุพร้อมกับเนื้อหาข้อความที่ระบุ

พารามิเตอร์

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

รีเทิร์น

Text — องค์ประกอบของข้อความที่แทรก

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

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

`isAtDocumentEnd()`

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

รีเทิร์น

Boolean — องค์ประกอบอยู่ท้ายเอกสารหรือไม่

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

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

`isLeftToRight()`

เรียกดูการตั้งค่าจากซ้ายไปขวา

รีเทิร์น

Boolean — การตั้งค่าจากซ้ายไปขวา

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

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

`merge()`

ผสานรวมองค์ประกอบกับข้างเคียงที่อยู่ก่อนหน้าซึ่งเป็นประเภทเดียวกัน

รวมได้เฉพาะองค์ประกอบของ ElementType เดียวกัน องค์ประกอบย่อยที่อยู่ในองค์ประกอบปัจจุบันจะย้ายไปยังองค์ประกอบระดับข้างเคียงที่อยู่ก่อนหน้า

องค์ประกอบปัจจุบันจะถูกนำออกจากเอกสาร

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

รีเทิร์น

ListItem — องค์ประกอบที่รวมกัน

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

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

`removeChild(child)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`removeFromParent()`

นำองค์ประกอบออกจากระดับบนสุด

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

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

รีเทิร์น

ListItem — องค์ประกอบที่นำออก

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

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

`removePositionedImage(id)`

นำ PositionedImage ออกตามรหัสของรูปภาพ

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`id`	`String`

รีเทิร์น

Boolean — นำรูปภาพที่ระบุออกหรือไม่

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

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

`replaceText(searchPattern, replacement)`

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

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setAlignment(alignment)`

ตั้งค่า HorizontalAlignment

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`alignment`	`HorizontalAlignment`	การจัดข้อความแนวนอน

รีเทิร์น

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

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

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

`setAttributes(attributes)`

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

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

var body = DocumentApp.getActiveDocument().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);

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setGlyphType(glyphType)`

ตั้งค่า GlyphType ของรายการ

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`glyphType`	`GlyphType`	ประเภทรูปอักขระ

รีเทิร์น

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

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

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

`setHeading(heading)`

ตั้งค่า ParagraphHeading

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`heading`	`ParagraphHeading`	ส่วนหัว

รีเทิร์น

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

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

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

`setIndentEnd(indentEnd)`

ตั้งค่าการเยื้องสิ้นสุด เป็นจุด

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`indentEnd`	`Number`	การเยื้องท้ายบรรทัด ในจุด

รีเทิร์น

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

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

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

`setIndentFirstLine(indentFirstLine)`

ตั้งค่าการเยื้องบรรทัดแรก ในหน่วย Point

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`indentFirstLine`	`Number`	การเยื้องบรรทัดแรก ในหน่วยจุด

รีเทิร์น

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

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

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

`setIndentStart(indentStart)`

ตั้งค่าการเยื้องเริ่มต้น เป็นจุด

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`indentStart`	`Number`	การเยื้องเริ่มต้น ในจุด

รีเทิร์น

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

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

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

`setLeftToRight(leftToRight)`

ตั้งค่าจากซ้ายไปขวา

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`leftToRight`	`Boolean`	การตั้งค่าจากซ้ายไปขวา

รีเทิร์น

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

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

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

`setLineSpacing(multiplier)`

ตั้งค่าการเว้นระยะห่างระหว่างบรรทัด เป็นจำนวนที่ระบุจำนวนบรรทัดที่จะใช้สำหรับการเว้นระยะห่าง

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`multiplier`	`Number`	จำนวนเส้น

รีเทิร์น

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

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

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

`setLinkUrl(url)`

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`url`	`String`	URL ของลิงก์

รีเทิร์น

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

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

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

`setListId(listItem)`

ตั้งค่ารหัสรายการ

ตั้งค่ารหัสรายการเป็นค่าเดียวกันสำหรับ ListItem ที่ระบุ ListItems ทั้ง 2 รายการจะถือว่าเป็นสมาชิกในรายการเดียวกัน

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`listItem`	`ListItem`	รายการที่มีรหัสรายการที่จะใช้

รีเทิร์น

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

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

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

`setNestingLevel(nestingLevel)`

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`nestingLevel`	`Integer`	ระดับการซ้อน

รีเทิร์น

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

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

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

`setSpacingAfter(spacingAfter)`

กำหนดระยะห่างหลังองค์ประกอบในหน่วยจุด

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`spacingAfter`	`Number`	ระยะห่างหลังองค์ประกอบ หน่วยเป็นจุด

รีเทิร์น

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

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

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

`setSpacingBefore(spacingBefore)`

กําหนดระยะห่างก่อนองค์ประกอบ หน่วยเป็นจุด

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`spacingBefore`	`Number`	ระยะห่างก่อนองค์ประกอบ หน่วยเป็นจุด

รีเทิร์น

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

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

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

`setText(text)`

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

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

พารามิเตอร์

ชื่อ	Type	คำอธิบาย
`text`	`String`	เนื้อหาข้อความใหม่

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

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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

พารามิเตอร์

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

รีเทิร์น

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

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

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