Một thẻ tài liệu, chứa văn bản đa dạng thức và các phần tử như bảng và danh sách.
Truy xuất một thẻ tài liệu bằng cách sử dụng Document.getTabs()[tabIndex].asDocumentTab().
// Get a specific document tab based on the tab ID. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
Phương thức
| Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
|---|---|---|
add | Bookmark | Thêm Bookmark tại Position đã cho. |
add | Footer | Thêm một phần chân trang cho thẻ nếu chưa có. |
add | Header | Thêm một phần tiêu đề thẻ nếu chưa có. |
add | Named | Thêm Named, là Range có tên và mã nhận dạng để dùng cho việc truy xuất sau này. |
get | Body | Truy xuất Body của thẻ. |
get | Bookmark|null | Lấy Bookmark có mã nhận dạng đã cho. |
get | Bookmark[] | Lấy tất cả các đối tượng Bookmark trong thẻ. |
get | Footer | Truy xuất phần chân trang của thẻ (nếu có). |
get | Footnote[]|null | Truy xuất tất cả các phần tử Footnote trong nội dung của thẻ. |
get | Header | Truy xuất phần tiêu đề của thẻ (nếu có). |
get | Named | Lấy Named có mã nhận dạng đã cho. |
get | Named | Lấy tất cả các đối tượng Named trong thẻ. |
get | Named | Lấy tất cả các đối tượng Named trong thẻ có tên đã cho. |
new | Position | Tạo một Position mới, là một tham chiếu đến một vị trí trong thẻ, tương ứng với một phần tử cụ thể. |
new | Range | Tạo một trình tạo dùng để tạo các đối tượng Range từ các phần tử thẻ. |
Tài liệu chi tiết
add Bookmark(position)
Thêm Bookmark tại Position đã cho.
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Gets the tab body and adds a paragraph. const paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = documentTab.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = documentTab.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId());
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
position | Position | Vị trí của dấu trang mới. |
Cầu thủ trả bóng
Bookmark – Dấu 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
add Header()
Thêm một phần tiêu đề thẻ nếu chưa có.
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Adds a header to the tab. const header = documentTab.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Cầu thủ trả bóng
Header – Tiêu đề thẻ.
Ủ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
add Named Range(name, range)
Thêm Named, là Range có tên và mã nhận dạng để dùng cho việc truy xuất sau này. Tên không nhất thiết phải là duy nhất, ngay cả trên các thẻ; một số dải ô khác nhau trong cùng một tài liệu có thể dùng chung một tên, giống như một lớp trong HTML. Ngược lại, các mã nhận dạng là duy nhất trong tài liệu, chẳng hạn như mã nhận dạng trong HTML. Sau khi thêm Named, bạn không thể sửa đổi mà chỉ có thể xoá Named đó.
Mọi tập lệnh truy cập vào thẻ đều có thể truy cập vào một Named. Để tránh xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc việc thêm tiền tố cho tên dải ô bằng một chuỗi duy nhất.
// Creates a named range that includes every table in a tab by its ID. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); const rangeBuilder = documentTab.newRange(); const tables = documentTab.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
name | String | Tên của dải ô (không cần phải là duy nhất); tên dải ô phải có từ 1 đến 256 ký tự. |
range | Range | Phạm vi của các phần tử cần liên kết với tên; phạm vi này có thể là một kết quả tìm kiếm hoặc được tạo theo cách thủ công bằng new. |
Cầu thủ trả bóng
Named – Named.
Ủ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 Body()
Truy xuất Body của thẻ.
Các thẻ có thể chứa nhiều loại phần (ví dụ: Header, Footer). Phần đang hoạt động của một thẻ là Body.
Các phương thức phần tử trong Document uỷ quyền cho Body.
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Gets the tab body. const body = documentTab.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Cầu thủ trả bóng
Body – Phần nội dung của thẻ.
Ủ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 Bookmark(id)
Lấy Bookmark có mã nhận dạng đã cho. Phương thức này trả về null nếu không có Bookmark nào như vậy trong thẻ này.
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Gets the bookmark by its ID. const bookmark = documentTab.getBookmark('id.xyz654321'); // If the bookmark exists within the tab, logs the character offset of its // position to the console. Otherwise, logs 'No bookmark exists with the given // ID.' to the console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
id | String | Mã nhận dạng của Bookmark. |
Cầu thủ trả bóng
Bookmark|null – Bookmark có mã nhận dạng đã cho hoặc null nếu không có Bookmark nào như vậy trong thẻ.
Ủ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 Bookmarks()
Lấy tất cả các đối tượng Bookmark trong thẻ.
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Gets all of the bookmarks in the tab. const bookmarks = documentTab.getBookmarks(); // Logs the number of bookmarks in the tab to the console. console.log(bookmarks.length);
Cầu thủ trả bóng
Bookmark[] – Một mảng gồm các đối tượng Bookmark trong thẻ.
Ủ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 Footnotes()
Truy xuất tất cả các phần tử Footnote trong nội dung của thẻ.
Các lệnh gọi đến get sẽ gây ra một lần lặp lại trên các phần tử của thẻ. Đối với các thẻ lớn, hãy tránh gọi phương thức này một cách không cần thiết.
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Gets the first footnote. const footnote = documentTab.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Cầu thủ trả bóng
Footnote[]|null – Chú thích cuối trang của thẻ.
Ủ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 Header()
Truy xuất phần tiêu đề của thẻ (nếu có).
// Opens the Docs file and retrieves the tab by its IDs. If you created your // script from within a Google Docs file, you can use // DocumentApp.getActiveDocument().getActiveTab() instead. // TODO(developer): Replace the IDs with your own. const documentTab = DocumentApp.openById('123abc').getTab('123abc').asDocumentTab(); // Gets the text of the tab's header and logs it to the console. console.log(documentTab.getHeader().getText());
Cầu thủ trả bóng
Header – Tiêu đề của thẻ.
Ủ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 Named Range By Id(id)
Lấy Named có mã nhận dạng đã cho. Phương thức này trả về null nếu không có Named nào như vậy trong thẻ. Tên không nhất thiết phải là duy nhất, ngay cả trên các thẻ; một số dải ô khác nhau trong cùng một tài liệu có thể dùng chung một tên, giống như một lớp trong HTML. Ngược lại, các mã nhận dạng là duy nhất trong thẻ, chẳng hạn như mã nhận dạng trong HTML.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
id | String | Mã nhận dạng của dải ô, là mã nhận dạng riêng biệt trong thẻ. |
Cầu thủ trả bóng
Named – Named có mã nhận dạng đã cho hoặc null nếu không có phạm vi nào như vậy trong thẻ.
Ủ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 Named Ranges()
Lấy tất cả các đối tượng Named trong thẻ.
Mọi tập lệnh truy cập vào thẻ đều có thể truy cập vào Named. Để tránh xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc thêm tiền tố là một chuỗi duy nhất vào tên dải ô.
Cầu thủ trả bóng
Named – Một mảng gồm các đối tượng Named trong thẻ, có thể bao gồm nhiều dải ô có cùng tê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 Named Ranges(name)
Lấy tất cả các đối tượng Named trong thẻ có tên đã cho. Tên không nhất thiết phải là duy nhất, ngay cả trên các thẻ; một số dải ô khác nhau trong cùng một tài liệu có thể dùng chung một tên, giống như một lớp trong HTML. Ngược lại, mã nhận dạng là duy nhất trong thẻ, chẳng hạn như mã nhận dạng trong HTML.
Mọi tập lệnh truy cập vào thẻ đều có thể truy cập vào Named. Để tránh xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc thêm tiền tố là một chuỗi duy nhất vào tên dải ô.
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
name | String | Tên của dải ô (không nhất thiết phải là duy nhất). |
Cầu thủ trả bóng
Named – Một mảng gồm các đối tượng Named trong thẻ có tên đã cho.
Ủ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
new Position(element, offset)
Tạo một Position mới, là một tham chiếu đến một vị trí trong thẻ, tương ứng với một phần tử cụ thể. Con trỏ của người dùng được biểu thị dưới dạng Position, trong số những mục đích sử dụng khác.
// Append a paragraph, then place the user's cursor after the first word of the // new paragraph. // TODO(developer): Replace the IDs with your own. const doc = DocumentApp.openById('123abc'); const documentTab = doc.getTab('123abc').asDocumentTab(); const paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); const position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Thông số
| Tên | Loại | Mô tả |
|---|---|---|
element | Element | Phần tử chứa Position mới tạo; phần tử này phải là phần tử Text hoặc phần tử vùng chứa như Paragraph. |
offset | Integer | Đối với các phần tử Text, số lượng ký tự trước Position; đối với các phần tử khác, số lượng phần tử con trước Position trong cùng một phần tử vùng chứa. |
Cầu thủ trả bóng
Position – Position 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
new Range()
Tạo một trình tạo dùng để tạo các đối tượng Range từ các phần tử thẻ.
// Change the user's selection to a range that includes every table in the tab. // TODO(developer): Replace the IDs with your own. const doc = DocumentApp.openById('123abc'); const documentTab = doc.getTab('123abc').asDocumentTab(); const rangeBuilder = documentTab.newRange(); const tables = documentTab.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Cầu thủ trả bóng
Range – Trình tạo 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