หน้านี้ได้รับการแปลโดย 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().getActiveTab().asDocumentTab().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`	ตั้งค่าการเยื้องบรรทัดแรก หน่วยเป็นจุด
`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 รูปภาพที่ระบุ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 ของรูปภาพที่ระบุ

พารามิเตอร์

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

รีเทิร์น

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

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

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

`appendInlineImage(image)`

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 ที่ระบุ

พารามิเตอร์

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

รีเทิร์น

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

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

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

`appendText(text)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`appendText(text)`

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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().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

`getAlignment()`

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

รีเทิร์น

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

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

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

`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 — การเยื้องท้ายสุด เป็นจุด

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

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

`getIndentFirstLine()`

ดึงข้อมูลการเยื้องบรรทัดแรก ในหน่วยจุด

รีเทิร์น

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

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

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 ของลิงก์ หรือค่าว่างหากองค์ประกอบมีค่าหลายค่าสำหรับแอตทริบิวต์นี้

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

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

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

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

`getParent()`

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

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

รีเทิร์น

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

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

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

`getPositionedImage(id)`

รับ PositionedImage ตามรหัสของรูปภาพ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 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 ที่ดัชนีที่ระบุ

พารามิเตอร์

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

รีเทิร์น

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

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

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

`insertInlineImage(childIndex, image)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`insertInlineImage(childIndex, image)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`insertPageBreak(childIndex)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`insertPageBreak(childIndex, pageBreak)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`insertText(childIndex, text)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`insertText(childIndex, text)`

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`removeFromParent()`

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

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

// Remove all images in the active tab's 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 ออกโดยใช้รหัสของรูปภาพ

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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().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

`setAlignment(alignment)`

ตั้งค่าHorizontalAlignment

พารามิเตอร์

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

รีเทิร์น

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

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

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`	แอตทริบิวต์ขององค์ประกอบ

รีเทิร์น

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

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

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

`setGlyphType(glyphType)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setHeading(heading)`

ตั้งค่าParagraphHeading

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`heading`	`ParagraphHeading`	ส่วนหัว

รีเทิร์น

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

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

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

`setIndentEnd(indentEnd)`

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`indentEnd`	`Number`	การเยื้องท้ายสุด เป็นจุด

รีเทิร์น

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

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

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

`setIndentFirstLine(indentFirstLine)`

ตั้งค่าการเยื้องบรรทัดแรก หน่วยเป็นจุด

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`indentFirstLine`	`Number`	เยื้องบรรทัดแรก เป็นจุด

รีเทิร์น

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

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

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

`setIndentStart(indentStart)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setLeftToRight(leftToRight)`

กำหนดการตั้งค่าจากซ้ายไปขวา

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setLineSpacing(multiplier)`

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`multiplier`	`Number`	จำนวนบรรทัด

รีเทิร์น

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

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

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

`setLinkUrl(url)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setListId(listItem)`

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setNestingLevel(nestingLevel)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setSpacingAfter(spacingAfter)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setSpacingBefore(spacingBefore)`

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

`setText(text)`

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

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

พารามิเตอร์

ชื่อ	ประเภท	คำอธิบาย
`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 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`	ประเภทการจัดข้อความที่จะใช้

รีเทิร์น

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

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

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