Liste öğesini temsil eden bir öğe. ListItem, bir liste kimliğiyle ilişkilendirilmiş Paragraph'dir. ListItem öğesi Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak ve Text öğelerini içerebilir. Belge yapısı hakkında daha fazla bilgi için Google Dokümanlar'ı genişletme rehberine bakın.
ListItems yeni satır karakterleri içeremez. Yeni satır karakterleri ("\n") satır sonu karakterlerine ("\r") dönüştürülür.
Aynı liste kimliğine sahip ListItems, aynı listeye aittir ve buna göre numaralandırılır.
Belirli bir liste için ListItems öğelerinin sekmede bitişik olması veya aynı üst öğeye sahip olması gerekmez. Aynı listeye ait iki öğe, aşağıdaki örnekte gösterildiği gibi, sekmede herhangi bir yerde bulunabilir ancak sıralı numaralandırma korunur:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Yöntemler
| Yöntem | Dönüş türü | Kısa açıklama |
|---|---|---|
add | Positioned | Belirtilen resim blob'undan yeni bir Positioned oluşturup ekler. |
append | Horizontal | Yeni bir Horizontal oluşturur ve ekler. |
append | Inline | Belirtilen resim blob'undan yeni bir Inline oluşturur ve ekler. |
append | Inline | Belirtilen Inline eklenir. |
append | Page | Yeni bir Page oluşturur ve ekler. |
append | Page | Belirtilen Page eklenir. |
append | Text | Belirtilen içeriklerle yeni bir Text öğesi oluşturur ve ekler. |
append | Text | Belirtilen Text öğesini ekler. |
clear() | List | Öğenin içeriğini temizler. |
copy() | List | Geçerli öğenin ayrılmış, derin bir kopyasını döndürür. |
edit | Text | Düzenlemek için mevcut öğenin Text sürümünü alır. |
find | Range | Öğenin içeriğinde, belirtilen türde bir alt öğe arar. |
find | Range | Belirtilen Range ile başlayarak, belirtilen türde bir alt öğe için öğenin içeriğini arar. |
find | Range | Normal ifadeleri kullanarak öğenin içeriğinde belirtilen metin kalıbını arar. |
find | Range | Belirtilen metin kalıbını, belirli bir arama sonucundan başlayarak öğenin içeriğinde arar. |
get | Horizontal | Horizontal öğesini alır. |
get | Object | Öğenin özelliklerini alır. |
get | Element | Belirtilen alt dizindeki alt öğeyi alır. |
get | Integer | Belirtilen alt öğenin alt dizinini alır. |
get | Glyph | Liste öğesinin Glyph değerini alır. |
get | Paragraph | Paragraph öğesini alır. |
get | Number|null | Son girintiyi puan cinsinden alır. |
get | Number|null | İlk satır girintisini puan cinsinden alır. |
get | Number|null | Başlangıç girintisini alır. |
get | Number|null | Satır aralığını puan cinsinden alır. |
get | String|null | Bağlantı URL'sini alır. |
get | String|null | Liste kimliğini alır. |
get | Integer | Liste öğesinin iç içe yerleştirme düzeyini alır. |
get | Element|null | Öğenin sonraki kardeş öğesini alır. |
get | Integer | Çocuk sayısını alır. |
get | Container | Öğenin üst öğesini alır. |
get | Positioned | Görüntünün kimliğine göre Positioned alır. |
get | Positioned | Paragrafa sabitlenmiş tüm Positioned nesnelerini alır. |
get | Element|null | Öğenin önceki kardeş öğesini alır. |
get | Number|null | Öğeden sonraki aralığı punto cinsinden alır. |
get | Number|null | Öğeden önceki aralığı punto cinsinden alır. |
get | String | Öğenin içeriğini metin dizesi olarak alır. |
get | Text | Metin hizalamasını alır. |
get | Element | Öğenin Element değerini alır. |
insert | Horizontal | Belirtilen dizinde bir Horizontal oluşturur ve ekler. |
insert | Inline | Belirtilen resim blob'undan belirtilen dizinde yeni bir Inline oluşturup ekler. |
insert | Inline | Belirtilen dizine verilen Inline öğesini ekler. |
insert | Page | Belirtilen dizinde yeni bir Page oluşturur ve ekler. |
insert | Page | Belirtilen dizine verilen Page öğesini ekler. |
insert | Text | Belirtilen dizinde yeni bir metin öğesi oluşturur ve ekler. |
insert | Text | Belirtilen Text öğesini, belirtilen metin içerikleriyle birlikte belirtilen dizine ekler. |
is | Boolean | Öğenin Document sonunda olup olmadığını belirler. |
is | Boolean|null | Soldan sağa ayarını alır. |
merge() | List | Öğeyi, aynı türdeki önceki kardeş öğeyle birleştirir. |
remove | List | Belirtilen alt öğeyi kaldırır. |
remove | List | Öğeyi üst öğesinden kaldırır. |
remove | Boolean | Resmin kimliğine göre Positioned kaldırır. |
replace | Element | Normal ifadeleri kullanarak belirli bir metin kalıbının tüm örneklerini belirli bir yeni dizeyle değiştirir. |
set | List | Horizontal değerini ayarlar. |
set | List | Öğenin özelliklerini ayarlar. |
set | List | Liste öğesinin Glyph değerini ayarlar. |
set | List | Paragraph değerini ayarlar. |
set | List | Bitiş girintisini puan cinsinden ayarlar. |
set | List | İlk satır girintisini puan cinsinden ayarlar. |
set | List | Başlangıç girintisini puan cinsinden ayarlar. |
set | List | Soldan sağa ayarını belirler. |
set | List | Satır aralığını, aralık için kullanılacak satır sayısını belirten bir miktar olarak ayarlar. |
set | List | Bağlantı URL'sini ayarlar. |
set | List | Liste kimliğini ayarlar. |
set | List | Liste öğesinin iç içe yerleştirme düzeyini ayarlar. |
set | List | Öğeden sonraki aralığı punto cinsinden ayarlar. |
set | List | Öğeden önceki aralığı punto cinsinden ayarlar. |
set | void | Liste öğesinin içeriğini metin olarak ayarlar. |
set | List | Metin hizalamasını ayarlar. |
Ayrıntılı belgeler
addPositionedImage(image)
Belirtilen resim blob'undan yeni bir PositionedImage oluşturup ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
image | Blob | Resim verileri |
Return
PositionedImage: Yeni konumlandırılmış resim
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendHorizontalRule()
Yeni bir HorizontalRule oluşturur ve ekler.
Return
HorizontalRule: Yeni yatay kural
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Belirtilen resim blob'undan yeni bir InlineImage oluşturur ve ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
image | Blob | Resim verileri |
Return
InlineImage: Eklenen resim
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Belirtilen InlineImage eklenir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
image | Inline | Resim verileri |
Return
InlineImage: Eklenen resim
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak()
Yeni bir PageBreak oluşturur ve ekler.
Not: PageBreaks, TableCells içinde yer almayabilir.
Mevcut öğe bir tablo hücresinde yer alıyorsa istisna oluşturulur.
Return
PageBreak: Yeni sayfa sonu öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
Belirtilen PageBreak eklenir.
Not: PageBreaks, TableCells içinde yer almayabilir.
Mevcut öğe bir tablo hücresinde yer alıyorsa istisna oluşturulur.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
page | Page | Eklenecek sayfa sonu |
Return
PageBreak: Eklenen sayfa sonu öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendText(text)
Belirtilen içeriklerle yeni bir Text öğesi oluşturur ve ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | String | metin içerikleri |
Return
Text: Yeni metin öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendText(text)
Belirtilen Text öğesini ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | Text | Eklenecek metin öğesi |
Return
Text: Eklenen metin öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
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 öğenin üst öğesi yok.
Return
ListItem: Yeni kopya.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
editAsText()
Düzenlemek için mevcut öğenin Text sürümünü alır.
Öğelerin içeriğini zengin metin olarak değiştirmek için editAsText kullanın. editAsText modu, metin olmayan öğeleri (ör. InlineImage ve HorizontalRule) yoksayar.
Silinen metin aralığında tamamen yer alan alt öğeler, öğeden kaldırılır.
const 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ürde bir alt öğe arar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
element | Element | Aranacak öğe türü. |
Return
RangeElement|null: Arama öğesinin konumunu gösteren bir arama sonucu.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Belirtilen RangeElement ile başlayarak, belirtilen türde bir alt öğe için öğenin içeriğini arar.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
element | Element | Aranacak öğe türü. |
from | Range | Arama yapılacak arama sonucu. |
Return
RangeElement|null: Arama öğesinin sonraki konumunu gösteren bir arama sonucu.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern)
Normal ifadeleri kullanarak öğenin içeriğinde belirtilen metin kalıbını arar.
JavaScript normal ifade özelliklerinin bir alt kümesi (ör. yakalama grupları ve mod değiştiriciler) tam olarak desteklenmez.
Sağlanan normal ifade kalıbı, mevcut öğede bulunan her metin bloğuyla bağımsız olarak eşleştirilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
search | String | Aranacak desen |
Return
RangeElement|null — arama metninin konumunu gösteren bir arama sonucu veya eşleşme yoksa null
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Belirtilen metin kalıbını, belirli bir arama sonucundan başlayarak öğenin içeriğinde arar.
JavaScript normal ifade özelliklerinin bir alt kümesi (ör. yakalama grupları ve mod değiştiriciler) tam olarak desteklenmez.
Sağlanan normal ifade kalıbı, mevcut öğede bulunan her metin bloğuyla bağımsız olarak eşleştirilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
search | String | Aranacak desen |
from | Range | Arama yapılacak arama sonucu |
Return
RangeElement|null: Arama metninin bir sonraki konumunu gösteren bir arama sonucu veya eşleşme yoksa null
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getAlignment()
HorizontalAlignment öğesini alır.
Return
HorizontalAlignment|null — hizalama
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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 geçerli öğe özelliği için bir özellik içeren bir nesnedir. Her özellik adı, DocumentApp.Attribute numaralandırmasındaki bir öğeye karşılık gelir.
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]}`); }
Return
Object: Öğenin özellikleri.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const 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 |
|---|---|---|
child | Integer | Alınacak alt öğenin dizini. |
Return
Element: Belirtilen dizindeki alt öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getChildIndex(child)
Belirtilen alt öğenin alt dizinini alır.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Element | Dizinin alınacağı alt öğe. |
Return
Integer: Çocuk dizini.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getGlyphType()
Liste öğesinin GlyphType değerini alır.
Return
GlyphType|null: Glif türü
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getHeading()
ParagraphHeading öğesini alır.
Return
ParagraphHeading|null: başlık
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getIndentEnd()
Son girintiyi puan cinsinden alır.
Return
Number|null: Bitiş girintisi (puan cinsinden)
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getIndentFirstLine()
İlk satır girintisini puan cinsinden alır.
Return
Number|null: İlk satır girintisi (puan cinsinden)
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getIndentStart()
Başlangıç girintisini alır.
Return
Number|null: Başlangıç girintisi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getLineSpacing()
Satır aralığını puan cinsinden alır.
Return
Number|null: Satır aralığı (punto cinsinden)
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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|null: 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 biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getListId()
Liste kimliğini alır.
Return
String|null: Liste kimliği
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNestingLevel()
Liste öğesinin iç içe yerleştirme düzeyini alır.
Liste öğeleri varsayılan olarak sıfır iç içe yerleştirme seviyesine sahiptir. İç içe yerleştirme düzeyi, liste öğesi tarafından kullanılan glifi belirler.
Return
Integer: İç içe yerleştirme seviyesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNextSibling()
Öğenin sonraki kardeş öğesini alır.
Bir sonraki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeyi takip eder.
Return
Element|null: Sonraki kardeş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNumChildren()
Çocuk sayısını alır.
const 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: Çocuk sayısı.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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çerir.
Return
ContainerElement|null: Üst öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPositionedImage(id)
Görüntünün kimliğine göre PositionedImage alır.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
id | String | Resim kimliği |
Return
PositionedImage: Konumlandırılmış resim
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPositionedImages()
Paragrafa sabitlenmiş tüm PositionedImage nesnelerini alır.
Return
PositionedImage[]: Konumlandırılmış resimlerin listesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPreviousSibling()
Öğenin önceki kardeş öğesini alır.
Önceki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeden önce gelir.
Return
Element|null: Önceki kardeş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getSpacingAfter()
Öğeden sonraki aralığı punto cinsinden alır.
Return
Number|null: Öğeden sonraki aralık (punto cinsinden)
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getSpacingBefore()
Öğeden önceki aralığı punto cinsinden alır.
Return
Number|null: Öğeden önceki boşluk (punto cinsinden)
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getText()
Öğenin içeriğini metin dizesi olarak alır.
Return
String: Öğenin metin dizesi olarak içeriği
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getTextAlignment()
Metin hizalamasını alır. Kullanılabilir hizalama türleri DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ve DocumentApp.TextAlignment.SUPERSCRIPT'dir.
Return
TextAlignment|null: Metin hizalama türü veya metin birden fazla metin hizalama türü içeriyorsa ya da metin hizalama hiç ayarlanmamışsa null
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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() kullanın.
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.'); }
Return
ElementType: Öğe türü.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Belirtilen dizinde bir HorizontalRule oluşturur ve ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
Return
HorizontalRule: Yeni yatay çizgi öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Belirtilen resim blob'undan belirtilen dizinde yeni bir InlineImage oluşturup ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
image | Blob | Resim verileri |
Return
InlineImage: Eklenen satır içi resim öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Belirtilen dizine verilen InlineImage öğesini ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
image | Inline | Resim verileri |
Return
InlineImage: Eklenen satır içi resim öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
Belirtilen dizinde yeni bir PageBreak oluşturur ve ekler.
Not: PageBreaks, TableCells içinde yer almayabilir.
Mevcut öğe bir tablo hücresinde yer alıyorsa istisna oluşturulur.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
Return
PageBreak: Yeni sayfa sonu öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
Belirtilen dizine verilen PageBreak öğesini ekler.
Not: PageBreaks, TableCells içinde yer almayabilir.
Mevcut öğe bir tablo hücresinde yer alıyorsa istisna oluşturulur.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
page | Page | eklenecek sayfa sonu |
Return
PageBreak: Eklenen sayfa sonu öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Belirtilen dizinde yeni bir metin öğesi oluşturur ve ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
text | String | metin içerikleri |
Return
Text: Yeni metin öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Belirtilen Text öğesini, belirtilen metin içerikleriyle birlikte belirtilen dizine ekler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Integer | öğenin ekleneceği dizin |
text | Text | Eklenecek metin öğesi |
Return
Text: Eklenen metin öğesi
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Öğenin Document sonunda olup olmadığını belirler.
Return
Boolean: Öğenin sekmenin sonunda olup olmadığı.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isLeftToRight()
Soldan sağa ayarını alır.
Return
Boolean|null: Soldan sağa ayarı
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
merge()
Öğeyi, aynı türdeki önceki kardeş öğeyle birleştirir.
Yalnızca aynı ElementType öğeleri birleştirilebilir. Geçerli öğede bulunan tüm alt öğeler, önceki kardeş öğeye taşınır.
Mevcut öğe dokümandan kaldırılır.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const 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. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Return
ListItem|null: Birleştirilmiş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeChild(child)
Belirtilen alt öğeyi kaldırır.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
child | Element | kaldırılacak alt öğe |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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.
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(); }
Return
ListItem|null: Kaldırılan öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removePositionedImage(id)
Resmin kimliğine göre PositionedImage kaldırır.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
id | String |
Return
Boolean Belirtilen resmin kaldırılıp kaldırılmadığı
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Normal ifadeleri kullanarak belirli bir metin kalıbının tüm örneklerini belirli bir yeni dizeyle değiştirir.
Arama kalıbı, JavaScript normal ifade nesnesi olarak değil, dize olarak iletilir. Bu nedenle, desendeki tüm ters eğik çizgileri çıkış karakteriyle belirtmeniz gerekir.
Bu yöntem, desteklenen söz dizimini sınırlayan Google'ın RE2 normal ifade kitaplığını kullanır.
Sağlanan normal ifade kalıbı, mevcut öğede bulunan her metin bloğuyla bağımsız olarak eşleştirilir.
const 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 |
|---|---|---|
search | String | Aranacak normal ifade kalıbı |
replacement | String | Değiştirme için kullanılacak metin |
Return
Element: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setAlignment(alignment)
HorizontalAlignment değerini ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
alignment | Horizontal | yatay hizalama |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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 numaralandırmasındaki bir öğe ve her özellik değerinin uygulanacak yeni değer olduğu bir nesne olmalıdır.
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);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
attributes | Object | Öğenin özellikleri. |
Return
ListItem: Geçerli öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setGlyphType(glyphType)
Liste öğesinin GlyphType değerini ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
glyph | Glyph | glif türü |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setHeading(heading)
ParagraphHeading değerini ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
heading | Paragraph | başlık |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
Bitiş girintisini puan cinsinden ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
indent | Number | Bitiş girintisi (nokta cinsinden) |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
İlk satır girintisini puan cinsinden ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
indent | Number | ilk satır girintisi (nokta cinsinden) |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
Başlangıç girintisini puan cinsinden ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
indent | Number | Başlangıç girintisi (puan cinsinden) |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
Soldan sağa ayarını belirler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
left | Boolean | soldan sağa ayarı |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setLineSpacing(multiplier)
Satır aralığını, aralık için kullanılacak satır sayısını belirten bir miktar olarak ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
multiplier | Number | satır sayısı |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setListId(listItem)
Liste kimliğini ayarlar.
Liste kimliği, belirtilen ListItem için aynı değere ayarlanır. İki ListItems, aynı listenin üyesi olarak kabul edilir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
list | List | Liste kimliği kullanılacak liste öğesi |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setNestingLevel(nestingLevel)
Liste öğesinin iç içe yerleştirme düzeyini ayarlar.
Liste öğeleri varsayılan olarak sıfır iç içe yerleştirme seviyesine sahiptir. İç içe yerleştirme düzeyi, liste öğesi tarafından kullanılan glifi belirler.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
nesting | Integer | iç içe yerleştirme seviyesi |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
Öğeden sonraki aralığı punto cinsinden ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
spacing | Number | Öğeden sonraki aralık (punto cinsinden) |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
Öğeden önceki aralığı punto cinsinden ayarlar.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
spacing | Number | öğeden önceki aralık (punto cinsinden) |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setText(text)
Liste öğesinin içeriğini metin olarak ayarlar.
Not: Mevcut içerikler temizlenir.
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | String | yeni metin içerikleri |
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri 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 DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ve DocumentApp.TextAlignment.SUPERSCRIPT'dir.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametreler
| Ad | Tür | Açıklama |
|---|---|---|
text | Text | Uygulanacak metin hizalama türü |
Return
ListItem: Geçerli öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents