Class Position

Vị trí

Một tham chiếu đến vị trí trong thẻ tài liệu, 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. 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.');
}

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
getElement()ElementLấy phần tử chứa Position này.
getOffset()IntegerLấy vị trí tương đối của Position này trong phần tử chứa nó.
getSurroundingText()TextTạ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 chứa Position, trực tiếp hoặc thông qua một chuỗi các phần tử con.
getSurroundingTextOffset()IntegerLấy độ lệch của Position này trong phần tử Text do getSurroundingText() trả về.
insertBookmark()BookmarkTạo và chèn một Bookmark mới tại Position này.
insertInlineImage(image)InlineImage|nullTạo và chèn một InlineImage mới tại Position này từ blob hình ảnh đã chỉ định.
insertText(text)Text|nullChè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à một phần tử Text hoặc một 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 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 nó. Nếu phần tử là phần tử Text, thì độ lệch là số ký tự trước Position (tức là chỉ mục của ký tự sau Position này); đối với bất kỳ phần tử nào khác, độ 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, số lượng ký tự trước Position này; đối 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

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

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 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 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

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

getSurroundingTextOffset()

Lấy độ lệch của Position này trong phần tử Text do getSurroundingText() trả về. Độ 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 các phần tử 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

insertBookmark()

Tạo và chèn một Bookmark mới tại Position này.

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

insertInlineImage(image)

Tạo và chèn một InlineImage mới tại Position này từ blob hình ảnh đã chỉ định.

Thông số

TênLoạiMô tả
imageBlobSourcedữ liệu hình ảnh cần chèn vào Position này

Cầu thủ trả bóng

InlineImage|null – phần tử hình ảnh mới hoặc null nếu phần tử mà Position này nằm trong đó không cho phép chèn hình ả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

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 phần tử Text mới, ngay cả khi chuỗi được chèn vào trong một phần tử Text hiện có, để bạn dễ dàng tạo kiểu cho phần tử mới.

Thông số

TênLoạiMô tả
textStringchuỗi cần chèn vào Position này

Cầu thủ trả bóng

Text|null – phần tử văn bản mới hoặc null nếu phần tử mà Position này nằm trong đó không cho phép chèn 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