Một tài liệu, chứa một hoặc nhiều đối tượng Tab
, mỗi đối tượng chứa văn bản đa dạng thức và các phần tử như bảng và danh sách.
Bạn có thể mở hoặc tạo tài liệu bằng Document
.
// Open a document by ID. let doc = DocumentApp.openById('<my-id>'); // Create and open a document. doc = DocumentApp.create('Document Title');
Các phương thức trên lớp Document
trực tiếp truy cập và sửa đổi nội dung văn bản hoạt động trên thẻ đang hoạt động (trong các tập lệnh liên kết với một tài liệu cụ thể) hoặc thẻ đầu tiên (nếu không có thẻ đang hoạt động). Bạn có thể di chuyển các tập lệnh dựa vào các phương thức này (ví dụ: get
) để hỗ trợ các thẻ bằng cách sử dụng get
rồi đến Tab.asDocumentTab()
.
Phương thức
Phương thức | Loại dữ liệu trả về | Mô tả ngắn |
---|---|---|
add | Bookmark | Thêm Bookmark tại Position đã cho vào thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh được liên kết với một tài liệu. |
add | Document | Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Document . |
add | Document | Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Document . |
add | Document | Thêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho Document . |
add | Footer | Thêm phần chân trang (nếu không có) vào thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
add | Header | Thêm một phần tiêu đề (nếu không có) vào thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
add | Named | Thêm Named , là một Range có tên và mã nhận dạng để sử dụng cho việc truy xuất sau này, trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
add | Document | Thêm người dùng đã cho vào danh sách người xem của Document . |
add | Document | Thêm người dùng đã cho vào danh sách người xem của Document . |
add | Document | Thêm mảng người dùng đã cho vào danh sách người xem cho Document . |
get | Tab | Lấy Tab đang hoạt động của người dùng trong tài liệu. |
get | Blob | Truy xuất nội dung Document hiện tại dưới dạng một blob thuộc loại đã chỉ định. |
get | Blob | Truy xuất nội dung Document hiện tại dưới dạng blob. |
get | Body | Truy xuất Body của thẻ đầu tiên hoặc Document của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Bookmark | Lấy Bookmark có mã nhận dạng đã cho trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Bookmark[] | Lấy tất cả đối tượng Bookmark trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Position | Lấy con trỏ của người dùng trong thẻ đang hoạt động. |
get | User[] | Lấy danh sách trình chỉnh sửa cho Document này. |
get | Footer | Truy xuất phần chân trang của thẻ đầu tiên hoặc phần chân trang của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Footnote[] | Truy xuất tất cả phần tử Footnote trong phần nội dung của thẻ đầu tiên hoặc phần nội dung của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Header | Truy xuất phần tiêu đề của thẻ đầu tiên hoặc phần tiêu đề của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | String | Truy xuất giá trị nhận dạng duy nhất của tài liệu. |
get | String | Lấy mã ngôn ngữ của tài liệu. |
get | String | Truy xuất tiêu đề của tài liệu. |
get | Named | Lấy Named có mã nhận dạng đã cho trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Named | Lấy tất cả đối tượng Named trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. |
get | Named | Lấy tất cả đối tượng Named có tên đã cho trong thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động. |
get | Range | Lấy lựa chọn của người dùng trong thẻ đang hoạt động. |
get | String[] | Lấy tất cả mã ngôn ngữ được hỗ trợ trong tệp Google Tài liệu. |
get | Tab | Lấy Tab có mã nhận dạng được chỉ định. |
get | Tab[] | Lấy tất cả Tab chưa lồng nhau thuộc tài liệu. |
get | String | Truy xuất URL để truy cập vào tài liệu hiện tại. |
get | User[] | Lấy danh sách người xem và người nhận xét cho Document này. |
new | Position | Tạo một Position mới, là một tệp tham chiếu đến một vị trí trong thẻ, tương ứng với một phần tử cụ thể trong thẻ đầu tiên hoặc đối với các tập lệnh liên kết với một tài liệu, thẻ đang hoạt động. |
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ẻ trong thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động. |
remove | Document | Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho Document . |
remove | Document | Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho Document . |
remove | Document | Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho Document . |
remove | Document | Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho Document . |
save | void | Lưu Document hiện tại. |
set | void | Đặt Tab đã chọn của người dùng trong tài liệu hiện tại thành thẻ có mã nhận dạng được chỉ định. |
set | Document | Đặt con trỏ của người dùng, với Position . |
set | Document | Đặt mã ngôn ngữ của tài liệu. |
set | Document | Đặt tiêu đề tài liệu. |
set | Document | Đặt lựa chọn của người dùng trong thẻ đang hoạt động, với Range . |
Tài liệu chi tiết
add Bookmark(position)
Thêm Bookmark
tại Position
đã cho vào thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh được liên kết với một tài liệu. Để thêm một dấu trang vào bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
// 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 active or first tab's body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId());
Tham 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Editor(emailAddress)
Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Document
. Nếu người dùng đã có trong danh sách người xem, phương thức này sẽ loại người dùng đó khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
email | String | Địa chỉ email của người dùng cần thêm. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Editor(user)
Thêm người dùng đã cho vào danh sách người chỉnh sửa cho Document
. Nếu người dùng đã có trong danh sách người xem, phương thức này sẽ loại người dùng đó khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Nội dung đại diện cho người dùng cần thêm. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Editors(emailAddresses)
Thêm mảng người dùng đã cho vào danh sách người chỉnh sửa cho Document
. Nếu có người dùng nào đã có trong danh sách người xem, thì phương thức này sẽ loại họ khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
email | String[] | Một mảng gồm các địa chỉ email của người dùng cần thêm. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Header()
Thêm một phần tiêu đề (nếu không có) vào thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để thêm mục tiêu đầu trang vào bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
// 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'); // Adds a header to the document's active or first tab. const header = doc.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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Named Range(name, range)
Thêm Named
, là một Range
có tên và mã nhận dạng để sử dụng cho việc truy xuất sau này, trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để thêm Named
trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
. Tên không nhất thiết phải duy nhất; một số dải ô khác nhau trong cùng một tài liệu có thể có cùng 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 tài liệu, chẳng hạn như mã nhận dạng trong HTML.
Sau khi thêm Named
vào một tài liệu, 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 tài liệu đều có thể truy cập vào Named
. Để tránh các xung đột không mong muốn giữa các tập lệnh, hãy cân nhắc đặt 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 the active tab. const doc = DocumentApp.getActiveDocument(); const rangeBuilder = doc.newRange(); const tables = doc.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } // Adds the named range to the document's active tab. doc.addNamedRange('Document tables', rangeBuilder.build());
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | Tên cho dải ô, không cần phải là tên duy nhất; tên dải ô phải có từ 1 đến 256 ký tự. |
range | Range | Dải ô của các phần tử cần liên kết với tên; dải ô có thể là lựa chọn đang hoạt động, kết quả tìm kiếm hoặc được tạo 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Viewer(emailAddress)
Thêm người dùng đã cho vào danh sách người xem của Document
. Nếu người dùng đã có trong danh sách người chỉnh sửa, thì phương thức này sẽ không có hiệu lực.
Tham số
Tên | Loại | Mô tả |
---|---|---|
email | String | Địa chỉ email của người dùng cần thêm. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Viewer(user)
Thêm người dùng đã cho vào danh sách người xem của Document
. Nếu người dùng đã có trong danh sách người chỉnh sửa, thì phương thức này sẽ không có hiệu lực.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Nội dung đại diện cho người dùng cần thêm. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
add Viewers(emailAddresses)
Thêm mảng người dùng đã cho vào danh sách người xem cho Document
. Nếu bất kỳ người dùng nào đã có trong danh sách người chỉnh sửa, thì phương thức này sẽ không ảnh hưởng đến họ.
Tham số
Tên | Loại | Mô tả |
---|---|---|
email | String[] | Một mảng gồm các địa chỉ email của người dùng cần thêm. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Active Tab()
Lấy Tab
đang hoạt động của người dùng trong tài liệu. Một tập lệnh chỉ có thể truy cập vào thẻ đang hoạt động của người dùng đang chạy tập lệnh và chỉ khi tập lệnh đó được liên kết với tài liệu.
// Display a dialog box that shows the title of the tab that the // user is currently viewing. const tab = DocumentApp.getActiveDocument().getActiveTab(); DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);
Cầu thủ trả bóng
Tab
– Tab
hiện đang hoạt động của người dùng hoặc null
nếu tập lệnh không liên kết với tài liệu.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get As(contentType)
Truy xuất nội dung Document
hiện tại dưới dạng một blob thuộc loại đã chỉ định.
// 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 document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
Tham số
Tên | Loại | Mô tả |
---|---|---|
content | String | Loại MIME cần chuyển đổi sang; 'application/pdf' và 'text/markdown' được hỗ trợ. |
Cầu thủ trả bóng
Blob
– Tài liệu hiện tại dưới dạng blob.
get Blob()
Truy xuất nội dung Document
hiện tại dưới dạng 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'); // Retrieves the current document's contents as a blob and logs it to the // console. console.log(doc.getBlob().getContentType());
Cầu thủ trả bóng
Blob
– Tài liệu hiện tại dưới dạng blob.
get Body()
Truy xuất Body
của thẻ đầu tiên hoặc Document
của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy Document
của bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
Thẻ có thể chứa nhiều loại mục (ví dụ: Header
, Footer
). Mục đang hoạt động của thẻ là Body
.
Các phương thức phần tử trong Document
uỷ quyền cho Body
đang hoạt động.
// 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 active or first tab's body. const body = doc.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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
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 trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy một dấu trang trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
. Phương thức này trả về null
nếu không có Bookmark
nào như vậy trong thẻ.
// 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 bookmark by its ID in the document's active or first tab. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, 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.'); }
Tham số
Tên | Loại | Mô tả |
---|---|---|
id | String | Mã nhận dạng cho Bookmark . |
Cầu thủ trả bóng
Bookmark
– 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Bookmarks()
Lấy tất cả đối tượng Bookmark
trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy tất cả dấu trang trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById('123abc'); // Gets all of the bookmarks in the document's active or first tab. const bookmarks = doc.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 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Cursor()
Lấy con trỏ của người dùng trong thẻ đang hoạt động. Một tập lệnh chỉ có thể truy cập vào con trỏ của người dùng đang chạy tập lệnh và chỉ khi tập lệnh đó được liên kết với tài liệu.
// Insert some text at the cursor position and make it bold. const cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns // null, the cursor's containing element doesn't allow insertions, so show the // user an error message. const element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Cầu thủ trả bóng
Position
– Biểu thị con trỏ của người dùng hoặc null
nếu người dùng không đặt con trỏ vào thẻ hoặc nếu tập lệnh không được liên kết với tài liệu.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Editors()
Lấy danh sách trình chỉnh sửa cho Document
này.
Cầu thủ trả bóng
User[]
– Mảng người dùng có quyền chỉnh sửa.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Footnotes()
Truy xuất tất cả phần tử Footnote
trong phần nội dung của thẻ đầu tiên hoặc phần nội dung của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy tất cả chú thích cuối trang trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
Các lệnh gọi đến get
sẽ tạo ra một vòng lặp trên các phần tử của thẻ. Đối với các thẻ lớn, hãy tránh các lệnh gọi không cần thiết đến phương thức này.
// 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 first footnote in the active or first tab's body. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Cầu thủ trả bóng
Footnote[]
– 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
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ẻ đầu tiên hoặc phần tiêu đề của thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy phần tiêu đề của bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
// 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 text of the active or first tab's header and logs it to the console. console.log(doc.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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Id()
Truy xuất giá trị nhận dạng duy nhất của tài liệu. Mã tài liệu được dùng với Document
để mở một thực thể tài liệu cụ thể.
Cầu thủ trả bóng
String
– Mã nhận dạng của tài liệu.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Language()
Lấy mã ngôn ngữ của tài liệu. Đây là ngôn ngữ xuất hiện trong trình chỉnh sửa tài liệu File > Language (Tệp > Ngôn ngữ). Ngôn ngữ này có thể không phải là ngôn ngữ thực tế mà tài liệu chứa.
Cầu thủ trả bóng
String
– Ngôn ngữ của tài liệu hoặc null
nếu không được xác định.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Name()
Truy xuất tiêu đề của tài liệu.
Cầu thủ trả bóng
String
– Tiêu đề tài liệu.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
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 trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy Named
có mã nhận dạng đã cho trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
. 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 thẻ có thể có cùng 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ẻ, giống như mã nhận dạng trong HTML.
Tham số
Tên | Loại | Mô tả |
---|---|---|
id | String | Mã nhận dạng của dải ô, là mã nhận dạng duy nhấ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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Named Ranges()
Lấy tất cả đối tượng Named
trong thẻ đầu tiên hoặc thẻ đang hoạt động đối với các tập lệnh liên kết với một tài liệu. Để lấy tất cả đối tượng Named
trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
Mọi tập lệnh truy cập vào thẻ đều có thể truy cập vào Named
. Để tránh các xung đột ngoài ý muốn giữa các tập lệnh, hãy cân nhắc đặt tiền tố cho tên dải ô bằng một chuỗi duy nhất.
Cầu thủ trả bóng
Named
– Một mảng các đối tượng Named
trong thẻ, có thể bao gồm nhiều phạm vi có cùng tên.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Named Ranges(name)
Lấy tất cả đối tượng Named
có tên đã cho trong thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động. Để lấy tất cả đối tượng Named
trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
. 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 thẻ có thể có cùng 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ẻ, giống như mã nhận dạng trong HTML.
Mọi tập lệnh truy cập vào tài liệu đều có thể truy cập vào Named
. Để tránh các xung đột ngoài ý muốn giữa các tập lệnh, hãy cân nhắc đặt tiền tố cho tên dải ô bằng một chuỗi duy nhất.
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | Tên của dải ô, không nhất thiết phải là tên duy nhất. |
Cầu thủ trả bóng
Named
– Một mảng 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Selection()
Lấy lựa chọn của người dùng trong thẻ đang hoạt động. Một tập lệnh chỉ có thể truy cập vào lựa chọn của người dùng đang chạy tập lệnh và chỉ khi tập lệnh đó được liên kết với tài liệu.
// Display a dialog box that tells the user how many elements are included in // the selection. const selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { const elements = selection.getRangeElements(); DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
Cầu thủ trả bóng
Range
– Biểu thị nội dung người dùng chọn hoặc null
nếu người dùng không chọn nội dung nào trong thẻ, nếu chỉ chọn cuối đoạn văn bản, nếu chỉ chọn cuối đoạn văn bản và dòng mới hoặc nếu tập lệnh không liên kết với tài liệu.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Supported Language Codes()
Lấy tất cả mã ngôn ngữ được hỗ trợ trong tệp Google Tài liệu.
Cầu thủ trả bóng
String[]
– Một mảng mã ngôn ngữ.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Tab(tabId)
Lấy Tab
có mã nhận dạng được chỉ định. Phương thức này trả về null
nếu không có Tab
nào như vậy. Có thể truy cập vào thẻ ở bất kỳ cấp lồng nào.
Tham số
Tên | Loại | Mô tả |
---|---|---|
tab | String | Mã của thẻ cần lấy. |
Cầu thủ trả bóng
Tab
– Tab
có mã nhận dạng được chỉ định hoặc null
nếu không có Tab
nào như vậy.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Tabs()
Lấy tất cả Tab
chưa lồng nhau thuộc tài liệu.
Thẻ có thể chứa thẻ con, một thẻ lồng trong thẻ khác. Bạn có thể truy cập vào các thẻ con bằng Tab.getChildTabs()
.
Cầu thủ trả bóng
Tab[]
– Danh sách tất cả Tab
thuộc tài liệu.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Url()
Truy xuất URL để truy cập vào tài liệu hiện tại.
const doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());
Cầu thủ trả bóng
String
– URL để truy cập vào tài liệu hiện tại.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Viewers()
Lấy danh sách người xem và người nhận xét cho Document
này.
Cầu thủ trả bóng
User[]
– Mảng người dùng có quyền xem hoặc bình luận.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
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 tệp tham chiếu đến một vị trí trong thẻ, tương ứng với một phần tử cụ thể trong thẻ đầu tiên hoặc đối với các tập lệnh liên kết với một tài liệu, thẻ đang hoạt động. Để tạo một Position
tương ứng với một vị trí trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
. Con trỏ của người dùng được biểu thị dưới dạng Position
, cùng với các mục sử dụng khác.
// Append a paragraph to the active tab, then place the user's cursor after the // first word of the new paragraph. const doc = DocumentApp.getActiveDocument(); const paragraph = doc.getBody().appendParagraph('My new paragraph.'); const position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Tham số
Tên | Loại | Mô tả |
---|---|---|
element | Element | Phần tử chứa Position mới; đây phải là phần tử Text hoặc phần tử vùng chứa như Paragraph . |
offset | Integer | Đối với phần tử Text , số ký tự trước Position ; đối với các phần tử khác, số 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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
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ẻ trong thẻ đầu tiên hoặc đối với các tập lệnh được liên kết với một tài liệu, thẻ đang hoạt động. Để tạo một trình tạo dùng để tạo đối tượng Document
từ các phần tử thẻ trong bất kỳ thẻ nào, hãy sử dụng phương thức Document
.
// Change the user's selection to a range that includes every table in the // active tab. const doc = DocumentApp.getActiveDocument(); const rangeBuilder = doc.newRange(); const tables = doc.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 yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Editor(emailAddress)
Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho Document
. Phương thức này không chặn người dùng truy cập vào Document
nếu họ thuộc một lớp người dùng có quyền truy cập chung, ví dụ: nếu Document
được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document
nằm trong một ổ đĩa dùng chung mà người dùng có thể truy cập.
Đối với tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
email | String | Địa chỉ email của người dùng cần xoá. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Editor(user)
Xoá người dùng đã cho khỏi danh sách trình chỉnh sửa cho Document
. Phương thức này không chặn người dùng truy cập vào Document
nếu họ thuộc một lớp người dùng có quyền truy cập chung, ví dụ: nếu Document
được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document
nằm trong một ổ đĩa dùng chung mà người dùng có thể truy cập.
Đối với tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người xem.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Thông tin đại diện cho người dùng cần xoá. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Viewer(emailAddress)
Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho Document
. Phương thức này không có hiệu lực nếu người dùng là người chỉnh sửa, chứ không phải người xem hoặc người bình luận. Phương thức này cũng không chặn người dùng truy cập vào Document
nếu họ thuộc một lớp người dùng có quyền truy cập chung, ví dụ: nếu Document
được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document
nằm trong một bộ nhớ dùng chung mà người dùng có thể truy cập.
Đối với các tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người chỉnh sửa.
Tham số
Tên | Loại | Mô tả |
---|---|---|
email | String | Địa chỉ email của người dùng cần xoá. |
Cầu thủ trả bóng
Document
– Document
này để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Viewer(user)
Xoá người dùng đã cho khỏi danh sách người xem và người bình luận cho Document
. Phương thức này không có hiệu lực nếu người dùng là người chỉnh sửa, chứ không phải người xem. Phương thức này cũng không chặn người dùng truy cập vào Document
nếu họ thuộc một lớp người dùng có quyền truy cập chung, ví dụ: nếu Document
được chia sẻ với toàn bộ miền của người dùng hoặc nếu Document
nằm trong một ổ đĩa dùng chung mà người dùng có thể truy cập.
Đối với các tệp trên Drive, thao tác này cũng sẽ xoá người dùng khỏi danh sách người chỉnh sửa.
Tham số
Tên | Loại | Mô tả |
---|---|---|
user | User | Thông tin đại diện cho người dùng cần xoá. |
Cầu thủ trả bóng
Document
– Document
này để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
save And Close()
Lưu Document
hiện tại. Xoá và áp dụng các bản cập nhật đang chờ xử lý.
Phương thức save
được tự động gọi khi kết thúc quá trình thực thi tập lệnh
cho mỗi Document
có thể chỉnh sửa đang mở.
Không thể chỉnh sửa Document
đã đóng. Sử dụng Document
để mở lại một tài liệu nhất định để chỉnh sửa.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Active Tab(tabId)
Đặt Tab
đã chọn của người dùng trong tài liệu hiện tại thành thẻ có mã nhận dạng được chỉ định.
const doc = DocumentApp.getActiveDocument(); // Sets the user's selected tab by its ID. // TODO(developer): Replace the ID with your own. const tab = doc.setActiveTab('123abc');
Tham số
Tên | Loại | Mô tả |
---|---|---|
tab | String | Mã của thẻ cần đặt thành đang hoạt động. |
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Cursor(position)
Đặt con trỏ của người dùng, với Position
. Một tập lệnh chỉ có thể truy cập vào con trỏ của người dùng đang chạy tập lệnh và chỉ khi tập lệnh được liên kết với tài liệu.
Việc cung cấp Position
từ Tab
không hoạt động sẽ chuyển đổi thẻ đang hoạt động của người dùng.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the // new paragraph. const paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); const position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Tham số
Tên | Loại | Mô tả |
---|---|---|
position | Position | Vị trí con trỏ mới. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Language(languageCode)
Đặt mã ngôn ngữ của tài liệu. Đây là ngôn ngữ xuất hiện trong trình chỉnh sửa tài liệu File > Language (Tệp > Ngôn ngữ). Ngôn ngữ này có thể không phải là ngôn ngữ thực tế mà tài liệu chứa. Sử dụng get
để nhận tất cả mã ngôn ngữ hợp lệ.
Tham số
Tên | Loại | Mô tả |
---|---|---|
language | String | Mã ngôn ngữ. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Name(name)
Đặt tiêu đề tài liệu.
Tham số
Tên | Loại | Mô tả |
---|---|---|
name | String | Tiêu đề tài liệu mới. |
Cầu thủ trả bóng
Document
– Tài liệu hiện tại.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Selection(range)
Đặt lựa chọn của người dùng trong thẻ đang hoạt động, với Range
. Một tập lệnh chỉ có thể truy cập vào lựa chọn của người dùng đang chạy tập lệnh và chỉ khi tập lệnh đó được liên kết với tài liệu.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the // document. 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());
Tham số
Tên | Loại | Mô tả |
---|---|---|
range | Range | Dải ô mới của các phần tử cần chọn. |
Cầu thủ trả bóng
Document
— Document
này, để tạo chuỗi.
Ủy quyền
Các tập lệnh sử dụng phương thức này yêu cầu được uỷ quyền với một hoặc nhiều phạm vi sau:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents