องค์ประกอบที่แสดงถึงตาราง Table
มีได้เฉพาะองค์ประกอบ TableRow
เท่านั้น สำหรับ
สำหรับข้อมูลเพิ่มเติมเกี่ยวกับโครงสร้างเอกสาร โปรดดูคำแนะนำในการขยาย Google เอกสาร
เมื่อสร้าง Table
ที่มีแถวหรือเซลล์จำนวนมาก ให้พิจารณาสร้าง
จากอาร์เรย์สตริง ดังที่แสดงในตัวอย่างต่อไปนี้
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Create a two-dimensional array containing the cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. body.appendTable(cells);
เมธอด
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
appendTableRow() | TableRow | สร้างและเพิ่ม TableRow ใหม่ |
appendTableRow(tableRow) | TableRow | เพิ่ม TableRow ที่ระบุ |
clear() | Table | ล้างเนื้อหาขององค์ประกอบ |
copy() | Table | แสดงผลสำเนาที่แยกส่วนลึกขององค์ประกอบปัจจุบัน |
editAsText() | Text | รับองค์ประกอบปัจจุบันเวอร์ชันText เพื่อแก้ไข |
findElement(elementType) | RangeElement | ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ |
findElement(elementType, from) | RangeElement | ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ โดยเริ่มจาก
ระบุ RangeElement แล้ว |
findText(searchPattern) | RangeElement | ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุโดยใช้นิพจน์ทั่วไป |
findText(searchPattern, from) | RangeElement | ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุ โดยเริ่มต้นจาก ผลการค้นหา |
getAttributes() | Object | ดึงแอตทริบิวต์ขององค์ประกอบ |
getBorderColor() | String | ดึงข้อมูลสีเส้นขอบ |
getBorderWidth() | Number | ดึงข้อมูลความกว้างของขอบเป็นจุด |
getCell(rowIndex, cellIndex) | TableCell | เรียกข้อมูล TableCell ที่ดัชนีแถวและเซลล์ที่ระบุ |
getChild(childIndex) | Element | เรียกข้อมูลองค์ประกอบย่อยที่ดัชนีย่อยที่ระบุ |
getChildIndex(child) | Integer | เรียกดัชนีย่อยสำหรับองค์ประกอบย่อยที่ระบุ |
getColumnWidth(columnIndex) | Number | ดึงข้อมูลความกว้างของคอลัมน์ในตารางที่ระบุเป็นจุด |
getLinkUrl() | String | ดึงข้อมูล URL ของลิงก์ |
getNextSibling() | Element | เรียกข้อมูลองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ |
getNumChildren() | Integer | ดึงจำนวนเด็ก |
getNumRows() | Integer | เรียกดูจำนวน TableRows |
getParent() | ContainerElement | เรียกข้อมูลองค์ประกอบหลักขององค์ประกอบ |
getPreviousSibling() | Element | ดึงองค์ประกอบระดับเดียวกันก่อนหน้านี้ขององค์ประกอบ |
getRow(rowIndex) | TableRow | เรียกข้อมูล TableRow ที่ดัชนีแถวที่ระบุ |
getText() | String | เรียกคืนเนื้อหาขององค์ประกอบเป็นสตริงข้อความ |
getTextAlignment() | TextAlignment | ปรับการจัดข้อความ |
getType() | ElementType | เรียกข้อมูล ElementType ขององค์ประกอบ |
insertTableRow(childIndex) | TableRow | สร้างและแทรก TableRow ใหม่ที่ดัชนีที่ระบุ |
insertTableRow(childIndex, tableRow) | TableRow | แทรก TableRow ที่ระบุที่ดัชนีที่ระบุ |
isAtDocumentEnd() | Boolean | กำหนดว่าองค์ประกอบอยู่ที่ส่วนท้ายของ Document หรือไม่ |
removeChild(child) | Table | นำองค์ประกอบย่อยที่ระบุออก |
removeFromParent() | Table | นำองค์ประกอบออกจากระดับบนสุด |
removeRow(rowIndex) | TableRow | นำ TableRow ออกจากดัชนีแถวที่ระบุ |
replaceText(searchPattern, replacement) | Element | แทนที่ทุกรายการของรูปแบบข้อความที่ระบุด้วยสตริงการแทนที่ที่กำหนด โดยใช้ข้อความปกติ นิพจน์ |
setAttributes(attributes) | Table | ตั้งค่าแอตทริบิวต์ขององค์ประกอบ |
setBorderColor(color) | Table | ตั้งค่าสีเส้นขอบ |
setBorderWidth(width) | Table | กำหนดความกว้างของขอบเป็นจุด |
setColumnWidth(columnIndex, width) | Table | กำหนดความกว้างของคอลัมน์ที่ระบุเป็นจุด |
setLinkUrl(url) | Table | ตั้งค่า URL ของลิงก์ |
setTextAlignment(textAlignment) | Table | ตั้งค่าการจัดข้อความ |
เอกสารโดยละเอียด
appendTableRow()
appendTableRow(tableRow)
เพิ่ม TableRow
ที่ระบุ
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table in the tab and copies the second row. const table = body.getTables()[0]; const row = table.getChild(1).copy(); // Adds the copied row to the bottom of the table. const tableRow = table.appendTableRow(row);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
tableRow | TableRow | แถวของตารางที่จะต่อท้าย |
รีเทิร์น
TableRow
— องค์ประกอบแถวของตารางที่ต่อท้าย
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
แสดงผลสำเนาที่แยกส่วนลึกขององค์ประกอบปัจจุบัน
ระบบจะคัดลอกองค์ประกอบย่อยที่อยู่ในองค์ประกอบดังกล่าวด้วย องค์ประกอบใหม่ไม่มีองค์ประกอบ หลัก
รีเทิร์น
Table
— สำเนาใหม่
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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().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)
ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
elementType | ElementType | ประเภทขององค์ประกอบที่จะค้นหา |
รีเทิร์น
RangeElement
— ผลการค้นหาที่ระบุตำแหน่งขององค์ประกอบการค้นหา
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
ค้นหาเนื้อหาขององค์ประกอบเพื่อหาองค์ประกอบสืบทอดของประเภทที่ระบุ โดยเริ่มจาก
ระบุ RangeElement
แล้ว
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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; } }
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
elementType | ElementType | ประเภทขององค์ประกอบที่จะค้นหา |
from | RangeElement | ผลการค้นหาที่จะค้นหา |
รีเทิร์น
RangeElement
— ผลการค้นหาที่ระบุตำแหน่งถัดไปขององค์ประกอบการค้นหา
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุโดยใช้นิพจน์ทั่วไป
ระบบยังไม่รองรับฟีเจอร์นิพจน์ทั่วไปของ JavaScript บางส่วนอย่างสมบูรณ์ เช่น แคปเจอร์กรุ๊ปและตัวปรับแต่งโหมด
รูปแบบนิพจน์ทั่วไปที่ระบุจะถูกจับคู่กับบล็อกข้อความแต่ละบล็อกแยกกัน ที่มีอยู่ในองค์ประกอบปัจจุบัน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
searchPattern | String | รูปแบบที่จะค้นหา |
รีเทิร์น
RangeElement
— ผลการค้นหาที่ระบุตำแหน่งของข้อความค้นหา หรือไม่มีข้อมูล หากไม่มี
การจับคู่ที่ตรงกัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
ค้นหาเนื้อหาขององค์ประกอบสำหรับรูปแบบข้อความที่ระบุ โดยเริ่มต้นจาก ผลการค้นหา
ระบบยังไม่รองรับฟีเจอร์นิพจน์ทั่วไปของ JavaScript บางส่วนอย่างสมบูรณ์ เช่น แคปเจอร์กรุ๊ปและตัวปรับแต่งโหมด
รูปแบบนิพจน์ทั่วไปที่ระบุจะถูกจับคู่กับบล็อกข้อความแต่ละบล็อกแยกกัน ที่มีอยู่ในองค์ประกอบปัจจุบัน
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
searchPattern | String | รูปแบบที่จะค้นหา |
from | RangeElement | ผลการค้นหาที่จะค้นหาจาก |
รีเทิร์น
RangeElement
— ผลการค้นหาที่ระบุตำแหน่งถัดไปของข้อความค้นหา หรือไม่มีข้อมูลหากไม่มี
การจับคู่ที่ตรงกัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
ดึงแอตทริบิวต์ขององค์ประกอบ
ผลลัพธ์คือออบเจ็กต์ที่มีพร็อพเพอร์ตี้สำหรับแอตทริบิวต์ขององค์ประกอบที่ถูกต้องแต่ละรายการ โดยที่แต่ละรายการ
ชื่อพร็อพเพอร์ตี้สอดคล้องกับรายการในการแจกแจง DocumentApp.Attribute
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
รีเทิร์น
Object
— แอตทริบิวต์ขององค์ประกอบ
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBorderColor()
ดึงข้อมูลสีเส้นขอบ
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border color of the first table. table.setBorderColor('#00FF00'); // Logs the border color of the first table to the console. console.log(table.getBorderColor());
รีเทิร์น
String
— สีเส้นขอบตามรูปแบบ CSS (เช่น '#ffffff'
)
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBorderWidth()
ดึงข้อมูลความกว้างของขอบเป็นจุด
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border width of the first table. table.setBorderWidth(20); // Logs the border width of the first table. console.log(table.getBorderWidth());
รีเทิร์น
Number
— ความกว้างของเส้นขอบ หน่วยเป็นจุด
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getCell(rowIndex, cellIndex)
เรียกข้อมูล TableCell
ที่ดัชนีแถวและเซลล์ที่ระบุ
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Gets the cell of the table's third row and second column. const cell = table.getCell(2, 1); // Logs the cell text to the console. console.log(cell.getText());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
rowIndex | Integer | ดัชนีของแถวที่มีเซลล์ที่จะดึงข้อมูล |
cellIndex | Integer | ดัชนีของเซลล์ที่จะดึงข้อมูล |
รีเทิร์น
TableCell
— เซลล์ในตาราง
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
เรียกข้อมูลองค์ประกอบย่อยที่ดัชนีย่อยที่ระบุ
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. 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."); }
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
childIndex | Integer | ดัชนีขององค์ประกอบย่อยที่จะดึงข้อมูล |
รีเทิร์น
Element
— องค์ประกอบย่อยในดัชนีที่ระบุ
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
เรียกดัชนีย่อยสำหรับองค์ประกอบย่อยที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
child | Element | องค์ประกอบย่อยที่จะดึงข้อมูลดัชนี |
รีเทิร์น
Integer
— ดัชนีย่อย
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getColumnWidth(columnIndex)
ดึงข้อมูลความกว้างของคอลัมน์ในตารางที่ระบุเป็นจุด
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the width of the second column to 100 points. const columnWidth = table.setColumnWidth(1, 100); // Gets the width of the second column and logs it to the console. console.log(columnWidth.getColumnWidth(1));
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnIndex | Integer | ดัชนีคอลัมน์ |
รีเทิร์น
Number
— ความกว้างของคอลัมน์ หน่วยเป็นจุด
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
ดึงข้อมูล URL ของลิงก์
รีเทิร์น
String
— URL ของลิงก์ หรือค่าว่างหากองค์ประกอบมีค่าหลายค่าสำหรับแอตทริบิวต์นี้
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
เรียกข้อมูลองค์ประกอบข้างเคียงถัดไปขององค์ประกอบ
ข้างเคียงมีระดับบนเดียวกันและตามหลังองค์ประกอบปัจจุบัน
รีเทิร์น
Element
— องค์ประกอบข้างเคียงถัดไป
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
ดึงจำนวนเด็ก
var 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
getNumRows()
เรียกดูจำนวน TableRows
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Logs the number of rows of the first table to the console. console.log(table.getNumRows());
รีเทิร์น
Integer
— จำนวนแถวในตาราง
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
เรียกข้อมูลองค์ประกอบหลักขององค์ประกอบ
องค์ประกอบหลักมีองค์ประกอบปัจจุบัน
รีเทิร์น
ContainerElement
— องค์ประกอบระดับบนสุด
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
ดึงองค์ประกอบระดับเดียวกันก่อนหน้านี้ขององค์ประกอบ
รายการข้างเคียงก่อนหน้านี้มีระดับบนสุดเดียวกันและอยู่ก่อนองค์ประกอบปัจจุบัน
รีเทิร์น
Element
— องค์ประกอบข้างเคียงก่อนหน้า
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getRow(rowIndex)
เรียกข้อมูล TableRow
ที่ดัชนีแถวที่ระบุ
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table and logs the text of first row to the console. const table = body.getTables()[0]; console.log(table.getRow(0).getText());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
rowIndex | Integer | ดัชนีของแถวที่จะดึงข้อมูล |
รีเทิร์น
TableRow
— แถวในตาราง
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 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 doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
รีเทิร์น
ElementType
— ประเภทองค์ประกอบ
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableRow(childIndex)
สร้างและแทรก TableRow
ใหม่ที่ดัชนีที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
childIndex | Integer | ดัชนีที่จะแทรกองค์ประกอบ |
รีเทิร์น
TableRow
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTableRow(childIndex, tableRow)
แทรก TableRow
ที่ระบุที่ดัชนีที่ระบุ
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
childIndex | Integer | ดัชนีที่จะแทรกองค์ประกอบ |
tableRow | TableRow | แถวในตารางที่จะแทรก |
รีเทิร์น
TableRow
— องค์ประกอบแถวของตารางที่แทรก
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
removeChild(child)
นำองค์ประกอบย่อยที่ระบุออก
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Finds the first table row and removes it. const element = table.findElement(DocumentApp.ElementType.TABLE_ROW); table.removeChild(element.getElement());
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
child | Element | องค์ประกอบย่อยที่จะนำออก |
รีเทิร์น
Table
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
นำองค์ประกอบออกจากระดับบนสุด
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
รีเทิร์น
Table
— องค์ประกอบที่นำออก
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeRow(rowIndex)
นำ TableRow
ออกจากดัชนีแถวที่ระบุ
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table and removes its second row. const table = body.getTables()[0]; table.removeRow(1);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
rowIndex | Integer | ดัชนีของแถวที่จะนำออก |
รีเทิร์น
TableRow
— แถวที่นำออก
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
แทนที่ทุกรายการของรูปแบบข้อความที่ระบุด้วยสตริงการแทนที่ที่กำหนด โดยใช้ข้อความปกติ นิพจน์
ระบบจะส่งรูปแบบการค้นหาเป็นสตริง ไม่ใช่ออบเจ็กต์นิพจน์ทั่วไปของ JavaScript ด้วยเหตุนี้ คุณจึงต้องไม่ใช้เครื่องหมายแบ็กสแลชในรูปแบบนี้
วิธีนี้ใช้เมตริก RE2 ของ Google ตามปกติ ไลบรารีนิพจน์ซึ่งจำกัดไวยากรณ์ที่รองรับ
รูปแบบนิพจน์ทั่วไปที่ระบุจะถูกจับคู่กับบล็อกข้อความแต่ละบล็อกแยกกัน ที่มีอยู่ในองค์ประกอบปัจจุบัน
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
searchPattern | String | รูปแบบนิพจน์ทั่วไปที่จะค้นหา |
replacement | String | ข้อความที่จะใช้แทนที่ |
รีเทิร์น
Element
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
ตั้งค่าแอตทริบิวต์ขององค์ประกอบ
พารามิเตอร์แอตทริบิวต์ที่ระบุต้องเป็นออบเจ็กต์ที่ชื่อพร็อพเพอร์ตี้แต่ละชื่อเป็นรายการใน
การแจงนับ DocumentApp.Attribute
และค่าพร็อพเพอร์ตี้แต่ละค่าคือค่าใหม่
ใช้แล้ว
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
attributes | Object | แอตทริบิวต์ขององค์ประกอบ |
รีเทิร์น
Table
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBorderColor(color)
ตั้งค่าสีเส้นขอบ
// 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(DOCUMENT_ID); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab(TAB_ID).asDocumentTab().getBody(); // Gets the first table. const table = body.getTables()[0]; // Sets the border color of the table to green. table.setBorderColor('#00FF00');
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
color | String | สีเส้นขอบซึ่งจัดรูปแบบตามรูปแบบ CSS (เช่น '#ffffff' ) |
รีเทิร์น
Table
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setBorderWidth(width)
กำหนดความกว้างของขอบเป็นจุด
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
width | Number | ความกว้างของขอบเป็นจุด |
รีเทิร์น
Table
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setColumnWidth(columnIndex, width)
กำหนดความกว้างของคอลัมน์ที่ระบุเป็นจุด
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
columnIndex | Integer | ดัชนีคอลัมน์ |
width | Number | ความกว้างของขอบเป็นจุด |
รีเทิร์น
Table
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setTextAlignment(textAlignment)
ตั้งค่าการจัดข้อความ ประเภทการตรวจสอบความสอดคล้องที่ใช้ได้ ได้แก่ DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
และ DocumentApp.TextAlignment.SUPERSCRIPT
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
พารามิเตอร์
ชื่อ | ประเภท | คำอธิบาย |
---|---|---|
textAlignment | TextAlignment | ประเภทการจัดข้อความที่จะใช้ |
รีเทิร์น
Table
— องค์ประกอบปัจจุบัน
การให้สิทธิ์
สคริปต์ที่ใช้เมธอดนี้ต้องมีการให้สิทธิ์กับขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents