Class HeaderSection

HeaderSection

องค์ประกอบที่แสดงถึงส่วนหัว Document โดยทั่วไปจะมี HeaderSection ไม่เกิน 1 รายการ HeaderSection อาจมีองค์ประกอบ ListItem, Paragraph และ Table ดูข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างเอกสารได้ในคู่มือการขยายการใช้งาน Google เอกสาร

วิธีการ

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
appendHorizontalRule()HorizontalRuleสร้างและต่อท้าย HorizontalRule ใหม่
appendImage(image)InlineImageสร้างและต่อท้าย InlineImage ใหม่จาก Blob ของรูปภาพที่ระบุ
appendImage(image)InlineImageเพิ่ม InlineImage ที่ให้มาด้วย
appendListItem(listItem)ListItemเพิ่ม ListItem ที่ให้มาด้วย
appendListItem(text)ListItemสร้างและเพิ่ม ListItem ใหม่ที่มีเนื้อหาข้อความที่ระบุ
appendParagraph(paragraph)Paragraphเพิ่ม Paragraph ที่ให้มาด้วย
appendParagraph(text)Paragraphสร้างและเพิ่ม Paragraph ใหม่ที่มีเนื้อหาข้อความที่ระบุ
appendTable()Tableสร้างและต่อท้าย Table ใหม่
appendTable(cells)Tableเพิ่ม Table ใหม่ที่มีค่า TableCell ต่อท้ายค่าสตริงที่ระบุแต่ละค่า
appendTable(table)Tableเพิ่ม Table ที่ให้มาด้วย
clear()HeaderSectionล้างเนื้อหาขององค์ประกอบ
copy()HeaderSectionแสดงผลสำเนาแบบเจาะลึกขององค์ประกอบปัจจุบันที่แยกออกมา
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เรียกดัชนีย่อยสำหรับองค์ประกอบย่อยที่ระบุ
getImages()InlineImage[]เรียก InlineImages ทั้งหมดในส่วนนี้
getListItems()ListItem[]เรียก ListItems ทั้งหมดในส่วนนี้
getNumChildren()Integerดึงจำนวนเด็ก
getParagraphs()Paragraph[]เรียก Paragraphs ทั้งหมดในส่วนนี้ (รวม ListItems)
getParent()ContainerElementเรียกองค์ประกอบระดับบนขององค์ประกอบ
getTables()Table[]เรียก Tables ทั้งหมดในส่วนนี้
getText()Stringเรียกเนื้อหาขององค์ประกอบเป็นสตริงข้อความ
getTextAlignment()TextAlignmentรับการจัดข้อความ
getType()ElementTypeดึงข้อมูล ElementType ขององค์ประกอบ
insertHorizontalRule(childIndex)HorizontalRuleสร้างและแทรก HorizontalRule ใหม่ที่ดัชนีที่ระบุ
insertImage(childIndex, image)InlineImageสร้างและแทรก InlineImage จาก Image Blob ที่ระบุไว้ที่ดัชนีที่ระบุ
insertImage(childIndex, image)InlineImageแทรก InlineImage ที่ระบุที่ดัชนีที่ระบุ
insertListItem(childIndex, listItem)ListItemแทรก ListItem ที่ระบุที่ดัชนีที่ระบุ
insertListItem(childIndex, text)ListItemสร้างและแทรก ListItem ใหม่ที่ดัชนีที่ระบุ ซึ่งมีเนื้อหาข้อความที่ระบุ
insertParagraph(childIndex, paragraph)Paragraphแทรก Paragraph ที่ระบุที่ดัชนีที่ระบุ
insertParagraph(childIndex, text)Paragraphสร้างและแทรก Paragraph ใหม่ที่ดัชนีที่ระบุ ซึ่งมีเนื้อหาข้อความที่ระบุ
insertTable(childIndex)Tableสร้างและแทรก Table ใหม่ที่ดัชนีที่ระบุ
insertTable(childIndex, cells)Tableสร้างและแทรก Table ใหม่ที่มีเซลล์ที่ระบุที่ดัชนีที่ระบุ
insertTable(childIndex, table)Tableแทรก Table ที่ระบุที่ดัชนีที่ระบุ
removeChild(child)HeaderSectionนำองค์ประกอบย่อยที่ระบุออก
removeFromParent()HeaderSectionนำองค์ประกอบออกจากระดับบนสุด
replaceText(searchPattern, replacement)Elementแทนที่รายการทั้งหมดของรูปแบบข้อความที่ระบุด้วยสตริงการแทนที่หนึ่งๆ โดยใช้นิพจน์ทั่วไป
setAttributes(attributes)HeaderSectionตั้งค่าแอตทริบิวต์ขององค์ประกอบ
setText(text)HeaderSectionตั้งค่าเนื้อหาเป็นข้อความธรรมดา
setTextAlignment(textAlignment)HeaderSectionตั้งค่าการจัดข้อความ

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

appendHorizontalRule()

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

HorizontalRule จะอยู่ใน Paragraph ใหม่

รีเทิร์น

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

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

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

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

appendImage(image)

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

รูปภาพนั้นจะอยู่ใน Paragraph ใหม่

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

appendImage(image)

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

InlineImage จะอยู่ใน Paragraph ใหม่

ใช้ appendImage เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ InlineImage ที่มีอยู่

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

appendListItem(listItem)

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

ใช้ appendListItem เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ ListItem ที่มีอยู่

พารามิเตอร์

ชื่อTypeคำอธิบาย
listItemListItemรายการที่จะต่อท้าย

รีเทิร์น

ListItem — รายการต่อท้าย

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

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

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

appendListItem(text)

สร้างและเพิ่ม ListItem ใหม่ที่มีเนื้อหาข้อความที่ระบุ

ระบบจะเพิ่มรายการต่อเนื่องกันเป็นส่วนหนึ่งของรายการเดียวกัน

พารามิเตอร์

ชื่อTypeคำอธิบาย
textStringเนื้อหาข้อความของรายการ

รีเทิร์น

ListItem — รายการใหม่

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

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

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

appendParagraph(paragraph)

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

ใช้ appendParagraph เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ Paragraph ที่มีอยู่

พารามิเตอร์

ชื่อTypeคำอธิบาย
paragraphParagraphย่อหน้าที่จะต่อท้าย

รีเทิร์น

Paragraph — ย่อหน้าที่ต่อท้าย

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

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

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

appendParagraph(text)

สร้างและเพิ่ม Paragraph ใหม่ที่มีเนื้อหาข้อความที่ระบุ

พารามิเตอร์

ชื่อTypeคำอธิบาย
textStringเนื้อหาข้อความของย่อหน้า

รีเทิร์น

Paragraph — ย่อหน้าใหม่

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

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

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

appendTable()

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

วิธีนี้จะเพิ่มย่อหน้าว่างต่อท้ายตารางด้วย เนื่องจากเอกสาร Google เอกสารจะลงท้ายด้วยตารางไม่ได้

รีเทิร์น

Table — ตารางใหม่

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

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

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

appendTable(cells)

เพิ่ม Table ใหม่ที่มีค่า TableCell ต่อท้ายค่าสตริงที่ระบุแต่ละค่า

วิธีนี้จะเพิ่มย่อหน้าว่างต่อท้ายตารางด้วย เนื่องจากเอกสาร Google เอกสารจะลงท้ายด้วยตารางไม่ได้

พารามิเตอร์

ชื่อTypeคำอธิบาย
cellsString[][]เนื้อหาข้อความของเซลล์ตารางที่จะเพิ่มลงในตารางใหม่

รีเทิร์น

Table — ตารางที่ต่อท้าย

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

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

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

appendTable(table)

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

ใช้ appendTable เวอร์ชันนี้เมื่อต่อท้ายสำเนาของ Table ที่มีอยู่ วิธีนี้จะเพิ่มย่อหน้าว่างต่อท้ายตารางด้วย เนื่องจากเอกสาร Google เอกสารจะลงท้ายด้วยตารางไม่ได้

พารามิเตอร์

ชื่อTypeคำอธิบาย
tableTableตารางที่จะต่อท้าย

รีเทิร์น

Table — ตารางที่ต่อท้าย

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

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

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

clear()

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

รีเทิร์น

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


copy()

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

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

รีเทิร์น

HeaderSection — สำเนาใหม่

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
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;
  }
}

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

findText(searchPattern)

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

findText(searchPattern, from)

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

getChildIndex(child)

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

พารามิเตอร์

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

รีเทิร์น

Integer — ดัชนีย่อย

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

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

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

getImages()

เรียก InlineImages ทั้งหมดในส่วนนี้

รีเทิร์น

InlineImage[] — รูปภาพของส่วน

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

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

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

getListItems()

เรียก ListItems ทั้งหมดในส่วนนี้

รีเทิร์น

ListItem[] — รายการหัวข้อ

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

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

getParagraphs()

เรียก Paragraphs ทั้งหมดในส่วนนี้ (รวม ListItems)

รีเทิร์น

Paragraph[] — ส่วนย่อหน้า

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

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

getTables()

เรียก Tables ทั้งหมดในส่วนนี้

รีเทิร์น

Table[] — ตารางส่วน

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

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

insertHorizontalRule(childIndex)

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

HorizontalRule จะอยู่ใน Paragraph ใหม่

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

insertImage(childIndex, image)

สร้างและแทรก InlineImage จาก Image Blob ที่ระบุไว้ที่ดัชนีที่ระบุ

พารามิเตอร์

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

รีเทิร์น

InlineImage — รูปภาพที่แทรกในบรรทัด

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

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

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

insertImage(childIndex, image)

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

รูปภาพนั้นจะอยู่ใน Paragraph ใหม่

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรกองค์ประกอบ
imageInlineImageรูปภาพที่จะแทรก

รีเทิร์น

InlineImage — รูปภาพที่แทรกในบรรทัด

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

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

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

insertListItem(childIndex, listItem)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก
listItemListItemรายการที่จะแทรก

รีเทิร์น

ListItem — รายการย่อยที่แทรก

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

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

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

insertListItem(childIndex, text)

สร้างและแทรก ListItem ใหม่ที่ดัชนีที่ระบุ ซึ่งมีเนื้อหาข้อความที่ระบุ

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก
textStringเนื้อหาข้อความของรายการ

รีเทิร์น

ListItem — รายการใหม่

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

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

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

insertParagraph(childIndex, paragraph)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก
paragraphParagraphย่อหน้าที่จะแทรก

รีเทิร์น

Paragraph — ย่อหน้าที่แทรก

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

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

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

insertParagraph(childIndex, text)

สร้างและแทรก Paragraph ใหม่ที่ดัชนีที่ระบุ ซึ่งมีเนื้อหาข้อความที่ระบุ

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก
textStringเนื้อหาข้อความของย่อหน้า

รีเทิร์น

Paragraph — ย่อหน้าใหม่

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

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

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

insertTable(childIndex)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก

รีเทิร์น

Table — ตารางใหม่

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

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

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

insertTable(childIndex, cells)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก
cellsString[][]เนื้อหาข้อความของเซลล์ตารางที่จะเพิ่มลงในตารางใหม่

รีเทิร์น

Table — ตารางใหม่

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

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

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

insertTable(childIndex, table)

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
childIndexIntegerดัชนีที่จะแทรก
tableTableตารางที่จะแทรก

รีเทิร์น

Table — ตารางที่แทรก

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

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

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

removeChild(child)

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

รีเทิร์น

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

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

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

พารามิเตอร์

ชื่อTypeคำอธิบาย
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);

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

setText(text)

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

วิธีการที่เลิกใช้งานแล้ว