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

Class ListItem

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

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

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

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

// Append a new list item to the body.
const 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.
const 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)

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

const 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 ที่ระบุ

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

พารามิเตอร์

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

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

รีเทิร์น

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

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

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

`getChild(childIndex)`

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

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

// Obtain the first element in the tab.
const 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()`

ดึงข้อมูลจํานวนเด็ก

const 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() เพื่อระบุประเภทที่แน่นอนขององค์ประกอบหนึ่งๆ

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

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

const 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`	p[page break to insert

รีเทิร์น

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 เดียวกันเท่านั้น ระบบจะย้ายองค์ประกอบย่อยที่อยู่ในองค์ประกอบปัจจุบันไปยังองค์ประกอบพี่น้องก่อนหน้า

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const 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()`

นำองค์ประกอบออกจากองค์ประกอบหลัก

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let 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 ซึ่งจํากัดไวยากรณ์ที่รองรับ

const 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 และค่าพร็อพเพอร์ตี้แต่ละรายการเป็นค่าใหม่ที่จะใช้

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

// Define a custom paragraph style.
const 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.
const 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.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const 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