Interface Element

องค์ประกอบ

องค์ประกอบทั่วไป เนื้อหา Document รายการ แสดงเป็นองค์ประกอบ ตัวอย่างเช่น ListItem Paragraph และ Table และรับช่วงเมธอดทั้งหมดที่กำหนดโดย Element เช่น getType()

การนำชั้นเรียนไปใช้

ชื่อรายละเอียดแบบย่อ
Bodyเนื้อหาของแท็บในเอกสาร Google เอกสาร
ContainerElementองค์ประกอบทั่วไปที่อาจมีองค์ประกอบอื่นๆ
Dateองค์ประกอบที่แสดงวันที่จัดรูปแบบ
Equationองค์ประกอบที่แสดงถึงนิพจน์ทางคณิตศาสตร์
EquationFunctionองค์ประกอบที่แสดงถึงฟังก์ชันใน Equation ทางคณิตศาสตร์
EquationFunctionArgumentSeparatorองค์ประกอบที่แสดงถึงตัวคั่นฟังก์ชันใน Equation ทางคณิตศาสตร์
EquationSymbolองค์ประกอบที่แสดงถึงสัญลักษณ์ใน Equation ทางคณิตศาสตร์
FooterSectionองค์ประกอบที่แสดงถึงส่วนท้าย
Footnoteองค์ประกอบที่แสดงเชิงอรรถ
FootnoteSectionองค์ประกอบที่แสดงส่วนเชิงอรรถ
HeaderSectionองค์ประกอบที่แสดงถึงส่วนหัว
HorizontalRuleองค์ประกอบที่แสดงถึงกฎแนวนอน
InlineDrawingองค์ประกอบที่แสดงถึงภาพวาดที่ฝัง
InlineImageองค์ประกอบที่แสดงถึงรูปภาพที่ฝัง
ListItemองค์ประกอบที่แสดงข้อมูลในรายการ
PageBreakองค์ประกอบที่แสดงถึงตัวแบ่งหน้า
Paragraphองค์ประกอบที่แสดงถึงย่อหน้า
Personองค์ประกอบที่แสดงลิงก์ไปยังบุคคล
RichLinkองค์ประกอบที่แสดงลิงก์ไปยังแหล่งข้อมูลของ Google เช่น ไฟล์ในไดรฟ์หรือวิดีโอ YouTube
Tableองค์ประกอบที่แสดงถึงตาราง
TableCellองค์ประกอบที่แสดงถึงเซลล์ในตาราง
TableOfContentsองค์ประกอบที่มีสารบัญ
TableRowองค์ประกอบที่แสดงแถวในตาราง
Textองค์ประกอบที่แสดงถึงพื้นที่ Rich Text
UnsupportedElementองค์ประกอบที่แสดงถึงภูมิภาคที่ไม่รู้จักหรือไม่ได้รับผลกระทบจากสคริปต์ เช่น เลขหน้า

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
asBody()Bodyแสดงผลองค์ประกอบปัจจุบันเป็น Body
asDate()Dateแสดงผลองค์ประกอบปัจจุบันเป็น Date
asEquation()Equationแสดงผลองค์ประกอบปัจจุบันเป็น Equation
asEquationFunction()EquationFunctionแสดงผลองค์ประกอบปัจจุบันเป็น EquationFunction
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorแสดงผลองค์ประกอบปัจจุบันเป็น EquationFunctionArgumentSeparator
asEquationSymbol()EquationSymbolแสดงผลองค์ประกอบปัจจุบันเป็น EquationSymbol
asFooterSection()FooterSectionแสดงผลองค์ประกอบปัจจุบันเป็น FooterSection
asFootnote()Footnoteแสดงผลองค์ประกอบปัจจุบันเป็น Footnote
asFootnoteSection()FootnoteSectionแสดงผลองค์ประกอบปัจจุบันเป็น FootnoteSection
asHeaderSection()HeaderSectionแสดงผลองค์ประกอบปัจจุบันเป็น HeaderSection
asHorizontalRule()HorizontalRuleแสดงผลองค์ประกอบปัจจุบันเป็น HorizontalRule
asInlineDrawing()InlineDrawingแสดงผลองค์ประกอบปัจจุบันเป็น InlineDrawing
asInlineImage()InlineImageแสดงผลองค์ประกอบปัจจุบันเป็น InlineImage
asListItem()ListItemแสดงผลองค์ประกอบปัจจุบันเป็น ListItem
asPageBreak()PageBreakแสดงผลองค์ประกอบปัจจุบันเป็น PageBreak
asParagraph()Paragraphแสดงผลองค์ประกอบปัจจุบันเป็น Paragraph
asPerson()Personแสดงผลองค์ประกอบปัจจุบันเป็น Person
asRichLink()RichLinkแสดงผลองค์ประกอบปัจจุบันเป็น RichLink เช่น ลิงก์ไปยังไฟล์ Google ชีต
asTable()Tableแสดงผลองค์ประกอบปัจจุบันเป็น Table
asTableCell()TableCellแสดงผลองค์ประกอบปัจจุบันเป็น TableCell
asTableOfContents()TableOfContentsแสดงผลองค์ประกอบปัจจุบันเป็น TableOfContents
asTableRow()TableRowแสดงผลองค์ประกอบปัจจุบันเป็น TableRow
asText()Textแสดงผลองค์ประกอบปัจจุบันเป็น Text
copy()Elementแสดงผลสำเนาที่แยกส่วนลึกขององค์ประกอบปัจจุบัน
getAttributes()Objectดึงแอตทริบิวต์ขององค์ประกอบ
getNextSibling()Elementเรียกข้อมูลองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ
getParent()ContainerElementเรียกข้อมูลองค์ประกอบหลักขององค์ประกอบ
getPreviousSibling()Elementดึงองค์ประกอบระดับเดียวกันก่อนหน้านี้ขององค์ประกอบ
getType()ElementTypeเรียกข้อมูล ElementType ขององค์ประกอบ
isAtDocumentEnd()Booleanกำหนดว่าองค์ประกอบอยู่ที่ส่วนท้ายของ Document หรือไม่
merge()Elementผสานองค์ประกอบกับรายการข้างเคียงที่อยู่ก่อนหน้าประเภทเดียวกัน
removeFromParent()Elementนำองค์ประกอบออกจากระดับบนสุด
setAttributes(attributes)Elementตั้งค่าแอตทริบิวต์ขององค์ประกอบ

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

asBody()

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

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

รีเทิร์น

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

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

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

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

asDate()

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

เมื่อทราบว่าองค์ประกอบหนึ่งๆ เป็น Date ให้ใช้วิธีนี้เพื่อตั้งค่าประเภทองค์ประกอบเป็น Date ซึ่งจะช่วยให้การเติมข้อความอัตโนมัติในเครื่องมือแก้ไข Apps Script แสดงวิธีการที่ใช้ได้ ด้วย Date

รีเทิร์น

Date — องค์ประกอบปัจจุบันที่ตั้งค่าประเภทเป็น Date

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

asEquationFunction()

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

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

รีเทิร์น

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

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

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

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

asEquationFunctionArgumentSeparator()

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

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

รีเทิร์น

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

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

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

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

asEquationSymbol()

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

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

รีเทิร์น

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

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

asFootnote()

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

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

รีเทิร์น

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

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

asHorizontalRule()

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

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

รีเทิร์น

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

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

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

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

asInlineDrawing()

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

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

รีเทิร์น

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

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

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

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

asInlineImage()

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

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

รีเทิร์น

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

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

asPageBreak()

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

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

รีเทิร์น

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

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

asPerson()

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

เมื่อทราบว่าองค์ประกอบหนึ่งๆ เป็น Person ให้ใช้วิธีการนี้เพื่อกำหนดประเภทองค์ประกอบเป็นบุคคล ซึ่งจะช่วยให้การเติมข้อความอัตโนมัติในเครื่องมือแก้ไข Apps Script แสดงวิธีการที่คุณสามารถใช้ด้วย องค์ประกอบบุคคล

รีเทิร์น

Person — องค์ประกอบปัจจุบันที่ตั้งค่าประเภทเป็น Person

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

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

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

แสดงผลองค์ประกอบปัจจุบันเป็น RichLink เช่น ลิงก์ไปยังไฟล์ Google ชีต

เมื่อทราบว่าองค์ประกอบหนึ่งๆ เป็น RichLink ให้ใช้วิธีนี้เพื่อตั้งค่าประเภทองค์ประกอบเป็น RichLink ซึ่งจะทำให้การเติมข้อความอัตโนมัติในเครื่องมือแก้ไข Apps Script แสดงวิธีการที่คุณทำได้ ใช้กับ RichLink

รีเทิร์น

RichLink — องค์ประกอบปัจจุบันที่ตั้งค่าประเภทเป็น RichLink

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

asText()

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

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

รีเทิร์น

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

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

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

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

copy()

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

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

รีเทิร์น

Element — สำเนาใหม่

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

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

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

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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

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

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

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

สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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 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();

รีเทิร์น

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

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

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

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

รีเทิร์น

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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