Class ListItem

ListItem

Liste öğesini temsil eden bir öğe. ListItem, bir liste kimliğiyle ilişkilendirilmiş bir Paragraph'tur. 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 kılavuzuna 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. Aşağıdaki örnekte gösterildiği gibi, aynı listeye ait iki öğe, sekmenin herhangi bir yerinde bulunabilir ve art arda numaralandırılabilir:

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öntemDönüş türüKısa açıklama
addPositionedImage(image)PositionedImageBelirtilen resim blob'undan yeni bir PositionedImage oluşturup ekler.
appendHorizontalRule()HorizontalRuleYeni bir HorizontalRule oluşturup ekler.
appendInlineImage(image)InlineImageBelirtilen resim blob'undan yeni bir InlineImage oluşturup ekler.
appendInlineImage(image)InlineImageBelirtilen InlineImage değerini ekler.
appendPageBreak()PageBreakYeni bir PageBreak oluşturup ekler.
appendPageBreak(pageBreak)PageBreakBelirtilen PageBreak değerini ekler.
appendText(text)TextBelirtilen içeriklerle yeni bir Text öğesi oluşturup ekler.
appendText(text)TextBelirtilen Text öğesini ekler.
clear()ListItemÖğenin içeriğini temizler.
copy()ListItemGeçerli öğenin ayrılmış, derin bir kopyasını döndürür.
editAsText()TextDüzenlemek için mevcut öğenin Text sürümünü alır.
findElement(elementType)RangeElementÖğenin içeriğini, belirtilen türün bir alt öğesi için arar.
findElement(elementType, from)RangeElementBelirtilen RangeElement öğesinden başlayarak öğenin içeriğini, belirtilen türün bir alt öğesi için arar.
findText(searchPattern)RangeElementNormal ifadeleri kullanarak öğenin içeriğinde belirtilen metin kalıbını arar.
findText(searchPattern, from)RangeElementBelirli bir arama sonucundan başlayarak öğenin içeriğini belirtilen metin kalıbıyla arar.
getAlignment()HorizontalAlignmentHorizontalAlignment öğesini alır.
getAttributes()ObjectÖğenin özelliklerini alır.
getChild(childIndex)ElementBelirtilen alt öğe dizininde alt öğeyi alır.
getChildIndex(child)IntegerBelirtilen alt öğenin alt öğe dizini döndürülür.
getGlyphType()GlyphTypeListe öğesinin GlyphType değerini alır.
getHeading()ParagraphHeadingParagraphHeading öğesini alır.
getIndentEnd()NumberSon girintiyi nokta cinsinden alır.
getIndentFirstLine()Numberİlk satır girintisini puan cinsinden alır.
getIndentStart()NumberBaşlangıç girintisini alır.
getLineSpacing()NumberSatır aralığını nokta cinsinden alır.
getLinkUrl()StringBağlantı URL'sini alır.
getListId()StringListe kimliğini alır.
getNestingLevel()IntegerListe öğesinin iç içe yerleştirme düzeyini alır.
getNextSibling()ElementÖğenin sonraki kardeş öğesini alır.
getNumChildren()IntegerÇocuk sayısını alır.
getParent()ContainerElementÖğenin üst öğesini alır.
getPositionedImage(id)PositionedImageResmin kimliğine göre bir PositionedImage alır.
getPositionedImages()PositionedImage[]Paragrafa sabitlenmiş tüm PositionedImage nesnelerini alır.
getPreviousSibling()ElementÖğenin önceki kardeş öğesini alır.
getSpacingAfter()NumberÖğeden sonraki boşluğu, punto cinsinden alır.
getSpacingBefore()NumberÖğeden önceki boşluğu punto cinsinden alır.
getText()StringÖğenin içeriğini metin dizesi olarak alır.
getTextAlignment()TextAlignmentMetin hizalamasını alır.
getType()ElementTypeÖğenin ElementType değerini alır.
insertHorizontalRule(childIndex)HorizontalRuleBelirtilen dizinde bir HorizontalRule oluşturup ekler.
insertInlineImage(childIndex, image)InlineImageBelirtilen resim blob'undan yeni bir InlineImage oluşturup belirtilen dizinde ekler.
insertInlineImage(childIndex, image)InlineImageBelirtilen InlineImage öğesini belirtilen dizin içine ekler.
insertPageBreak(childIndex)PageBreakBelirtilen dizinde yeni bir PageBreak oluşturup ekler.
insertPageBreak(childIndex, pageBreak)PageBreakBelirtilen PageBreak öğesini belirtilen dizin içine ekler.
insertText(childIndex, text)TextBelirtilen dizinde yeni bir metin öğesi oluşturur ve ekler.
insertText(childIndex, text)TextBelirtilen Text öğesini, belirtilen metin içeriğiyle birlikte belirtilen dizinde ekler.
isAtDocumentEnd()BooleanÖğenin Document'ün sonunda olup olmadığını belirler.
isLeftToRight()BooleanSoldan sağa ayarını alır.
merge()ListItemÖğeyi, aynı türdeki önceki kardeş öğeyle birleştirir.
removeChild(child)ListItemBelirtilen alt öğeyi kaldırır.
removeFromParent()ListItemÖğeyi üst öğesinden kaldırır.
removePositionedImage(id)BooleanResmin kimliğine göre bir PositionedImage kaldırır.
replaceText(searchPattern, replacement)ElementNormal ifadeler kullanılarak belirli bir metin kalıbının tüm örnekleri belirli bir değiştirme dizesiyle değiştirilir.
setAlignment(alignment)ListItemHorizontalAlignment değerini belirler.
setAttributes(attributes)ListItemÖğenin özelliklerini ayarlar.
setGlyphType(glyphType)ListItemListe öğesinin GlyphType değerini ayarlar.
setHeading(heading)ListItemParagraphHeading değerini belirler.
setIndentEnd(indentEnd)ListItemSon girintiyi nokta cinsinden ayarlar.
setIndentFirstLine(indentFirstLine)ListItemİlk satır girintisini nokta cinsinden ayarlar.
setIndentStart(indentStart)ListItemBaşlangıç girintisini nokta cinsinden ayarlar.
setLeftToRight(leftToRight)ListItemSoldan sağa ayarını belirler.
setLineSpacing(multiplier)ListItemSatır aralığını, ara vermek için kullanılacak satır sayısını belirten bir miktar olarak ayarlar.
setLinkUrl(url)ListItemBağlantı URL'sini ayarlar.
setListId(listItem)ListItemListe kimliğini ayarlar.
setNestingLevel(nestingLevel)ListItemListe öğesinin iç içe yerleştirme düzeyini ayarlar.
setSpacingAfter(spacingAfter)ListItemÖğeden sonraki boşluğu punto cinsinden ayarlar.
setSpacingBefore(spacingBefore)ListItemÖğeden önceki boşluğu punto cinsinden ayarlar.
setText(text)voidListe öğesinin içeriğini metin olarak ayarlar.
setTextAlignment(textAlignment)ListItemMetin hizalamasını ayarlar.

Ayrıntılı dokümanlar

addPositionedImage(image)

Belirtilen resim blob'undan yeni bir PositionedImage oluşturup ekler.

Parametreler

AdTürAçıklama
imageBlobSourceresim verileri

Return

PositionedImage: Yeni konumlandırılmış resim

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendHorizontalRule()

Yeni bir HorizontalRule oluşturup ekler.

Return

HorizontalRule: yeni yatay kural

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendInlineImage(image)

Belirtilen resim blob'undan yeni bir InlineImage oluşturup ekler.

Parametreler

AdTürAçıklama
imageBlobSourceresim verileri

Return

InlineImage: Eklenen resim

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendInlineImage(image)

Belirtilen InlineImage değerini ekler.

Parametreler

AdTürAçıklama
imageInlineImageresim verileri

Return

InlineImage: Eklenen resim

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendPageBreak()

Yeni bir PageBreak oluşturup ekler.

Not: PageBreaks, TableCells içinde yer alamaz. Mevcut öğe bir tablo hücresindeyse bir istisna atılır.

Return

PageBreak: yeni sayfa sonu öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendPageBreak(pageBreak)

Belirtilen PageBreak değerini ekler.

Not: PageBreaks, TableCells içinde yer alamaz. Mevcut öğe bir tablo hücresindeyse bir istisna atılır.

Parametreler

AdTürAçıklama
pageBreakPageBreakeklenecek sayfa sonu

Return

PageBreak: Eklenen sayfa sonu öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendText(text)

Belirtilen içeriklerle yeni bir Text öğesi oluşturup ekler.

Parametreler

AdTürAçıklama
textStringmetin içerikleri

Return

Text: Yeni metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

appendText(text)

Belirtilen Text öğesini ekler.

Parametreler

AdTürAçıklama
textTexteklenecek metin öğesi

Return

Text: Eklenen metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

clear()

Öğenin içeriğini temizler.

Return

ListItem: Geçerli öğe.


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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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.

Öğe içeriklerini zengin metin olarak değiştirmek için editAsText öğesini kullanın. editAsText modu, metin olmayan öğeleri (InlineImage ve HorizontalRule gibi) yoksayar.

Silinen bir metin aralığının tamamına sahip 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: Mevcut öğenin metin sürümü


findElement(elementType)

Öğenin içeriğini, belirtilen türün bir alt öğesi için arar.

Parametreler

AdTürAçıklama
elementTypeElementTypeAranacak öğe türü.

Return

RangeElement: Arama öğesinin konumunu belirten bir arama sonucu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

findElement(elementType, from)

Belirtilen RangeElement öğesinden başlayarak öğenin içeriğini, belirtilen türün bir alt öğesi için 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

AdTürAçıklama
elementTypeElementTypeAranacak öğe türü.
fromRangeElementArama yapılacak arama sonucu.

Return

RangeElement: Arama öğesinin sonraki konumunu gösteren bir arama sonucu.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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ı, geçerli öğede bulunan her metin bloğuyla bağımsız olarak eşleştirilir.

Parametreler

AdTürAçıklama
searchPatternStringaranacak kalıp

Return

RangeElement: Arama metninin konumunu gösteren bir arama sonucudur veya eşleşme yoksa null değerini alır.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

findText(searchPattern, from)

Belirli bir arama sonucundan başlayarak öğenin içeriğini belirtilen metin kalıbıyla 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ı, geçerli öğede bulunan her metin bloğuyla bağımsız olarak eşleştirilir.

Parametreler

AdTürAçıklama
searchPatternStringaranacak kalıp
fromRangeElementArama yapılacak arama sonucu

Return

RangeElement: Arama metninin sonraki konumunu gösteren bir arama sonucudur veya eşleşme yoksa null değerini alır.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getAlignment()

HorizontalAlignment öğesini alır.

Return

HorizontalAlignment: Hizalama

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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. Bu nesnedeki her özellik adı, DocumentApp.Attribute dizininde 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getChild(childIndex)

Belirtilen alt öğe dizininde 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

AdTürAçıklama
childIndexIntegerAlınacak alt öğenin dizini.

Return

Element: Belirtilen dizindeki alt öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getChildIndex(child)

Belirtilen alt öğenin alt öğe dizini döndürülür.

Parametreler

AdTürAçıklama
childElementDizininin alınacağı alt öğe.

Return

Integer: Alt dizin.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getGlyphType()

Liste öğesinin GlyphType değerini alır.

Return

GlyphType: Glif türü

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getHeading()

ParagraphHeading öğesini alır.

Return

ParagraphHeading: başlık

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getIndentEnd()

Son girintiyi nokta cinsinden alır.

Return

Number: Bitiş girintisi (noktalar cinsinden)

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getIndentFirstLine()

İlk satır girintisini puan cinsinden alır.

Return

Number: ilk satır girintisi (noktalar cinsinden)

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getIndentStart()

Başlangıç girintisini alır.

Return

Number: Başlangıç girintisi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getLineSpacing()

Satır aralığını nokta cinsinden alır.

Return

Number: Satır aralığı (punto cinsinden)

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getListId()

Liste kimliğini alır.

Return

String: liste kimliği

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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 öğelerinin varsayılan iç içe yerleştirme seviyesi sıfırdır. İç içe yerleştirme seviyesi, liste öğesi tarafından kullanılan glifi belirler.

Return

Integer: İç içe yerleştirme seviyesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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: Sonraki kardeş öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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: Üst öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getPositionedImage(id)

Resmin kimliğine göre bir PositionedImage alır.

Parametreler

AdTürAçıklama
idStringresim kimliği

Return

PositionedImage: Konumlandırılmış resim

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getPositionedImages()

Paragrafa sabitlenmiş tüm PositionedImage nesnelerini alır.

Return

PositionedImage[]: Yerleştirilmiş resimlerin listesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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: Önceki kardeş öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getSpacingAfter()

Öğeden sonraki boşluğu, punto cinsinden alır.

Return

Number: Öğeden sonraki aralık (punto cinsinden)

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getSpacingBefore()

Öğeden önceki boşluğu punto cinsinden alır.

Return

Number: Öğeden önceki boşluk (punto cinsinden)

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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: Metin hizalamasının türü veya metin birden fazla metin hizası türü içeriyorsa ya da metin hizası hiç ayarlanmadıysa null

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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() öğesini 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertHorizontalRule(childIndex)

Belirtilen dizinde bir HorizontalRule oluşturup ekler.

Parametreler

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin

Return

HorizontalRule: yeni yatay kural öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertInlineImage(childIndex, image)

Belirtilen resim blob'undan yeni bir InlineImage oluşturup belirtilen dizinde ekler.

Parametreler

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin
imageBlobSourceresim verileri

Return

InlineImage: Eklenen satır içi resim öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertInlineImage(childIndex, image)

Belirtilen InlineImage öğesini belirtilen dizin içine ekler.

Parametreler

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin
imageInlineImageresim verileri

Return

InlineImage: Eklenen satır içi resim öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertPageBreak(childIndex)

Belirtilen dizinde yeni bir PageBreak oluşturup ekler.

Not: PageBreaks, TableCells içinde yer alamaz. Mevcut öğe bir tablo hücresindeyse bir istisna atılır.

Parametreler

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin

Return

PageBreak: yeni sayfa sonu öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertPageBreak(childIndex, pageBreak)

Belirtilen PageBreak öğesini belirtilen dizin içine ekler.

Not: PageBreaks, TableCells içinde yer alamaz. Mevcut öğe bir tablo hücresindeyse bir istisna atılır.

Parametreler

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin
pageBreakPageBreakeklenecek sayfa sonu

Return

PageBreak: Eklenen sayfa sonu öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin
textStringmetin içerikleri

Return

Text: Yeni metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

insertText(childIndex, text)

Belirtilen Text öğesini, belirtilen metin içeriğiyle birlikte belirtilen dizinde ekler.

Parametreler

AdTürAçıklama
childIndexIntegerÖğenin ekleneceği dizin
textTexteklenecek metin öğesi

Return

Text: Eklenen metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

isAtDocumentEnd()

Öğenin Document'ün sonunda olup olmadığını belirler.

Return

Boolean: Öğenin sekmenin sonunda olup olmadığı.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

isLeftToRight()

Soldan sağa ayarını alır.

Return

Boolean: soldan sağa ayar

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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: Birleştirilmiş öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

removeChild(child)

Belirtilen alt öğeyi kaldırır.

Parametreler

AdTürAçıklama
childElementKaldırılacak alt öğe

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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: Kaldırılan öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

removePositionedImage(id)

Resmin kimliğine göre bir PositionedImage kaldırır.

Parametreler

AdTürAçıklama
idString

Return

Boolean: Belirtilen resmin kaldırılıp kaldırılmadığı

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

replaceText(searchPattern, replacement)

Normal ifadeler kullanılarak belirli bir metin kalıbının tüm örnekleri belirli bir değiştirme dizesiyle değiştirilir.

Arama kalıbı, JavaScript normal ifade nesnesi değil, dize olarak iletilir. Bu nedenle, kalıptaki tüm ters eğik çizgileri koddan çıkarmanız 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ı, geçerli öğ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

AdTürAçıklama
searchPatternStringAranacak normal ifade kalıbı
replacementStringDeğişim olarak kullanılacak metin

Return

Element: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setAlignment(alignment)

HorizontalAlignment değerini belirler.

Parametreler

AdTürAçıklama
alignmentHorizontalAlignmentyatay hizalama

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setAttributes(attributes)

Öğenin özelliklerini ayarlar.

Belirtilen attributes parametresi, her bir özellik adının DocumentApp.Attribute numaralandırmasında bir öğe olduğu ve her bir ö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

AdTürAçıklama
attributesObjectÖğenin özellikleri.

Return

ListItem: Geçerli öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setGlyphType(glyphType)

Liste öğesinin GlyphType değerini ayarlar.

Parametreler

AdTürAçıklama
glyphTypeGlyphTypeglif türü

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setHeading(heading)

ParagraphHeading değerini belirler.

Parametreler

AdTürAçıklama
headingParagraphHeadingbaşlık

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setIndentEnd(indentEnd)

Son girintiyi nokta cinsinden ayarlar.

Parametreler

AdTürAçıklama
indentEndNumberBitiş girintisi (noktalar cinsinden)

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setIndentFirstLine(indentFirstLine)

İlk satır girintisini nokta cinsinden ayarlar.

Parametreler

AdTürAçıklama
indentFirstLineNumberilk satır girintisi (noktalar cinsinden)

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setIndentStart(indentStart)

Başlangıç girintisini nokta cinsinden ayarlar.

Parametreler

AdTürAçıklama
indentStartNumberBaşlangıç girintisi (noktalar cinsinden)

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setLeftToRight(leftToRight)

Soldan sağa ayarını belirler.

Parametreler

AdTürAçıklama
leftToRightBooleansoldan sağa ayarını

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setLineSpacing(multiplier)

Satır aralığını, ara vermek için kullanılacak satır sayısını belirten bir miktar olarak ayarlar.

Parametreler

AdTürAçıklama
multiplierNumbersatır sayısı

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setLinkUrl(url)

Bağlantı URL'sini ayarlar.

Parametreler

AdTürAçıklama
urlStringbağlantı URL'si

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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. Bu iki ListItems, aynı listenin üyeleri olarak değerlendirilir.

Parametreler

AdTürAçıklama
listItemListItemKullanılacak liste kimliğine sahip liste öğesi

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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 öğelerinin varsayılan iç içe yerleştirme seviyesi sıfırdır. İç içe yerleştirme seviyesi, liste öğesi tarafından kullanılan glifi belirler.

Parametreler

AdTürAçıklama
nestingLevelIntegeriç içe yerleştirme seviyesi

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setSpacingAfter(spacingAfter)

Öğeden sonraki boşluğu punto cinsinden ayarlar.

Parametreler

AdTürAçıklama
spacingAfterNumberÖğeden sonraki aralık (punto cinsinden)

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

setSpacingBefore(spacingBefore)

Öğeden önceki boşluğu punto cinsinden ayarlar.

Parametreler

AdTürAçıklama
spacingBeforeNumberÖğeden önceki boşluk (punto cinsinden)

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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 silinir.

Parametreler

AdTürAçıklama
textStringyeni metin içerikleri

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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

AdTürAçıklama
textAlignmentTextAlignmentuygulanacak metin hizalamasının türü

Return

ListItem: Geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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