Class HorizontalRule

HorizontalRule

Một phần tử đại diện cho đường kẻ ngang. HorizontalRule có thể nằm trong ListItem hoặc Paragraph, nhưng bản thân không thể chứa bất kỳ phần tử nào khác. Để biết thêm thông tin về cấu trúc tài liệu, hãy xem hướng dẫn về cách mở rộng Google Tài liệu.

Phương thức

Phương thứcKiểu dữ liệu trả vềMô tả ngắn
copy()HorizontalRuleTrả về một bản sao sâu, tách biệt của phần tử hiện tại.
getAttributes()ObjectTruy xuất các thuộc tính của phần tử.
getNextSibling()Element|nullTruy xuất phần tử anh chị em tiếp theo của phần tử.
getParent()ContainerElement|nullTruy xuất phần tử mẹ của phần tử.
getPreviousSibling()Element|nullTruy xuất phần tử anh chị em trước đó của phần tử.
getType()ElementTypeTruy xuất ElementType của phần tử.
isAtDocumentEnd()BooleanXác định xem phần tử có ở cuối Document hay không.
removeFromParent()HorizontalRule|nullXoá phần tử khỏi phần tử mẹ.
setAttributes(attributes)HorizontalRuleĐặt các thuộc tính của phần tử.

Tài liệu chi tiết

copy()

Trả về một bản sao sâu, tách biệt của phần tử hiện tại.

Mọi phần tử con có trong phần tử cũng sẽ được sao chép. Phần tử mới không có phần tử mẹ.

Cầu thủ trả bóng

HorizontalRule – Bản sao mới.

Ủy quyền

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

getAttributes()

Truy xuất các thuộc tính của phần tử.

Kết quả là một đối tượng chứa một thuộc tính cho mỗi thuộc tính hợp lệ của phần tử, trong đó mỗi tên thuộc tính tương ứng với một mục trong kiểu liệt kê DocumentApp.Attribute. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Cầu thủ trả bóng

Object – Các thuộc tính của phần tử.

Ủy quyền

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

getNextSibling()

Truy xuất phần tử anh chị em tiếp theo của phần tử.

Phần tử anh chị em tiếp theo có cùng phần tử mẹ và đứng sau phần tử hiện tại.

Cầu thủ trả bóng

Element|null – Phần tử anh chị em tiếp theo.

Ủy quyền

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

getParent()

Truy xuất phần tử mẹ của phần tử.

Phần tử mẹ chứa phần tử hiện tại.

Cầu thủ trả bóng

ContainerElement|null – Phần tử mẹ.

Ủy quyền

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

getPreviousSibling()

Truy xuất phần tử anh chị em trước đó của phần tử.

Phần tử anh chị em trước đó có cùng phần tử mẹ và đứng trước phần tử hiện tại.

Cầu thủ trả bóng

Element|null – Phần tử anh chị em trước đó.

Ủy quyền

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

getType()

Truy xuất ElementType của phần tử.

Sử dụng getType() để xác định chính xác loại của một phần tử nhất định. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Cầu thủ trả bóng

ElementType – Loại phần tử.

Ủy quyền

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

isAtDocumentEnd()

Xác định xem phần tử có ở cuối Document hay không.

Cầu thủ trả bóng

Boolean – Phần tử có ở cuối thẻ hay không.

Ủy quyền

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

removeFromParent()

Xoá phần tử khỏi phần tử mẹ. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Cầu thủ trả bóng

HorizontalRule|null – Phần tử đã xoá.

Ủy quyền

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

setAttributes(attributes)

Đặt các thuộc tính của phần tử.

Tham số thuộc tính được chỉ định phải là một đối tượng, trong đó mỗi tên thuộc tính là một mục trong kiểu liệt kê DocumentApp.Attribute và mỗi giá trị thuộc tính là giá trị mới cần áp dụng. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Tham số

TênLoạiMô tả
attributesObjectCác thuộc tính của phần tử.

Cầu thủ trả bóng

HorizontalRule – Phần tử hiện tại.

Ủy quyền

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