Class InlineDrawing

InlineDrawing

代表嵌入繪圖的元素。InlineDrawing 可以包含在 ListItemParagraph,除非 ListItemParagraph 位於 FootnoteSectionInlineDrawing 本身不得包含任何其他元素。適用對象 如要進一步瞭解文件結構,請參閱擴充 Google 文件的指南

方法

方法傳回類型簡短說明
copy()InlineDrawing傳回目前元素的卸離的深度副本。
getAltDescription()String傳回繪圖的替代說明。
getAltTitle()String傳回繪圖的替代標題。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element擷取元素的下一個同層元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素先前的同層元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean決定元素是否位於 Document 的結尾。
merge()InlineDrawing將元素與前述同類型的同層合併。
removeFromParent()InlineDrawing從父項移除元素。
setAltDescription(description)InlineDrawing設定繪圖的替代說明。
setAltTitle(title)InlineDrawing設定繪圖的替代標題。
setAttributes(attributes)InlineDrawing設定元素的屬性。

內容詳盡的說明文件

copy()

傳回目前元素的卸離的深度副本。

系統也會複製元素中的所有子元素。新元素沒有 父項。

回攻員

InlineDrawing:新的副本。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAltDescription()

傳回繪圖的替代說明。

回攻員

String:替代標題;如果元素沒有替代標題,則為 null

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAltTitle()

傳回繪圖的替代標題。

回攻員

String:替代標題;如果元素沒有替代標題,則為 null

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAttributes()

擷取元素的屬性。

結果是物件,其中包含每個有效元素屬性的 屬性,其中每個 屬性名稱可對應至 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]);
}

回攻員

Object:元素的屬性。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getNextSibling()

擷取元素的下一個同層元素。

下一個同層有相同的父項,並且跟隨目前的元素。

回攻員

Element - 下一個同層元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getParent()

擷取元素的父項元素。

父項元素包含目前元素。

回攻員

ContainerElement:父項元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getPreviousSibling()

擷取元素先前的同層元素。

先前的同層有相同的父項,且在目前元素之前。

回攻員

Element:先前的同層元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getType()

擷取元素的 ElementType

使用 getType() 來判斷特定元素的確切類型。

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.');
}

回攻員

ElementType:元素類型,

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

isAtDocumentEnd()

決定元素是否位於 Document 的結尾。

回攻員

Boolean:元素是否位於分頁結尾。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

merge()

將元素與前述同類型的同層合併。

只能合併相同 ElementType 的元素。其中包含 目前元素會移至前一個同層元素。

系統隨即會從文件中移除目前的元素。

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

回攻員

InlineDrawing:合併的元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeFromParent()

從父項移除元素。

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();
}

回攻員

InlineDrawing:已移除的元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setAltDescription(description)

設定繪圖的替代說明。如果指定的標題為 null,請將 空白字串的說明。

參數

名稱類型說明
descriptionString替代標題

回攻員

InlineDrawing:目前的物件

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setAltTitle(title)

設定繪圖的替代標題。如果指定的標題為 null,請將標題設為 空字串。

參數

名稱類型說明
titleString替代標題

回攻員

InlineDrawing:目前的物件

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setAttributes(attributes)

設定元素的屬性。

指定的屬性參數必須是一個物件,而其中的每個屬性名稱都是一個項目 DocumentApp.Attribute 列舉,而每個屬性值都是要 已套用。

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

參數

名稱類型說明
attributesObject元素的屬性。

回攻員

InlineDrawing:目前的元素。

授權

使用這個方法的指令碼需要下列一或多個範圍的授權:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents