Tham chiếu đến một vị trí trong tài liệu, liên quan đến một thành phần cụ thể. Con trỏ của người dùng được biểu thị dưới dạng Position
, bên cạnh các trường hợp sử dụng khác. Tập lệnh chỉ có thể truy cập 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. var 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. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Phương thức
Phương thức | Kiểu dữ liệu trả về | Mô tả ngắn |
---|---|---|
getElement() | Element | Lấy phần tử chứa Position này. |
getOffset() | Integer | Lấy vị trí tương đối của Position này trong phần tử chứa nó. |
getSurroundingText() | Text | Tạo một phần tử Text nhân tạo đại diện cho văn bản và định dạng của Paragraph hoặc ListItem có chứa Position , trực tiếp hoặc thông qua một chuỗi các phần tử con. |
getSurroundingTextOffset() | Integer | Lấy độ lệch của Position này trong phần tử Text do getSurroundingText() trả về. |
insertBookmark() | Bookmark | Tạo và chèn một Bookmark mới tại Position này. |
insertInlineImage(image) | InlineImage | Tạo và chèn một InlineImage mới tại Position này từ blob hình ảnh được chỉ định. |
insertText(text) | Text | Chèn văn bản được chỉ định tại Position này. |
Tài liệu chi tiết
getElement()
Lấy phần tử chứa Position
này. Đây sẽ là phần tử Text
hoặc phần tử vùng chứa như Paragraph
. Trong cả hai trường hợp, bạn có thể xác định vị trí tương đối trong phần tử bằng getOffset()
.
Cầu thủ trả bóng
Element
— vùng chứa hoặc phần tử Text
chứa đối tượng Position
này
getOffset()
Lấy vị trí tương đối của Position
này trong phần tử chứa nó. Nếu phần tử là phần tử Text
, thì độ lệch sẽ là số ký tự trước Position
(tức là chỉ mục của ký tự sau Position
này); đối với mọi phần tử khác, mức chênh lệch là số phần tử con trước Position
này trong cùng một phần tử vùng chứa (nghĩa là chỉ mục của phần tử con sau Position
).
Cầu thủ trả bóng
Integer
– đối với các phần tử Text
, số lượng ký tự trước Position
này; đối với các phần tử khác, số lượng các phần tử con trước Position
này trong cùng một
phần tử vùng chứa
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
getSurroundingText()
Tạo một phần tử Text
nhân tạo đại diện cho văn bản và định dạng của Paragraph
hoặc ListItem
có chứa Position
, trực tiếp hoặc thông qua một chuỗi các phần tử con. Để xác định độ lệch của Position
trong phần tử Text
được trả về, hãy sử dụng getSurroundingTextOffset()
.
Cầu thủ trả bóng
Text
– một phần tử tương đương với kết quả của việc gọi editAsText()
trên Paragraph
hoặc ListItem
có chứa Position
, trực tiếp hoặc thông qua một chuỗi các phần tử con
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
getSurroundingTextOffset()
Lấy độ lệch của Position
này trong phần tử Text
do getSurroundingText()
trả về. Chênh lệch là số ký tự trước Position
(nghĩa là chỉ mục của ký tự sau Position
này).
Cầu thủ trả bóng
Integer
– số ký tự trước Position
này trong Paragraph
hoặc ListItem
chứa Position
, trực tiếp hoặc thông qua một chuỗi các phần tử con
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
insertBookmark()
insertInlineImage(image)
Tạo và chèn một InlineImage
mới tại Position
này từ blob hình ảnh được chỉ định.
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
image | BlobSource | dữ liệu hình ảnh để chèn vào Position này |
Cầu thủ trả bóng
InlineImage
– phần tử hình ảnh mới hoặc null
nếu phần tử chứa Position
này không cho phép chèn hình ảnh
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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
insertText(text)
Chèn văn bản được chỉ định tại Position
này. Phương thức này tạo ra một phần tử Text
mới, ngay cả khi chuỗi được chèn trong phần tử Text
hiện có, để bạn có thể dễ dàng tạo kiểu cho phần tử mới.
Các tham số
Tên | Loại | Nội dung mô tả |
---|---|---|
text | String | chuỗi cần chèn vào Position này |
Cầu thủ trả bóng
Text
– phần tử văn bản mới hoặc null
nếu phần tử chứa Position
này không cho phép chèn văn bản
Ủy quyền
Tập lệnh sử dụng phương thức này cần đượ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