Class ContainerElement

องค์ประกอบคอนเทนเนอร์

องค์ประกอบทั่วไปที่อาจมีองค์ประกอบอื่นๆ องค์ประกอบทั้งหมดที่อาจมีองค์ประกอบย่อย เช่น Paragraph จะรับช่วงมาจาก ContainerElement

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
asBody()Bodyแสดงผลองค์ประกอบปัจจุบันเป็น Body
asEquation()Equationแสดงผลองค์ประกอบปัจจุบันเป็น Equation
asFooterSection()FooterSectionแสดงผลองค์ประกอบปัจจุบันเป็น FooterSection
asFootnoteSection()FootnoteSectionแสดงผลองค์ประกอบปัจจุบันเป็น FootnoteSection
asHeaderSection()HeaderSectionแสดงผลองค์ประกอบปัจจุบันเป็น HeaderSection
asListItem()ListItemแสดงผลองค์ประกอบปัจจุบันเป็น ListItem
asParagraph()Paragraphแสดงผลองค์ประกอบปัจจุบันเป็น Paragraph
asTable()Tableแสดงผลองค์ประกอบปัจจุบันเป็น Table
asTableCell()TableCellแสดงผลองค์ประกอบปัจจุบันเป็น TableCell
asTableOfContents()TableOfContentsแสดงผลองค์ประกอบปัจจุบันเป็น TableOfContents
asTableRow()TableRowแสดงผลองค์ประกอบปัจจุบันเป็น TableRow
clear()ContainerElementล้างเนื้อหาขององค์ประกอบ
copy()ContainerElementแสดงผลสําเนาเดี่ยวที่แยกองค์ประกอบปัจจุบัน
editAsText()Textรับองค์ประกอบปัจจุบัน Text เวอร์ชันเพื่อแก้ไข
findElement(elementType)RangeElementค้นหาเนื้อหาขององค์ประกอบจากมากไปหาน้อยของประเภทที่ระบุ
findElement(elementType, from)RangeElementค้นหาเนื้อหาขององค์ประกอบในองค์ประกอบสืบทอดจากประเภทที่ระบุ โดยเริ่มจาก RangeElement ที่ระบุ
findText(searchPattern)RangeElementค้นหาเนื้อหาขององค์ประกอบในรูปแบบข้อความที่ระบุโดยใช้นิพจน์ทั่วไป
findText(searchPattern, from)RangeElementค้นหาเนื้อหาขององค์ประกอบสําหรับรูปแบบข้อความที่ระบุ เริ่มจากผลการค้นหาที่กําหนด
getAttributes()Objectดึงแอตทริบิวต์ของ'
getChild(childIndex)Elementเรียกข้อมูลองค์ประกอบย่อยที่ดัชนีย่อยที่ระบุ
getChildIndex(child)Integerเรียกข้อมูลดัชนีย่อยสําหรับองค์ประกอบย่อยที่ระบุ
getLinkUrl()Stringเรียก URL ของลิงก์
getNextSibling()Elementเรียกองค์ประกอบข้างเคียงขององค์ประกอบถัดไป
getNumChildren()Integerดึงข้อมูลจํานวนบุตรหลาน
getParent()ContainerElementเรียกองค์ประกอบหลักขององค์ประกอบ
getPreviousSibling()Elementเรียกองค์ประกอบระดับก่อนหน้าขององค์ประกอบ'
getText()Stringเรียกเนื้อหาขององค์ประกอบเป็นสตริงข้อความ
getTextAlignment()TextAlignmentรับการจัดข้อความ
getType()ElementTypeเรียกดูองค์ประกอบ'ElementType
isAtDocumentEnd()Booleanกําหนดว่าองค์ประกอบอยู่ท้าย Document หรือไม่
merge()ContainerElementผสานองค์ประกอบกับองค์ประกอบข้างเคียงประเภทเดียวกัน
removeFromParent()ContainerElementนําองค์ประกอบออกจากระดับบนสุด
replaceText(searchPattern, replacement)Elementแทนที่รูปแบบข้อความที่ระบุทั้งหมดด้วยสตริงแทนที่ที่ระบุโดยใช้นิพจน์ปกติ
setAttributes(attributes)ContainerElementตั้งค่าแอตทริบิวต์ขององค์ประกอบ
setLinkUrl(url)ContainerElementตั้งค่า URL ของลิงก์
setTextAlignment(textAlignment)ContainerElementตั้งค่าการจัดข้อความ

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

asBody()

แสดงผลองค์ประกอบปัจจุบันเป็น Body

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asEquation()

แสดงผลองค์ประกอบปัจจุบันเป็น Equation

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asFooterSection()

แสดงผลองค์ประกอบปัจจุบันเป็น FooterSection

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asFootnoteSection()

แสดงผลองค์ประกอบปัจจุบันเป็น FootnoteSection

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asHeaderSection()

แสดงผลองค์ประกอบปัจจุบันเป็น HeaderSection

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asListItem()

แสดงผลองค์ประกอบปัจจุบันเป็น ListItem

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asParagraph()

แสดงผลองค์ประกอบปัจจุบันเป็น Paragraph

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asTable()

แสดงผลองค์ประกอบปัจจุบันเป็น Table

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asTableCell()

แสดงผลองค์ประกอบปัจจุบันเป็น TableCell

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asTableOfContents()

แสดงผลองค์ประกอบปัจจุบันเป็น TableOfContents

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

asTableRow()

แสดงผลองค์ประกอบปัจจุบันเป็น TableRow

ใช้วิธีนี้ช่วยเติมข้อความอัตโนมัติเมื่อระบบรู้ว่าองค์ประกอบหนึ่งๆ เป็นประเภทที่เจาะจง

ไปกลับ

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

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

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

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

clear()

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

ไปกลับ

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

copy()

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

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

ไปกลับ

ContainerElement — สําเนาใหม่

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

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

  • 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)

ค้นหาเนื้อหาขององค์ประกอบจากมากไปหาน้อยของประเภทที่ระบุ

พารามิเตอร์

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

ไปกลับ

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

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

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

  • 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;
  }
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
elementTypeElementTypeประเภทขององค์ประกอบที่จะค้นหา
fromRangeElementผลการค้นหาที่ใช้ค้นหา

ไปกลับ

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

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

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

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

findText(searchPattern)

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

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

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

พารามิเตอร์

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

ไปกลับ

RangeElement — ผลการค้นหาที่แสดงตําแหน่งของข้อความค้นหา หรือมีค่า Null หากไม่มีรายการที่ตรงกัน

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

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

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

findText(searchPattern, from)

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

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

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
searchPatternStringรูปแบบที่จะค้นหา
fromRangeElementผลการค้นหาที่ใช้ค้นหา

ไปกลับ

RangeElement — ผลการค้นหาที่แสดงตําแหน่งถัดไปของข้อความค้นหา หรือเป็นค่าว่างหากไม่ตรงกัน

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

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

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

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

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

  • 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.");
}

พารามิเตอร์

ชื่อประเภทคำอธิบาย
childIndexIntegerดัชนีองค์ประกอบย่อยเพื่อดึง

ไปกลับ

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

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

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

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

getChildIndex(child)

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

พารามิเตอร์

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

ไปกลับ

Integer — ดัชนีย่อย

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

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

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

getLinkUrl()

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

ไปกลับ

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

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

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

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

getNextSibling()

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

พี่น้องถัดไปมีระดับบนสุดเดียวกันและเป็นไปตามองค์ประกอบปัจจุบัน

ไปกลับ

Element — องค์ประกอบพี่น้องถัดไป

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

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

  • 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 — จํานวนบุตร

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

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

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

getParent()

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

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

ไปกลับ

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

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

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

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

getPreviousSibling()

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

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

ไปกลับ

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

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

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

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

getText()

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

ไปกลับ

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

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

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

  • 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 หากข้อความมีการจัดเรียงข้อความหลายประเภท หรือหากไม่เคยมีการตั้งค่าการจัดเรียงข้อความ

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

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

  • 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 — ประเภทขององค์ประกอบ

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

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

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

isAtDocumentEnd()

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

ไปกลับ

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

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

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

  • 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();

ไปกลับ

ContainerElement — องค์ประกอบที่ผสาน

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

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

  • 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();
}

ไปกลับ

ContainerElement — องค์ประกอบที่นําออก

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

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

  • 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");

พารามิเตอร์

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

ไปกลับ

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

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

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

  • 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);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
attributesObjectแอตทริบิวต์'s

ไปกลับ

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

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

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

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

setLinkUrl(url)

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

พารามิเตอร์

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

ไปกลับ

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

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

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

  • 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);

พารามิเตอร์

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

ไปกลับ

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

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

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

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