Tham chiếu đến một vị trí trong thẻ tài liệu, so 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
, cùng với các mục đích 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 bị ràng buộc 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 | Loại 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 vị trí đó. |
getSurroundingText() | Text | Tạo 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 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 giá trị bù trừ 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ừ hình ảnh được chỉ định
blob. |
insertText(text) | Text | Chèn văn bản đã 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à Text
hoặc phần tử vùng chứa như Paragraph
. Trong cả hai trường hợp, giá trị tương đối
vị trí trong phần tử có thể được xác định bằng getOffset()
.
Cầu thủ trả bóng
Element
– vùng chứa hoặc phần tử Text
nơi đặt đố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 vị trí đó. Nếu
phần tử là một phần tử Text
, độ lệch là số ký tự trước Position
(tức là chỉ mục của ký tự sau Position
này); cho bất kỳ thiết bị nào khác
thì độ 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 (tức 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
, là số ký tự trước Position
này; với
các phần tử khác, số lượng 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 yêu cầu ủy 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 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
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 lệnh gọi editAsText()
trên 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 yêu cầu ủy 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 giá trị bù trừ của Position
này trong phần tử Text
do getSurroundingText()
trả về. Mức chênh lệch là số ký tự trước Position
(tức 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 phần tử con
Ủy quyền
Tập lệnh sử dụng phương thức này yêu cầu ủy 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ừ hình ảnh được chỉ định
blob.
Tham số
Tên | Loại | Mô tả |
---|---|---|
image | BlobSource | dữ liệu hình ảnh để chèn tại 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
đã xác định vị trí 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 yêu cầu ủy 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 đã chỉ định tại Position
này. Phương thức này tạo một Text
mới
ngay cả khi chuỗi được chèn trong một phần tử Text
hiện có, để
dễ dàng tạo kiểu cho phần tử mới.
Tham số
Tên | Loại | Mô tả |
---|---|---|
text | String | chuỗi cần chèn tại Position này |
Cầu thủ trả bóng
Text
– thành phần văn bản mới hoặc null
nếu phần tử chứa Position
này
Vị trí 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 yêu cầu ủy 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