Một phần tử đại diện cho một mục trong danh sách. List là Paragraph được liên kết với mã danh sách. List có thể chứa các phần tử Equation, Footnote, Horizontal, Inline, Inline, Page và Text. Để biết thêm thông tin về cấu trúc tài liệu, hãy xem hướng dẫn về cách mở rộng Google Tài liệu.
List không được chứa ký tự dòng mới. Ký tự dòng mới ("\n") được chuyển đổi thành ký tự ngắt dòng ("\r").
List có cùng mã danh sách thuộc cùng một danh sách và được đánh số tương ứng.
List cho một danh sách nhất định không bắt buộc phải nằm cạnh nhau trong thẻ hoặc thậm chí có cùng phần tử mẹ. Hai mục thuộc cùng một danh sách có thể xuất hiện ở bất kỳ vị trí nào trong thẻ trong khi vẫn duy trì cách đánh số liên tiếp, như minh hoạ trong ví dụ sau:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
add | Positioned | Tạo và chèn một Positioned mới từ blob hình ảnh đã chỉ định. |
append | Horizontal | Tạo và thêm một Horizontal mới. |
append | Inline | Tạo và thêm một Inline mới từ blob hình ảnh đã chỉ định. |
append | Inline | Nối Inline đã cho. |
append | Page | Tạo và thêm một Page mới. |
append | Page | Nối Page đã cho. |
append | Text | Tạo và thêm một phần tử Text mới có nội dung được chỉ định. |
append | Text | Nối phần tử Text đã cho. |
clear() | List | Xoá nội dung của phần tử. |
copy() | List | Trả về một bản sao tách biệt, sao chép sâu của phần tử hiện tại. |
edit | Text | Lấy phiên bản Text của phần tử hiện tại để chỉnh sửa. |
find | Range | Tìm kiếm nội dung của phần tử cho một phần tử con thuộc loại được chỉ định. |
find | Range | Tìm kiếm nội dung của phần tử cho một phần tử con thuộc loại được chỉ định, bắt đầu từ Range được chỉ định. |
find | Range | Tìm kiếm nội dung của phần tử theo mẫu văn bản đã chỉ định bằng cách sử dụng biểu thức chính quy. |
find | Range | Tìm kiếm nội dung của phần tử theo mẫu văn bản đã chỉ định, bắt đầu từ một kết quả tìm kiếm nhất định. |
get | Horizontal | Truy xuất Horizontal. |
get | Object | Truy xuất các thuộc tính của phần tử. |
get | Element | Truy xuất phần tử con tại chỉ mục con được chỉ định. |
get | Integer | Truy xuất chỉ mục con cho phần tử con được chỉ định. |
get | Glyph | Truy xuất Glyph của mục trong danh sách. |
get | Paragraph | Truy xuất Paragraph. |
get | Number|null | Truy xuất phần thụt lề cuối, tính bằng điểm. |
get | Number|null | Truy xuất mức thụt lề dòng đầu tiên (tính bằng điểm). |
get | Number|null | Truy xuất phần thụt đầu dòng bắt đầu. |
get | Number|null | Truy xuất khoảng cách dòng, tính bằng điểm. |
get | String|null | Truy xuất URL của đường liên kết. |
get | String|null | Truy xuất mã nhận dạng danh sách. |
get | Integer | Truy xuất cấp độ lồng của mục trong danh sách. |
get | Element|null | Truy xuất phần tử anh chị em tiếp theo của phần tử. |
get | Integer | Truy xuất số lượng thành phần con. |
get | Container | Truy xuất phần tử mẹ của phần tử. |
get | Positioned | Lấy một Positioned theo mã nhận dạng của hình ảnh. |
get | Positioned | Lấy tất cả các đối tượng Positioned được neo vào đoạn văn. |
get | Element|null | Truy xuất phần tử anh chị em trước đó của phần tử. |
get | Number|null | Truy xuất khoảng cách sau phần tử, tính bằng điểm. |
get | Number|null | Truy xuất khoảng cách trước phần tử, tính bằng điểm. |
get | String | Truy xuất nội dung của phần tử dưới dạng một chuỗi văn bản. |
get | Text | Lấy chế độ căn chỉnh văn bản. |
get | Element | Truy xuất Element của phần tử. |
insert | Horizontal | Tạo và chèn một Horizontal tại chỉ mục đã chỉ định. |
insert | Inline | Tạo và chèn một Inline mới từ blob hình ảnh đã chỉ định, tại chỉ mục đã chỉ định. |
insert | Inline | Chèn Inline đã cho vào chỉ mục được chỉ định. |
insert | Page | Tạo và chèn một Page mới tại chỉ mục đã chỉ định. |
insert | Page | Chèn Page đã cho vào chỉ mục được chỉ định. |
insert | Text | Tạo và chèn một phần tử văn bản mới tại chỉ mục được chỉ định. |
insert | Text | Chèn phần tử Text đã cho tại chỉ mục được chỉ định, với nội dung văn bản được chỉ định. |
is | Boolean | Xác định xem phần tử có ở cuối Document hay không. |
is | Boolean|null | Truy xuất chế độ cài đặt từ trái sang phải. |
merge() | List | Hợp nhất phần tử này với phần tử cùng loại đứng trước. |
remove | List | Xoá phần tử con đã chỉ định. |
remove | List | Xoá phần tử khỏi phần tử mẹ. |
remove | Boolean | Xoá một Positioned theo mã nhận dạng của hình ảnh. |
replace | Element | Thay thế tất cả các lần xuất hiện của một mẫu văn bản nhất định bằng một chuỗi thay thế nhất định, bằng cách sử dụng biểu thức chính quy. |
set | List | Đặt Horizontal. |
set | List | Đặt các thuộc tính của phần tử. |
set | List | Đặt Glyph cho mục trong danh sách. |
set | List | Đặt Paragraph. |
set | List | Đặt mức thụt lề cuối, tính bằng điểm. |
set | List | Đặt mức thụt lề dòng đầu tiên (tính bằng điểm). |
set | List | Đặt khoảng thụt lề bắt đầu, tính bằng điểm. |
set | List | Đặt chế độ cài đặt từ trái sang phải. |
set | List | Đặt khoảng cách dòng, dưới dạng một số lượng cho biết số dòng cần dùng để giãn cách. |
set | List | Đặt URL của đường liên kết. |
set | List | Đặt mã nhận dạng danh sách. |
set | List | Đặt cấp độ lồng của mục trong danh sách. |
set | List | Đặt khoảng cách sau phần tử, tính bằng điểm. |
set | List | Đặt khoảng cách trước phần tử, tính bằng điểm. |
set | void | Đặt nội dung của mục trong danh sách dưới dạng văn bản. |
set | List | Đặt chế độ căn chỉnh văn bản. |
Tài liệu chi tiết
add Positioned Image(image)
Tạo và chèn một Positioned mới từ blob hình ảnh đã chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
image | Blob | dữ liệu hình ảnh |
Cầu thủ trả bóng
Positioned – hình ảnh mới được định vị
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Horizontal Rule()
Tạo và thêm một Horizontal mới.
Cầu thủ trả bóng
Horizontal – quy tắc đường kẻ ngang mới
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Inline Image(image)
Tạo và thêm một Inline mới từ blob hình ảnh đã chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
image | Blob | dữ liệu hình ảnh |
Cầu thủ trả bóng
Inline – hình ảnh được thêm vào
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Inline Image(image)
Nối Inline đã cho.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
image | Inline | dữ liệu hình ảnh |
Cầu thủ trả bóng
Inline – hình ảnh được thêm vào
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Page Break()
Tạo và thêm một Page mới.
Lưu ý: Page có thể không nằm trong Table.
Nếu phần tử hiện tại nằm trong một ô của bảng, thì một trường hợp ngoại lệ sẽ được gửi.
Cầu thủ trả bóng
Page – phần tử ngắt trang mới
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Page Break(pageBreak)
Nối Page đã cho.
Lưu ý: Page có thể không nằm trong Table.
Nếu phần tử hiện tại nằm trong một ô của bảng, thì một trường hợp ngoại lệ sẽ được gửi.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
page | Page | phần ngắt trang cần thêm |
Cầu thủ trả bóng
Page – phần tử ngắt trang được nối
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Text(text)
Tạo và thêm một phần tử Text mới có nội dung được chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
text | String | nội dung văn bản |
Cầu thủ trả bóng
Text – phần tử văn bản mới
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
append Text(text)
Nối phần tử Text đã cho.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
text | Text | phần tử văn bản cần nối |
Cầu thủ trả bóng
Text – phần tử văn bản được thêm vào
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
Trả về một bản sao tách biệt, sao chép sâu của phần tử hiện tại.
Mọi phần tử con có trong phần tử cũng sẽ được sao chép. Phần tử mới không có phần tử mẹ.
Cầu thủ trả bóng
List – Bản sao mới.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
edit As Text()
Lấy phiên bản Text của phần tử hiện tại để chỉnh sửa.
Sử dụng edit để thao tác nội dung của các phần tử dưới dạng văn bản đa dạng thức. Chế độ edit bỏ qua các phần tử không phải văn bản (chẳng hạn như Inline và Horizontal).
Các phần tử con nằm hoàn toàn trong một dải văn bản đã bị xoá sẽ bị xoá khỏi phần tử.
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);
Cầu thủ trả bóng
Text – phiên bản văn bản của phần tử hiện tại
find Element(elementType)
Tìm kiếm nội dung của phần tử cho một phần tử con thuộc loại được chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
element | Element | Loại phần tử cần tìm kiếm. |
Cầu thủ trả bóng
Range – Kết quả tìm kiếm cho biết vị trí của phần tử tìm kiếm.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Element(elementType, from)
Tìm kiếm nội dung của phần tử cho một phần tử con thuộc loại được chỉ định, bắt đầu từ Range được chỉ định.
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; } }
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
element | Element | Loại phần tử cần tìm kiếm. |
from | Range | Kết quả tìm kiếm để tìm kiếm. |
Cầu thủ trả bóng
Range – Kết quả tìm kiếm cho biết vị trí tiếp theo của phần tử tìm kiếm.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern)
Tìm kiếm nội dung của phần tử theo mẫu văn bản đã chỉ định bằng cách sử dụng biểu thức chính quy.
Một số tính năng biểu thức chính quy JavaScript không được hỗ trợ đầy đủ, chẳng hạn như nhóm chụp và bộ sửa đổi chế độ.
Mẫu biểu thức chính quy được cung cấp sẽ được so khớp độc lập với từng khối văn bản có trong phần tử hiện tại.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
search | String | mẫu cần tìm |
Cầu thủ trả bóng
Range – kết quả tìm kiếm cho biết vị trí của văn bản tìm kiếm hoặc giá trị rỗng nếu không có kết quả trùng khớp
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
Tìm kiếm nội dung của phần tử theo mẫu văn bản đã chỉ định, bắt đầu từ một kết quả tìm kiếm nhất định.
Một số tính năng biểu thức chính quy JavaScript không được hỗ trợ đầy đủ, chẳng hạn như nhóm chụp và bộ sửa đổi chế độ.
Mẫu biểu thức chính quy được cung cấp sẽ được so khớp độc lập với từng khối văn bản có trong phần tử hiện tại.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
search | String | mẫu cần tìm |
from | Range | kết quả tìm kiếm để tìm |
Cầu thủ trả bóng
Range – kết quả tìm kiếm cho biết vị trí tiếp theo của văn bản tìm kiếm hoặc giá trị rỗng nếu không có kết quả khớp
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alignment()
Truy xuất Horizontal.
Cầu thủ trả bóng
Horizontal – sự liên kết
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Attributes()
Truy xuất các thuộc tính của phần tử.
Kết quả là một đối tượng chứa một thuộc tính cho mỗi thuộc tính phần tử hợp lệ, trong đó mỗi tên thuộc tính tương ứng với một mục trong phép liệt kê Document.
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]}`); }
Cầu thủ trả bóng
Object – Thuộc tính của phần tử.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child(childIndex)
Truy xuất phần tử con tại chỉ mục con được chỉ định.
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.'); }
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | Chỉ mục của phần tử con cần truy xuất. |
Cầu thủ trả bóng
Element – Phần tử con tại chỉ mục được chỉ định.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Child Index(child)
Truy xuất chỉ mục con cho phần tử con được chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Element | Phần tử con mà bạn muốn truy xuất chỉ mục. |
Cầu thủ trả bóng
Integer – Chỉ mục con.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Glyph Type()
get Heading()
Truy xuất Paragraph.
Cầu thủ trả bóng
Paragraph – tiêu đề
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Indent End()
Truy xuất phần thụt lề cuối, tính bằng điểm.
Cầu thủ trả bóng
Number|null – phần thụt lề cuối, tính bằng điểm
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Indent First Line()
Truy xuất mức thụt lề dòng đầu tiên (tính bằng điểm).
Cầu thủ trả bóng
Number|null – mức thụt lề dòng đầu tiên, tính bằng điểm
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Indent Start()
Truy xuất phần thụt đầu dòng bắt đầu.
Cầu thủ trả bóng
Number|null – phần thụt lề bắt đầu
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Line Spacing()
Truy xuất khoảng cách dòng, tính bằng điểm.
Cầu thủ trả bóng
Number|null – giãn cách dòng, tính bằng điểm
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Link Url()
Truy xuất URL của đường liên kết.
Cầu thủ trả bóng
String|null – URL của đường liên kết hoặc giá trị rỗng nếu phần tử chứa nhiều giá trị cho thuộc tính này
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get List Id()
Truy xuất mã nhận dạng danh sách.
Cầu thủ trả bóng
String|null – mã danh sách
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Nesting Level()
Truy xuất cấp độ lồng của mục trong danh sách.
Theo mặc định, các mục trong danh sách có cấp lồng bằng 0. Cấp độ lồng nhau xác định ký tự được mục trong danh sách sử dụng.
Cầu thủ trả bóng
Integer – cấp độ lồng ghép
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Next Sibling()
Truy xuất phần tử anh chị em tiếp theo của phần tử.
Phần tử anh chị em tiếp theo có cùng phần tử mẹ và nằm sau phần tử hiện tại.
Cầu thủ trả bóng
Element|null – Phần tử anh chị em tiếp theo.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Num Children()
Truy xuất số lượng thành phần con.
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.`);
Cầu thủ trả bóng
Integer – Số trẻ em.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
Truy xuất phần tử mẹ của phần tử.
Phần tử mẹ chứa phần tử hiện tại.
Cầu thủ trả bóng
Container – Phần tử mẹ.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Positioned Image(id)
Lấy một Positioned theo mã nhận dạng của hình ảnh.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
id | String | mã nhận dạng hình ảnh |
Cầu thủ trả bóng
Positioned – hình ảnh được đặt vị trí
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Positioned Images()
Lấy tất cả các đối tượng Positioned được neo vào đoạn văn.
Cầu thủ trả bóng
Positioned – danh sách hình ảnh được định vị
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Previous Sibling()
Truy xuất phần tử anh chị em trước đó của phần tử.
Phần tử anh chị em trước có cùng phần tử mẹ và đứng trước phần tử hiện tại.
Cầu thủ trả bóng
Element|null – Phần tử anh chị em trước đó.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Spacing After()
Truy xuất khoảng cách sau phần tử, tính bằng điểm.
Cầu thủ trả bóng
Number|null – khoảng cách sau phần tử, tính bằng điểm
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Spacing Before()
Truy xuất khoảng cách trước phần tử, tính bằng điểm.
Cầu thủ trả bóng
Number|null – khoảng cách trước phần tử, tính bằng điểm
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text()
Truy xuất nội dung của phần tử dưới dạng một chuỗi văn bản.
Cầu thủ trả bóng
String – nội dung của phần tử dưới dạng chuỗi văn bản
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Text Alignment()
Lấy chế độ căn chỉnh văn bản. Các loại căn chỉnh có sẵn là Document, Document và Document.
Cầu thủ trả bóng
Text – loại căn chỉnh văn bản hoặc null nếu văn bản có nhiều loại căn chỉnh văn bản hoặc nếu bạn chưa bao giờ đặt chế độ căn chỉnh văn bản
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
Truy xuất Element của phần tử.
Dùng get để xác định chính xác loại của một phần tử nhất định.
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.'); }
Cầu thủ trả bóng
Element – Loại phần tử.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Horizontal Rule(childIndex)
Tạo và chèn một Horizontal tại chỉ mục đã chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
Cầu thủ trả bóng
Horizontal – phần tử quy tắc dòng kẻ ngang mới
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
Tạo và chèn một Inline mới từ blob hình ảnh đã chỉ định, tại chỉ mục đã chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
image | Blob | dữ liệu hình ảnh |
Cầu thủ trả bóng
Inline – phần tử hình ảnh cùng dòng được chèn
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
Chèn Inline đã cho vào chỉ mục được chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
image | Inline | dữ liệu hình ảnh |
Cầu thủ trả bóng
Inline – phần tử hình ảnh cùng dòng được chèn
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Page Break(childIndex)
Tạo và chèn một Page mới tại chỉ mục đã chỉ định.
Lưu ý: Page có thể không nằm trong Table.
Nếu phần tử hiện tại nằm trong một ô của bảng, thì một trường hợp ngoại lệ sẽ được gửi.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
Cầu thủ trả bóng
Page – phần tử ngắt trang mới
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Page Break(childIndex, pageBreak)
Chèn Page đã cho vào chỉ mục được chỉ định.
Lưu ý: Page có thể không nằm trong Table.
Nếu phần tử hiện tại nằm trong một ô của bảng, thì một trường hợp ngoại lệ sẽ được gửi.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
page | Page | phần ngắt trang cần chèn |
Cầu thủ trả bóng
Page – phần tử ngắt trang được chèn
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
Tạo và chèn một phần tử văn bản mới tại chỉ mục được chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
text | String | nội dung văn bản |
Cầu thủ trả bóng
Text – phần tử văn bản mới
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
Chèn phần tử Text đã cho tại chỉ mục được chỉ định, với nội dung văn bản được chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Integer | chỉ mục mà bạn muốn chèn phần tử |
text | Text | phần tử văn bản cần chèn |
Cầu thủ trả bóng
Text – phần tử văn bản được chèn
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is At Document End()
Xác định xem phần tử có ở cuối Document hay không.
Cầu thủ trả bóng
Boolean – Cho biết phần tử có nằm ở cuối thẻ hay không.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is Left To Right()
Truy xuất chế độ cài đặt từ trái sang phải.
Cầu thủ trả bóng
Boolean|null – chế độ cài đặt từ trái sang phải
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
merge()
Hợp nhất phần tử này với phần tử cùng loại đứng trước.
Bạn chỉ có thể hợp nhất các phần tử có cùng Element. Mọi phần tử con có trong phần tử hiện tại đều được chuyển đến phần tử anh chị em trước đó.
Phần tử hiện tại sẽ bị xoá khỏi tài liệu.
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();
Cầu thủ trả bóng
List – Phần tử được hợp nhất.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Child(child)
Xoá phần tử con đã chỉ định.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
child | Element | phần tử con cần xoá |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove From Parent()
Xoá phần tử khỏi phần tử mẹ.
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(); }
Cầu thủ trả bóng
List – Phần tử đã bị xoá.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
remove Positioned Image(id)
Xoá một Positioned theo mã nhận dạng của hình ảnh.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
id | String |
Cầu thủ trả bóng
Boolean – hình ảnh được chỉ định có bị xoá hay không
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
Thay thế tất cả các lần xuất hiện của một mẫu văn bản nhất định bằng một chuỗi thay thế nhất định, bằng cách sử dụng biểu thức chính quy.
Mẫu tìm kiếm được truyền dưới dạng một chuỗi, không phải là đối tượng biểu thức chính quy JavaScript. Do đó, bạn cần thoát mọi dấu gạch chéo ngược trong mẫu.
Phương thức này sử dụng thư viện biểu thức chính quy RE2 của Google, giúp giới hạn cú pháp được hỗ trợ.
Mẫu biểu thức chính quy được cung cấp sẽ được so khớp độc lập với từng khối văn bản có trong phần tử hiện tại.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
search | String | mẫu biểu thức chính quy để tìm kiếm |
replacement | String | văn bản dùng để thay thế |
Cầu thủ trả bóng
Element – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alignment(alignment)
Đặt Horizontal.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
alignment | Horizontal | căn chỉnh theo chiều ngang |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(attributes)
Đặt các thuộc tính của phần tử.
Tham số thuộc tính được chỉ định phải là một đối tượng trong đó mỗi tên thuộc tính là một mục trong phép liệt kê Document và mỗi giá trị thuộc tính là giá trị mới sẽ được áp dụng.
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);
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
attributes | Object | Thuộc tính của phần tử. |
Cầu thủ trả bóng
List – Phần tử hiện tại.
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Glyph Type(glyphType)
Đặt Glyph cho mục trong danh sách.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
glyph | Glyph | loại ký tự |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Heading(heading)
Đặt Paragraph.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
heading | Paragraph | tiêu đề |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Indent End(indentEnd)
Đặt mức thụt lề cuối, tính bằng điểm.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
indent | Number | khoảng thụt lề cuối, tính bằng điểm |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Indent First Line(indentFirstLine)
Đặt mức thụt lề dòng đầu tiên (tính bằng điểm).
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
indent | Number | khoảng thụt lề dòng đầu tiên, tính bằng điểm |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Indent Start(indentStart)
Đặt khoảng thụt lề bắt đầu, tính bằng điểm.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
indent | Number | khoảng thụt lề bắt đầu, tính bằng điểm |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Left To Right(leftToRight)
Đặt chế độ cài đặt từ trái sang phải.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
left | Boolean | chế độ cài đặt từ trái sang phải |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Line Spacing(multiplier)
Đặt khoảng cách dòng, dưới dạng một số lượng cho biết số dòng cần dùng để giãn cách.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
multiplier | Number | số lượng dòng |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Link Url(url)
Đặt URL của đường liên kết.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
url | String | URL của đường liên kết |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set List Id(listItem)
Đặt mã nhận dạng danh sách.
Mã nhận dạng danh sách được đặt thành cùng một giá trị cho List đã chỉ định. Hai List này sẽ được coi là thành viên của cùng một danh sách.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
list | List | mục trong danh sách có mã danh sách cần sử dụng |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Nesting Level(nestingLevel)
Đặt cấp độ lồng của mục trong danh sách.
Theo mặc định, các mục trong danh sách có cấp lồng bằng 0. Cấp độ lồng nhau xác định ký tự được mục trong danh sách sử dụng.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
nesting | Integer | mức lồng ghép |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Spacing After(spacingAfter)
Đặt khoảng cách sau phần tử, tính bằng điểm.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
spacing | Number | khoảng cách sau phần tử, tính bằng điểm |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Spacing Before(spacingBefore)
Đặt khoảng cách trước phần tử, tính bằng điểm.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
spacing | Number | khoảng cách trước phần tử, tính bằng điểm |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text(text)
Đặt nội dung của mục trong danh sách dưới dạng văn bản.
Lưu ý: nội dung hiện có sẽ bị xoá.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
text | String | nội dung văn bản mới |
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
Đặt chế độ căn chỉnh văn bản. Các loại căn chỉnh có sẵn là Document, Document và Document.
// 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);
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
text | Text | loại căn chỉnh văn bản cần áp dụng |
Cầu thủ trả bóng
List – phần tử hiện tại
Ủy quyền
Các tập lệnh sử dụng phương thức này cần được uỷ quyền bằng một hoặc nhiều phạm vi sau đây:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents