Class Paragraph

ย่อหน้า

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

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

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

// Append a tab header paragraph.
const header = body.appendParagraph('A Document');
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
const section = body.appendParagraph('Section 1');
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph('This is a typical paragraph.');

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
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()Paragraphล้างเนื้อหาขององค์ประกอบ
copy()Paragraphแสดงผลสำเนาแบบลึกที่แยกออกมาขององค์ประกอบปัจจุบัน
editAsText()Textรับองค์ประกอบปัจจุบันเวอร์ชัน Text เพื่อแก้ไข
findElement(elementType)RangeElement|nullค้นหาเนื้อหาขององค์ประกอบสำหรับองค์ประกอบย่อยของประเภทที่ระบุ
findElement(elementType, from)RangeElement|nullค้นหาเนื้อหาขององค์ประกอบสำหรับองค์ประกอบย่อยของประเภทที่ระบุ โดยเริ่มจาก RangeElement ที่ระบุ
findText(searchPattern)RangeElement|nullค้นหารูปแบบข้อความที่ระบุในเนื้อหาขององค์ประกอบโดยใช้นิพจน์ทั่วไป
findText(searchPattern, from)RangeElement|nullค้นหารูปแบบข้อความที่ระบุในเนื้อหาขององค์ประกอบ โดยเริ่มจากผลการค้นหาที่ระบุ
getAlignment()HorizontalAlignment|nullดึงข้อมูล HorizontalAlignment
getAttributes()Objectดึงแอตทริบิวต์ขององค์ประกอบ
getChild(childIndex)Elementดึงข้อมูลองค์ประกอบย่อยที่ดัชนีขององค์ประกอบย่อยที่ระบุ
getChildIndex(child)Integerดึงข้อมูลดัชนีขององค์ประกอบย่อยสำหรับองค์ประกอบย่อยที่ระบุ
getHeading()ParagraphHeading|nullดึงข้อมูล ParagraphHeading
getIndentEnd()Number|nullดึงการเยื้องท้ายในหน่วยคะแนน
getIndentFirstLine()Number|nullดึงการเยื้องบรรทัดแรกเป็นคะแนน
getIndentStart()Number|nullเรียกการเยื้องเริ่มต้น
getLineSpacing()Number|nullดึงข้อมูลระยะห่างระหว่างบรรทัดเป็นจุด
getLinkUrl()String|nullเรียก URL ของลิงก์
getNextSibling()Element|nullดึงองค์ประกอบพี่น้องถัดไปขององค์ประกอบ
getNumChildren()Integerดึงข้อมูลจำนวนเด็ก
getParent()ContainerElement|nullดึงองค์ประกอบหลักขององค์ประกอบ
getPositionedImage(id)PositionedImageรับ PositionedImage ตามรหัสของรูปภาพ
getPositionedImages()PositionedImage[]รับออบเจ็กต์ PositionedImage ทั้งหมดที่ยึดกับย่อหน้า
getPreviousSibling()Element|nullดึงองค์ประกอบพี่น้องก่อนหน้าขององค์ประกอบ
getSpacingAfter()Number|nullดึงข้อมูลระยะห่างหลังองค์ประกอบเป็นจุด
getSpacingBefore()Number|nullเรียกข้อมูลระยะห่างก่อนองค์ประกอบเป็นพอยต์
getText()Stringดึงเนื้อหาขององค์ประกอบเป็นสตริงข้อความ
getTextAlignment()TextAlignment|nullรับการจัดข้อความ
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|nullดึงการตั้งค่าจากซ้ายไปขวา
merge()Paragraph|nullผสานองค์ประกอบกับองค์ประกอบที่อยู่ก่อนหน้าซึ่งเป็นประเภทเดียวกัน
removeChild(child)Paragraphนำองค์ประกอบย่อยที่ระบุออก
removeFromParent()Paragraph|nullนำองค์ประกอบออกจากองค์ประกอบหลัก
removePositionedImage(id)Booleanนำ PositionedImage ออกตามรหัสของรูปภาพ
replaceText(searchPattern, replacement)Elementแทนที่รูปแบบข้อความที่กำหนดทั้งหมดด้วยสตริงทดแทนที่กำหนดโดยใช้นิพจน์ทั่วไป
setAlignment(alignment)Paragraphตั้งค่า HorizontalAlignment
setAttributes(attributes)Paragraphตั้งค่าแอตทริบิวต์ขององค์ประกอบ
setHeading(heading)Paragraphตั้งค่า ParagraphHeading
setIndentEnd(indentEnd)Paragraphตั้งค่าการเยื้องท้ายเป็นจุด
setIndentFirstLine(indentFirstLine)Paragraphตั้งค่าการเยื้องบรรทัดแรกเป็นจุด
setIndentStart(indentStart)Paragraphตั้งค่าการเยื้องเริ่มต้นเป็นจุด
setLeftToRight(leftToRight)Paragraphตั้งค่าจากซ้ายไปขวา
setLineSpacing(multiplier)Paragraphกำหนดระยะห่างบรรทัดเป็นจำนวนที่ระบุจำนวนบรรทัดที่จะใช้สำหรับเว้นวรรค
setLinkUrl(url)Paragraphตั้งค่า URL ของลิงก์
setSpacingAfter(spacingAfter)Paragraphตั้งค่าระยะห่างหลังองค์ประกอบเป็นพอยต์
setSpacingBefore(spacingBefore)Paragraphกำหนดระยะห่างก่อนองค์ประกอบเป็นพอยต์
setText(text)voidตั้งค่าเนื้อหาของย่อหน้าเป็นข้อความ
setTextAlignment(textAlignment)Paragraphตั้งค่าการจัดข้อความ

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

addPositionedImage(image)

สร้างและแทรก PositionedImage ใหม่จาก Blob รูปภาพที่ระบุ 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the specified image URL.
const image = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png',
);

// Adds the image to the tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

พารามิเตอร์

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

รีเทิร์น

PositionedImage — รูปภาพใหม่ที่จัดตำแหน่งแล้ว

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

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

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

appendHorizontalRule()

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a horizontal line under the first paragraph.
paragraph.appendHorizontalRule();

รีเทิร์น

HorizontalRule — เส้นคั่นแนวนอนใหม่

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

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

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

appendInlineImage(image)

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Fetches the image from the specified image URL.
const image = UrlFetchApp.fetch(
    'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png',
);

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

appendInlineImage(image)

เพิ่ม InlineImage ที่ระบุต่อท้าย 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Makes a copy of the first image in the body.
const image = body.getImages()[0].copy();

// Adds the image to the first paragraph.
paragraph.appendInlineImage(image);

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

appendPageBreak()

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

หมายเหตุ: PageBreaks อาจไม่อยู่ภายใน TableCells หากองค์ประกอบปัจจุบันอยู่ในเซลล์ตาราง ระบบจะแสดงข้อยกเว้น 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
paragraph.appendPageBreak();

รีเทิร์น

PageBreak - องค์ประกอบตัวแบ่งหน้าใหม่

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

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

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

appendPageBreak(pageBreak)

เพิ่ม PageBreak ที่ระบุต่อท้าย

หมายเหตุ: PageBreaks ต้องไม่อยู่ภายใน TableCells หากองค์ประกอบปัจจุบันอยู่ในเซลล์ตาราง สคริปต์จะส่งข้อยกเว้น 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a page break after the first paragraph.
const pageBreak = paragraph.appendPageBreak();

// Makes a copy of the page break.
const newPageBreak = pageBreak.copy();

// Adds the copied page break to the paragraph.
paragraph.appendPageBreak(newPageBreak);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
pageBreakPageBreakตัวแบ่งหน้าที่จะต่อท้าย

รีเทิร์น

PageBreak — องค์ประกอบตัวแบ่งหน้าที่ต่อท้าย

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

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

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

appendText(text)

สร้างและต่อท้ายองค์ประกอบ Text ใหม่ที่มีเนื้อหาที่ระบุ 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Adds a string to the paragraph.
paragraph.appendText('This is a new sentence.');

พารามิเตอร์

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

รีเทิร์น

Text — องค์ประกอบข้อความใหม่

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

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

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

appendText(text)

ต่อท้ายองค์ประกอบ Text ที่ระบุ 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the text from the first paragraph in the body.
const paragraph1 = body.getParagraphs()[0];
const text = paragraph1.getText();

// Gets the third paragraph in the body.
const paragraph3 = body.getParagraphs()[2];

// Adds the text from the first paragraph to the third paragraph.
paragraph3.appendText(text);

พารามิเตอร์

ชื่อประเภทคำอธิบาย
textTextองค์ประกอบของข้อความที่จะต่อท้าย

รีเทิร์น

Text — องค์ประกอบข้อความที่ต่อท้าย

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

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

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

clear()

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

รีเทิร์น

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

copy()

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

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

รีเทิร์น

Paragraph — สำเนาใหม่

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

findText(searchPattern)

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

findText(searchPattern, from)

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

getAlignment()

ดึงข้อมูล HorizontalAlignment 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Gets the first paragraph from the body.
const paragraph = body.getParagraphs()[0];

// Sets the horizontal alignment to left for the first paragraph.
paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT);

// Gets the horizontal alignment of the first paragraph and logs it to the
// console.
console.log(paragraph.getAlignment().toString());

รีเทิร์น

HorizontalAlignment|null — การจัดแนว

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

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

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

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

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

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

พารามิเตอร์

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

getHeading()

ดึงข้อมูล ParagraphHeading 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().getBody();

// Adds a paragraph to the body.
const paragraph = body.appendParagraph('Title heading');

// Sets the paragraph heading style to 'Title.'
paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE);

// Gets the heading style and logs it to the console.
console.log(paragraph.getHeading().toString());

รีเทิร์น

ParagraphHeading|null — หัวเรื่อง

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

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

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

getIndentEnd()

ดึงการเยื้องท้ายในหน่วยคะแนน

รีเทิร์น

Number|null - การเยื้องท้ายเป็นจุด

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

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

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

getIndentFirstLine()

ดึงการเยื้องบรรทัดแรกเป็นคะแนน

รีเทิร์น

Number|null - การเยื้องบรรทัดแรกเป็นจุด

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

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

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

getIndentStart()

เรียกการเยื้องเริ่มต้น

รีเทิร์น

Number|null — การเยื้องเริ่มต้น

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

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

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

getLineSpacing()

ดึงข้อมูลระยะห่างระหว่างบรรทัดเป็นจุด

รีเทิร์น

Number|null — ระยะห่างระหว่างบรรทัดเป็นพอยต์

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

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

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

getLinkUrl()

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

รีเทิร์น

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

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

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

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

getNextSibling()

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

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

รีเทิร์น

Element|null — องค์ประกอบร่วมถัดไป

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

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

  • 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 — จำนวนเด็ก

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

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

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

getParent()

ดึงองค์ประกอบหลักขององค์ประกอบ

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

รีเทิร์น

ContainerElement|null — องค์ประกอบระดับบนสุด

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

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

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

getPositionedImage(id)

รับ PositionedImage ตามรหัสของรูปภาพ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสรูปภาพ

รีเทิร์น

PositionedImage — รูปภาพที่วางตำแหน่ง

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

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

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

getPositionedImages()

รับออบเจ็กต์ PositionedImage ทั้งหมดที่ยึดกับย่อหน้า

รีเทิร์น

PositionedImage[] - รายการรูปภาพที่จัดตำแหน่ง

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

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

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

getPreviousSibling()

ดึงองค์ประกอบพี่น้องก่อนหน้าขององค์ประกอบ

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

รีเทิร์น

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

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

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

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

getSpacingAfter()

ดึงข้อมูลระยะห่างหลังองค์ประกอบเป็นจุด

รีเทิร์น

Number|null — ระยะห่างหลังองค์ประกอบเป็นพอยท์

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

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

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

getSpacingBefore()

เรียกข้อมูลระยะห่างก่อนองค์ประกอบเป็นพอยต์

รีเทิร์น

Number|null — ระยะห่างก่อนองค์ประกอบเป็นพอยต์

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

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

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

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

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

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

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

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

insertHorizontalRule(childIndex)

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

พารามิเตอร์

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

รีเทิร์น

HorizontalRule — องค์ประกอบเส้นแนวนอนใหม่

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

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

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

insertInlineImage(childIndex, image)

สร้างและแทรก InlineImage ใหม่จาก Blob รูปภาพที่ระบุที่ดัชนีที่ระบุ

พารามิเตอร์

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

รีเทิร์น

InlineImage — องค์ประกอบรูปภาพในบรรทัดที่แทรก

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

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

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

insertInlineImage(childIndex, image)

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

พารามิเตอร์

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

รีเทิร์น

InlineImage — องค์ประกอบรูปภาพในบรรทัดที่แทรก

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

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

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

insertPageBreak(childIndex)

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

หมายเหตุ: PageBreaks อาจไม่อยู่ภายใน TableCells หากองค์ประกอบปัจจุบันอยู่ในเซลล์ตาราง ระบบจะแสดงข้อยกเว้น

พารามิเตอร์

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

รีเทิร์น

PageBreak - องค์ประกอบตัวแบ่งหน้าใหม่

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

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

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

insertPageBreak(childIndex, pageBreak)

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

หมายเหตุ: PageBreaks อาจไม่อยู่ภายใน TableCells หากองค์ประกอบปัจจุบันอยู่ในเซลล์ตาราง ระบบจะแสดงข้อยกเว้น

พารามิเตอร์

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

รีเทิร์น

PageBreak — องค์ประกอบตัวแบ่งหน้าที่แทรก

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

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

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

insertText(childIndex, text)

สร้างและแทรกองค์ประกอบข้อความใหม่ที่ดัชนีที่ระบุ

พารามิเตอร์

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

รีเทิร์น

Text - องค์ประกอบข้อความใหม่

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

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

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

insertText(childIndex, text)

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

พารามิเตอร์

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

รีเทิร์น

Text - องค์ประกอบข้อความที่แทรก

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

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

isLeftToRight()

ดึงการตั้งค่าจากซ้ายไปขวา

รีเทิร์น

Boolean|null — การตั้งค่าจากซ้ายไปขวา

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

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

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

รีเทิร์น

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

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

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

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

removeChild(child)

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

รีเทิร์น

Paragraph|null — องค์ประกอบที่นำออก

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

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

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

removePositionedImage(id)

นำ PositionedImage ออกตามรหัสของรูปภาพ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
idStringรหัสรูปภาพ

รีเทิร์น

Boolean — ไม่ว่าจะมีการนำรูปภาพที่ระบุออกหรือไม่ก็ตาม

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

setAlignment(alignment)

ตั้งค่า HorizontalAlignment

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

setHeading(heading)

ตั้งค่า ParagraphHeading

พารามิเตอร์

ชื่อประเภทคำอธิบาย
headingParagraphHeadingส่วนหัว

รีเทิร์น

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

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

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

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

setIndentEnd(indentEnd)

ตั้งค่าการเยื้องท้ายเป็นจุด

พารามิเตอร์

ชื่อประเภทคำอธิบาย
indentEndNumberการเยื้องท้ายเป็นจุด

รีเทิร์น

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

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

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

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

setIndentFirstLine(indentFirstLine)

ตั้งค่าการเยื้องบรรทัดแรกเป็นจุด

พารามิเตอร์

ชื่อประเภทคำอธิบาย
indentFirstLineNumberการเยื้องบรรทัดแรกเป็นจุด

รีเทิร์น

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

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

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

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

setIndentStart(indentStart)

ตั้งค่าการเยื้องเริ่มต้นเป็นจุด

พารามิเตอร์

ชื่อประเภทคำอธิบาย
indentStartNumberการเยื้องเริ่มต้นเป็นจุด

รีเทิร์น

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

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

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

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

setLeftToRight(leftToRight)

ตั้งค่าจากซ้ายไปขวา

พารามิเตอร์

ชื่อประเภทคำอธิบาย
leftToRightBooleanการตั้งค่าจากซ้ายไปขวา

รีเทิร์น

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

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

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

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

setLineSpacing(multiplier)

กำหนดระยะห่างบรรทัดเป็นจำนวนที่ระบุจำนวนบรรทัดที่จะใช้สำหรับเว้นวรรค

พารามิเตอร์

ชื่อประเภทคำอธิบาย
multiplierNumberจำนวนบรรทัด

รีเทิร์น

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

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

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

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

setLinkUrl(url)

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

พารามิเตอร์

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

รีเทิร์น

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

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

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

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

setSpacingAfter(spacingAfter)

ตั้งค่าระยะห่างหลังองค์ประกอบเป็นพอยต์

พารามิเตอร์

ชื่อประเภทคำอธิบาย
spacingAfterNumberระยะห่างหลังองค์ประกอบเป็นพอยต์

รีเทิร์น

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

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

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

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

setSpacingBefore(spacingBefore)

กำหนดระยะห่างก่อนองค์ประกอบเป็นพอยต์

พารามิเตอร์

ชื่อประเภทคำอธิบาย
spacingBeforeNumberระยะห่างก่อนองค์ประกอบเป็นจุด

รีเทิร์น

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

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

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

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

setText(text)

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

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

พารามิเตอร์

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

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

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 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 in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

พารามิเตอร์

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

รีเทิร์น

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

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

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

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