İçindekiler tablosu içeren bir öğe. Bir TableOfContents
; ListItem
, Paragraph
ve Table
öğelerini içerebilir ancak TableOfContents
öğesinin içeriği genellikle Google Dokümanlar tarafından otomatik olarak oluşturulur. Daha fazla bilgi için
hakkında daha fazla bilgi edinmek için
Dokümanlar'ın kapsamını genişletme.
Yöntemler
Yöntem | Dönüş türü | Kısa açıklama |
---|---|---|
clear() | TableOfContents | Öğenin içeriğini temizler. |
copy() | TableOfContents | Geçerli öğenin ayrılmış, derin bir kopyasını döndürür. |
editAsText() | Text | Düzenleme için geçerli öğenin Text sürümünü alır. |
findElement(elementType) | RangeElement | Öğenin içeriğinde, belirtilen türün bir alt öğesini arar. |
findElement(elementType, from) | RangeElement | Öğenin içeriğinde,
belirtilen RangeElement . |
findText(searchPattern) | RangeElement | Normal ifadeler kullanarak belirtilen metin kalıbı için öğenin içeriğinde arama yapar. |
findText(searchPattern, from) | RangeElement | Belirli bir değerden başlayarak belirtilen metin kalıbı için öğenin içeriğinde arama yapar emin olun. |
getAttributes() | Object | Öğenin özelliklerini alır. |
getChild(childIndex) | Element | Belirtilen alt dizindeki alt öğeyi alır. |
getChildIndex(child) | Integer | Belirtilen alt öğe için alt dizini alır. |
getLinkUrl() | String | Bağlantı URL'sini alır. |
getNextSibling() | Element | Öğenin sonraki eşdüzey öğeyi alır. |
getNumChildren() | Integer | Alt öğelerin sayısını alır. |
getParent() | ContainerElement | Öğenin üst öğesini alır. |
getPreviousSibling() | Element | Öğenin önceki eşdüzey öğesini alır. |
getText() | String | Öğenin içeriğini bir metin dizesi olarak alır. |
getTextAlignment() | TextAlignment | Metin hizalamasını getirir. |
getType() | ElementType | Öğenin ElementType değerini alır. |
isAtDocumentEnd() | Boolean | Öğenin, Document öğesinin sonunda olup olmadığını belirler. |
removeFromParent() | TableOfContents | Öğeyi üst öğesinden kaldırır. |
replaceText(searchPattern, replacement) | Element | Belirli bir metin kalıbının tüm tekrarlarını, normal değer kullanarak belirli bir değiştirme dizesiyle değiştirir ifade eder. |
setAttributes(attributes) | TableOfContents | Öğenin özelliklerini ayarlar. |
setLinkUrl(url) | TableOfContents | Bağlantı URL'sini ayarlar. |
setTextAlignment(textAlignment) | TableOfContents | Metin hizalamasını ayarlar. |
Ayrıntılı belgeler
clear()
copy()
Geçerli öğenin ayrılmış, derin bir kopyasını döndürür.
Öğede bulunan tüm alt öğeler de kopyalanır. Yeni öğede üst öğesidir.
Return
TableOfContents
— Yeni kopya.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Düzenleme için geçerli öğenin Text
sürümünü alır.
Öğe içeriklerini zengin metin olarak değiştirmek için editAsText
kullanın. editAsText
modu, metin olmayan öğeleri (InlineImage
ve HorizontalRule
gibi) yoksayar.
Silinmiş bir metin aralığında tamamen yer alan alt öğeler öğeden kaldırılır.
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);
Return
Text
: Geçerli öğenin metin sürümü
findElement(elementType)
Öğenin içeriğinde, belirtilen türün bir alt öğesini arar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
elementType | ElementType | Aranacak öğenin türü. |
Return
RangeElement
: Arama öğesinin konumunu gösteren bir arama sonucu.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Öğenin içeriğinde,
belirtilen RangeElement
.
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; } }
Parametreler
Ad | Tür | Açıklama |
---|---|---|
elementType | ElementType | Aranacak öğenin türü. |
from | RangeElement | Arama yapılacak arama sonucu. |
Return
RangeElement
: Arama öğesinin sonraki konumunu gösteren arama sonucu.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Normal ifadeler kullanarak belirtilen metin kalıbı için öğenin içeriğinde arama yapar.
JavaScript normal ifade özelliklerinin bir alt kümesi tam olarak desteklenmiyor; örneğin, ve mod değiştiricileri yakalayabilirsiniz.
Sağlanan normal ifade kalıbı her metin bloğuyla bağımsız olarak eşleştirilir öğedir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
searchPattern | String | aranacak kalıp |
Return
RangeElement
— arama metninin konumunu veya konumunu gösteren bir arama sonucu yoksa null
denk gelmek
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Belirli bir değerden başlayarak belirtilen metin kalıbı için öğenin içeriğinde arama yapar emin olun.
JavaScript normal ifade özelliklerinin bir alt kümesi tam olarak desteklenmiyor; örneğin, ve mod değiştiricileri yakalayabilirsiniz.
Sağlanan normal ifade kalıbı her metin bloğuyla bağımsız olarak eşleştirilir öğedir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
searchPattern | String | aranacak kalıp |
from | RangeElement | arama sonuçlarında |
Return
RangeElement
— arama metninin sonraki konumunu gösteren bir arama sonucu veya
denk gelmek
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Öğenin özelliklerini alır.
Sonuç, her bir geçerli öğe özelliği için bir özellik içeren
özellik adı, DocumentApp.Attribute
numaralandırmasındaki bir öğeye karşılık gelir.
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]); }
Return
Object
: Öğenin özellikleri.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Belirtilen alt dizindeki alt öğeyi alır.
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."); }
Parametreler
Ad | Tür | Açıklama |
---|---|---|
childIndex | Integer | Alınacak alt öğenin dizini. |
Return
Element
: Belirtilen dizindeki alt öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Belirtilen alt öğe için alt dizini alır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
child | Element | Dizinin alınacağı alt öğe. |
Return
Integer
— Alt dizin.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Bağlantı URL'sini alır.
Return
String
: bağlantı URL'si veya öğe bu özellik için birden fazla değer içeriyorsa null
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Öğenin sonraki eşdüzey öğeyi alır.
Sonraki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeyi takip eder.
Return
Element
: Sonraki kardeş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Alt öğelerin sayısını alır.
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.");
Return
Integer
— Alt öğelerin sayısı.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Öğenin üst öğesini alır.
Üst öğe, geçerli öğeyi içeriyor.
Return
ContainerElement
: Üst öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Öğenin önceki eşdüzey öğesini alır.
Önceki eşdüzey öğe, aynı üst öğeye sahip ve geçerli öğeden önce geliyor.
Return
Element
: Önceki kardeş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Öğenin içeriğini bir metin dizesi olarak alır.
Return
String
: Metin dizesi olarak öğenin içeriği
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Metin hizalamasını getirir. Kullanılabilir hizalama türleri şunlardır: DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
ve DocumentApp.TextAlignment.SUPERSCRIPT
.
Return
TextAlignment
: Metin hizalamasının türü veya metin birden fazla metin türü içeriyorsa null
veya metin hizalaması hiç ayarlanmamışsa
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Öğenin ElementType
değerini alır.
Belirli bir öğenin tam türünü belirlemek için getType()
işlevini kullanın.
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.'); }
Return
ElementType
: Öğe türü.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Öğenin, Document
öğesinin sonunda olup olmadığını belirler.
Return
Boolean
— Öğenin sekmenin sonunda olup olmadığı.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Öğeyi üst öğesinden kaldırır.
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(); }
Return
TableOfContents
: Kaldırılan öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Belirli bir metin kalıbının tüm tekrarlarını, normal değer kullanarak belirli bir değiştirme dizesiyle değiştirir ifade eder.
Arama kalıbı, JavaScript normal ifade nesnesi değil, dize olarak iletilir. Bu nedenle, kalıptaki ters eğik çizgilerden kaçınmanız gerekir.
Bu yöntemler, Google'ın normal RE2 desteklenen söz dizimini sınırlayan ifade kitaplığı için kullanılır.
Sağlanan normal ifade kalıbı her metin bloğuyla bağımsız olarak eşleştirilir öğedir.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parametreler
Ad | Tür | Açıklama |
---|---|---|
searchPattern | String | aranacak normal ifade kalıbı |
replacement | String | yerine kullanılacak metin |
Return
Element
- geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Öğenin özelliklerini ayarlar.
Belirtilen özellikler parametresi, her özellik adının
DocumentApp.Attribute
sıralaması ve her özellik değeri,
geçerlidir.
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);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
attributes | Object | Öğenin özellikleri. |
Return
TableOfContents
: Geçerli öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Bağlantı URL'sini ayarlar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
url | String | bağlantı URL'si |
Return
TableOfContents
- geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Metin hizalamasını ayarlar. Kullanılabilir hizalama türleri şunlardır: DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
ve DocumentApp.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);
Parametreler
Ad | Tür | Açıklama |
---|---|---|
textAlignment | TextAlignment | uygulanacak metin hizalamasının türü |
Return
TableOfContents
- geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents