Class 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 จาก 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 ใหม่

พารามิเตอร์

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

ไปกลับ

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

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

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

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

appendImage(image)

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

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

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

appendListItem(listItem)

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

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

appendListItem(text)

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

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

appendParagraph(paragraph)

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

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

appendParagraph(text)

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

พารามิเตอร์

ชื่อประเภทคำอธิบาย
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 เอกสารต้องไม่ลงท้ายด้วยตาราง

พารามิเตอร์

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

ไปกลับ

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

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

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

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

appendTable(table)

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

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

พารามิเตอร์

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

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

พารามิเตอร์

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

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 ใหม่

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertImage(childIndex, image)

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertImage(childIndex, image)

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

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertListItem(childIndex, listItem)

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertListItem(childIndex, text)

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertParagraph(childIndex, paragraph)

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertParagraph(childIndex, text)

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

insertTable(childIndex)

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

พารามิเตอร์

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

ไปกลับ

Table — ตารางใหม่

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

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

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

insertTable(childIndex, cells)

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

พารามิเตอร์

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

ไปกลับ

Table — ตารางใหม่

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

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

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

insertTable(childIndex, table)

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

พารามิเตอร์

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

ไปกลับ

Table — ตารางที่แทรกไว้

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

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

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

removeChild(child)

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

พารามิเตอร์

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

setText(text)

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

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

พารามิเตอร์

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

พารามิเตอร์

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

ไปกลับ

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

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

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

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

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