Class TableOfContents

TableOfContents

Một phần tử chứa mục lục. TableOfContents có thể chứa các phần tử ListItem, ParagraphTable, mặc dù nội dung của TableOfContents thường do Google Tài liệu tạo tự động. Để biết thêm thông tin về cấu trúc tài liệu, xem hướng dẫn để mở rộng Google Tài liệu.

Phương thức

Phương thứcLoại dữ liệu trả vềMô tả ngắn
clear()TableOfContentsXoá nội dung của phần tử.
copy()TableOfContentsTrả về một bản sao sâu, tách biệt của phần tử hiện tại.
editAsText()TextLấy phiên bản Text của phần tử hiện tại để chỉnh sửa.
findElement(elementType)RangeElementTìm kiếm nội dung của phần tử cho thành phần con của loại đã chỉ định.
findElement(elementType, from)RangeElementTìm kiếm nội dung của phần tử cho thành phần con của loại đã chỉ định, bắt đầu từ RangeElement được chỉ định.
findText(searchPattern)RangeElementTìm kiếm nội dung của phần tử cho mẫu văn bản được chỉ định bằng cách sử dụng biểu thức chính quy.
findText(searchPattern, from)RangeElementTìm kiếm nội dung của phần tử cho mẫu văn bản được chỉ định, bắt đầu từ một mẫu văn bản cho trước kết quả tìm kiếm.
getAttributes()ObjectTruy xuất các thuộc tính của phần tử.
getChild(childIndex)ElementTruy xuất phần tử con tại chỉ mục con đã chỉ định.
getChildIndex(child)IntegerTruy xuất chỉ mục con cho phần tử con được chỉ định.
getLinkUrl()StringTruy xuất URL của đường liên kết.
getNextSibling()ElementTruy xuất phần tử đồng cấp tiếp theo của phần tử đó.
getNumChildren()IntegerTruy xuất số phần tử con.
getParent()ContainerElementTruy xuất phần tử mẹ của phần tử đó.
getPreviousSibling()ElementTruy xuất phần tử đồng cấp trước đó của phần tử.
getText()StringTruy xuất nội dung của phần tử dưới dạng chuỗi văn bản.
getTextAlignment()TextAlignmentXem cách căn chỉnh văn bản.
getType()ElementTypeTruy xuất ElementType của phần tử.
isAtDocumentEnd()BooleanXác định xem phần tử có nằm ở cuối Document hay không.
removeFromParent()TableOfContentsXoá phần tử khỏi phần tử mẹ.
replaceText(searchPattern, replacement)ElementThay thế tất cả các lần xuất hiện của một mẫu văn bản cho trước bằng một chuỗi thay thế cho trước, sử dụng thông thường biểu thức.
setAttributes(attributes)TableOfContentsThiết lập các thuộc tính của phần tử.
setLinkUrl(url)TableOfContentsĐặt URL của đường liên kết.
setTextAlignment(textAlignment)TableOfContentsĐặt căn chỉnh văn bản.

Tài liệu chi tiết

clear()

Xoá nội dung của phần tử.

Cầu thủ trả bóng

TableOfContents — Phần tử hiện tại.


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 được sao chép. Phần tử mới không có cha mẹ.

Cầu thủ trả bóng

TableOfContents — Bản sao mới.

Ủ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

editAsText()

Lấy phiên bản Text của phần tử hiện tại để chỉnh sửa.

Sử dụng editAsText để chỉnh sửa nội dung các phần tử ở dạng văn bản đa dạng thức. Chế độ editAsText bỏ qua các phần tử không phải văn bản (chẳng hạn như InlineImageHorizontalRule).

Các phần tử con nằm hoàn toàn trong một dải ô văn bản đã bị xoá sẽ bị xoá khỏi phần tử đó.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Cầu thủ trả bóng

Text – phiên bản văn bản của phần tử hiện tại


findElement(elementType)

Tìm kiếm nội dung của phần tử cho thành phần con của loại đã chỉ định.

Tham số

TênLoạiMô tả
elementTypeElementTypeLoại phần tử cần tìm kiếm.

Cầu thủ trả bóng

RangeElement – Một kết quả tìm kiếm cho biết vị trí của phần tử tìm kiếm.

Ủ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

findElement(elementType, from)

Tìm kiếm nội dung của phần tử cho thành phần con của loại đã chỉ định, bắt đầu từ RangeElement được chỉ định.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Tham số

TênLoạiMô tả
elementTypeElementTypeLoại phần tử cần tìm kiếm.
fromRangeElementKết quả tìm kiếm để tìm kiếm.

Cầu thủ trả bóng

RangeElement – Một kết quả tìm kiếm cho biết vị trí tiếp theo của phần tử tìm kiếm.

Ủ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

findText(searchPattern)

Tìm kiếm nội dung của phần tử cho mẫu văn bản được chỉ định bằng cách sử dụng biểu thức chính quy.

Một số tính năng trong biểu thức chính quy JavaScript không được hỗ trợ đầy đủ, chẳng hạn như nhóm thu thập và đối tượng sửa đổi chế độ.

Mẫu biểu thức chính quy đã cho được so khớp độc lập với từng khối văn bản có trong phần tử hiện tại.

Tham số

TênLoạiMô tả
searchPatternStringmẫu tìm kiếm

Cầu thủ trả bóng

RangeElement – một kết quả tìm kiếm cho biết vị trí của văn bản tìm kiếm hoặc rỗng nếu không có văn bản khớp

Ủ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

findText(searchPattern, from)

Tìm kiếm nội dung của phần tử cho mẫu văn bản được chỉ định, bắt đầu từ một mẫu văn bản cho trước kết quả tìm kiếm.

Một số tính năng trong biểu thức chính quy JavaScript không được hỗ trợ đầy đủ, chẳng hạn như nhóm thu thập và đối tượng sửa đổi chế độ.

Mẫu biểu thức chính quy đã cho được so khớp độc lập với từng khối văn bản có trong phần tử hiện tại.

Tham số

TênLoạiMô tả
searchPatternStringmẫu tìm kiếm
fromRangeElementkết quả tìm kiếm để tìm kiếm

Cầu thủ trả bóng

RangeElement – một kết quả tìm kiếm cho biết vị trí tiếp theo của văn bản tìm kiếm, hoặc rỗng nếu không có khớp

Ủ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

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 từng thuộc tính phần tử hợp lệ, trong đó mỗi thuộc tính tên thuộc tính tương ứng với một mục trong bản liệt kê DocumentApp.Attribute.

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

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

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

// Log the paragraph attributes.
for (var 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 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

getChild(childIndex)

Truy xuất phần tử con tại chỉ mục con đã chỉ định.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

Tham số

TênLoạiMô tả
childIndexIntegerChỉ mục của phần tử con cần truy xuất.

Cầu thủ trả bóng

Element – Phần tử con trong chỉ mục đã chỉ đị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

getChildIndex(child)

Truy xuất chỉ mục con cho phần tử con được chỉ định.

Tham số

TênLoạiMô tả
childElementPhần tử con để truy xuất chỉ mục.

Cầu thủ trả bóng

Integer — Chỉ mục 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

getLinkUrl()

Truy xuất URL của đường liên kết.

Cầu thủ trả bóng

String — URL liên kết hoặc rỗng nếu phần tử chứa nhiều giá trị cho thuộc tính này

Ủ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

getNextSibling()

Truy xuất phần tử đồng cấp tiếp theo của phần tử đó.

Phần tử đồng cấp tiếp theo có cùng phần tử mẹ và theo sau phần tử hiện tại.

Cầu thủ trả bóng

Element – Phần tử đồng cấp tiếp theo.

Ủ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

getNumChildren()

Truy xuất số phần tử con.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log("There are " + body.getNumChildren() +
    " elements in the tab's body.");

Cầu thủ trả bóng

Integer — Số lượng trẻ em.

Ủ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

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 – Phần tử mẹ.

Ủ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

getPreviousSibling()

Truy xuất phần tử đồng cấp trước đó của phần tử.

Phần tử đồng cấp 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 – Phần tử đồng cấp trước đó.

Ủ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

getText()

Truy xuất nội dung của phần tử dưới dạng chuỗi văn bản.

Cầu thủ trả bóng

String – nội dung của phần tử dưới dạng chuỗi 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

getTextAlignment()

Xem cách căn chỉnh văn bản. Các kiểu căn chỉnh hiện có thể dùng là DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT.

Cầu thủ trả bóng

TextAlignment – loại căn chỉnh văn bản hoặc null nếu văn bản chứa nhiều loại văn bản hoặc nếu căn chỉnh văn bản chưa bao giờ được đặt

Ủ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

getType()

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

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

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

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

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

isAtDocumentEnd()

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

Cầu thủ trả bóng

Boolean – Liệu phần tử này có nằm ở cuối thẻ hay không.

Ủ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

removeFromParent()

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

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

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

Cầu thủ trả bóng

TableOfContents – Phần tử đã bị xoá.

Ủ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

replaceText(searchPattern, replacement)

Thay thế tất cả các lần xuất hiện của một mẫu văn bản cho trước bằng một chuỗi thay thế cho trước, sử dụng thông thường biểu thức.

Mẫu tìm kiếm được chuyển dưới dạng chuỗi, không phải là đối tượng biểu thức chính quy JavaScript. Do đó, bạn cần thoát khỏi mọi dấu gạch chéo ngược trong mẫu.

Phương thức này sử dụng mã thông thường RE2 của Google thư viện biểu thức để giới hạn cú pháp được hỗ trợ.

Mẫu biểu thức chính quy đã cho được so khớp độc lập với từng khối văn bản có trong phần tử hiện tại.

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

Tham số

TênLoạiMô tả
searchPatternStringmẫu biểu thức chính quy để tìm kiếm
replacementStringvăn bản để sử dụng để thay thế

Cầu thủ trả bóng

Element – phần tử hiện tại

Ủ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

setAttributes(attributes)

Thiết lập các thuộc tính của phần tử.

Thông 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 bản liệt kê DocumentApp.Attribute và mỗi giá trị thuộc tính là một giá trị mới áp dụng.

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

// Define a custom paragraph style.
var 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.
var 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

TableOfContents — Phần tử hiện tại.

Ủ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

setLinkUrl(url)

Đặt URL của đường liên kết.

Tham số

TênLoạiMô tả
urlStringURL của đường liên kết

Cầu thủ trả bóng

TableOfContents – phần tử hiện tại

Ủ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

setTextAlignment(textAlignment)

Đặt căn chỉnh văn bản. Các kiểu căn chỉnh hiện có thể dùng là DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Tham số

TênLoạiMô tả
textAlignmentTextAlignmentloại căn chỉnh văn bản sẽ áp dụng

Cầu thủ trả bóng

TableOfContents – phần tử hiện tại

Ủ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