Class ListItem

ListItem

Liste öğesini temsil eden bir öğe. ListItem, liste kimliğiyle ilişkilendirilmiş bir Paragraph'dir. ListItem; Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak ve Text öğeleri içerebilir. Doküman yapısı hakkında daha fazla bilgi edinmek için Google Dokümanlar'ın kapsamını 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 öğesinin, dokümanda bitişik olması veya aynı üst öğeye sahip olması gerekmez. Aşağıdaki örnekte gösterildiği gibi, ardışık numaralandırmayı sürdürürken dokümanın herhangi bir yerinde aynı listeye ait iki öğe bulunabilir:

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

// Append a new list item to the body.
var 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.
var 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şturur ve ekler.
appendHorizontalRule()HorizontalRuleYeni bir HorizontalRule oluşturup ekler.
appendInlineImage(image)InlineImageBelirtilen resim blob'undan yeni bir InlineImage oluşturur ve ekler.
appendInlineImage(image)InlineImageBelirtilen InlineImage dizesini ekler.
appendPageBreak()PageBreakYeni bir PageBreak oluşturup ekler.
appendPageBreak(pageBreak)PageBreakBelirtilen PageBreak dizesini ekler.
appendText(text)TextBelirtilen içeriklerle yeni bir Text öğesi oluşturur ve ekler.
appendText(text)TextBelirtilen Text öğesini ekler.
clear()ListItemÖğenin içeriğini temizler.
copy()ListItemGeçerli öğenin ayrı, derin bir kopyasını döndürür.
editAsText()TextDüzenleme için geçerli öğenin Text sürümünü alır.
findElement(elementType)RangeElementÖğenin içeriğinde, belirtilen türde bir alt öğe arar.
findElement(elementType, from)RangeElementBelirtilen RangeElement öğesinden başlayarak, öğenin içeriğinde belirtilen türde bir alt öğe arar.
findText(searchPattern)RangeElementNormal ifadeler kullanarak, belirtilen metin kalıbı için öğenin içeriğinde arama yapar.
findText(searchPattern, from)RangeElementBelirli bir arama sonucundan başlayarak, belirtilen metin kalıbı için öğenin içeriğinde arama yapar.
getAlignment()HorizontalAlignmentHorizontalAlignment öğesini getirir.
getAttributes()ObjectÖğenin özelliklerini alır.
getChild(childIndex)ElementBelirtilen alt dizindeki alt öğeyi alır.
getChildIndex(child)IntegerBelirtilen alt öğe için alt dizini alır.
getGlyphType()GlyphTypeListe öğesinin GlyphType öğesini getirir.
getHeading()ParagraphHeadingParagraphHeading öğesini getirir.
getIndentEnd()NumberSon girintiyi punto cinsinden alır.
getIndentFirstLine()Numberİlk satır girintisini nokta 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 seviyesini alır.
getNextSibling()ElementÖğenin sonraki eşdüzey öğesini alır.
getNumChildren()IntegerAlt öğe 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ş PositionedImage nesnenin tümünü alır.
getPreviousSibling()ElementÖğenin önceki eşdüzey öğ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ı sağlar.
getType()ElementTypeÖğenin ElementType değerini alır.
insertHorizontalRule(childIndex)HorizontalRuleBelirtilen dizinde bir HorizontalRule oluşturur ve ekler.
insertInlineImage(childIndex, image)InlineImageBelirtilen resim blob'undan, belirtilen dizinde yeni bir InlineImage oluşturur ve ekler.
insertInlineImage(childIndex, image)InlineImageBelirtilen InlineImage öğesini belirtilen dizine ekler.
insertPageBreak(childIndex)PageBreakBelirtilen dizinde yeni bir PageBreak oluşturur ve ekler.
insertPageBreak(childIndex, pageBreak)PageBreakBelirtilen PageBreak öğesini belirtilen dizine ekler.
insertText(childIndex, text)TextBelirtilen dizinde yeni bir metin öğesi oluşturur ve ekler.
insertText(childIndex, text)TextBelirtilen Text öğesini, belirtilen metin içerikleriyle birlikte belirtilen dizine ekler.
isAtDocumentEnd()BooleanÖğenin, Document öğesinin sonunda olup olmadığını belirler.
isLeftToRight()BooleanSoldan sağa ayarını getirir.
merge()ListItemÖğeyi, aynı türdeki önceki eşdüzey öğe ile 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ılır.
replaceText(searchPattern, replacement)ElementNormal ifadeler kullanarak belirli bir metin kalıbının tüm tekrarlarını verilen bir yeni dizeyle değiştirir.
setAlignment(alignment)ListItemHorizontalAlignment özelliğini ayarlar.
setAttributes(attributes)ListItemÖğenin özelliklerini ayarlar.
setGlyphType(glyphType)ListItemListe öğesinin GlyphType özelliğini ayarlar.
setHeading(heading)ListItemParagraphHeading özelliğini ayarlar.
setIndentEnd(indentEnd)ListItemBitiş girintisini punto cinsinden ayarlar.
setIndentFirstLine(indentFirstLine)ListItemİlk satır girintisini punto cinsinden ayarlar.
setIndentStart(indentStart)ListItemBaşlangıç girintisini punto cinsinden ayarlar.
setLeftToRight(leftToRight)ListItemSoldan sağa ayarını belirler.
setLineSpacing(multiplier)ListItemSatır aralığını, aralık 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 seviyesini 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ı belgeler

addPositionedImage(image)

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

Parametreler

AdTürAçıklama
imageBlobSourceresim verileri

Return

PositionedImage - yeni konumlandırılmış resim

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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şturup ekler.

Return

HorizontalRule - yeni yatay kural

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

AdTürAçıklama
imageBlobSourceresim verileri

Return

InlineImage - eklenen resim

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

appendInlineImage(image)

Belirtilen InlineImage dizesini ekler.

Parametreler

AdTürAçıklama
imageInlineImageresim verileri

Return

InlineImage - eklenen resim

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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şturup ekler.

Not: PageBreaks, TableCells içinde bulunamaz. Geçerli öğe bir tablo hücresinde yer alıyorsa bir istisna atılır.

Return

PageBreak - yeni sayfa sonu öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

appendPageBreak(pageBreak)

Belirtilen PageBreak dizesini ekler.

Not: PageBreaks, TableCells içinde bulunamaz. Geçerli öğe bir tablo hücresinde yer alıyorsa 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ı, aşağıdaki kapsamların 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

AdTürAçıklama
textStringmetin içeriği

Return

Text - yeni metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

AdTürAçıklama
textTexteklenecek metin öğesi

Return

Text - eklenen metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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ı, derin bir kopyasını döndürür.

Öğede bulunan alt öğeler de kopyalanır. Yeni öğenin bir üst öğesi yoktur.

Return

ListItem: Yeni kopya.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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.

Tamamen silinmiş bir metin aralığı içinde yer alan alt öğeler öğeden kaldırılır.

var body = DocumentApp.getActiveDocument().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

AdTürAçıklama
elementTypeElementTypearanacak öğe türü

Return

RangeElement: Arama öğesinin konumunu belirten arama sonucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 öğesinden başlayarak, öğenin içeriğinde belirtilen türde bir alt öğe arar.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().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

AdTürAçıklama
elementTypeElementTypearanacak öğe türü
fromRangeElementarama yapılacak arama sonucunu

Return

RangeElement: Arama öğesinin sonraki konumunu belirten arama sonucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 (ör. yakalama grupları ve mod değiştiricileri) 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
searchPatternStringmola vermek için

Return

RangeElement: Arama metninin konumunu gösteren arama sonucu veya eşleşme yoksa null

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

findText(searchPattern, from)

Belirli bir arama sonucundan başlayarak, belirtilen metin kalıbı için öğenin içeriğinde arama yapar.

JavaScript normal ifade özelliklerinin bir alt kümesi (ör. yakalama grupları ve mod değiştiricileri) 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
searchPatternStringmola vermek için
fromRangeElementarama yapılacak arama sonucunu

Return

RangeElement: Arama metninin sonraki konumunu veya eşleşme yoksa null değerini gösteren arama sonucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getAlignment()

HorizontalAlignment öğesini getirir.

Return

HorizontalAlignment - hizalama

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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ç, geçerli her öğe özelliği için bir özellik içeren bir nesnedir. Burada her özellik adı, DocumentApp.Attribute numaralandırmasındaki bir öğeye karşılık gelir.

var body = DocumentApp.getActiveDocument().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 özellikleridir.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
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

AdTürAçıklama
childIndexIntegeralt öğenin dizini

Return

Element - belirtilen dizindeki alt öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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

AdTürAçıklama
childElementdizini alınacak alt öğe

Return

Integer - alt dizin

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getGlyphType()

Liste öğesinin GlyphType öğesini getirir.

Return

GlyphType - glif türü

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getHeading()

ParagraphHeading öğesini getirir.

Return

ParagraphHeading — başlık

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getIndentEnd()

Son girintiyi punto cinsinden alır.

Return

Number — Nokta cinsinden bitiş girintisi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 nokta cinsinden alır.

Return

Number — ilk satır girintisi (punto cinsinden)

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 — başlangıç girintisi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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ı nokta cinsinden alır.

Return

Number — punto cinsinden satır aralığı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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: Bağlantı URL'si; öğe, bu özellik için birden fazla değer içeriyorsa null ifadesini içerir.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 - liste kimliği

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 seviyesini alır.

Varsayılan olarak, liste öğelerinin 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ı, aşağıdaki kapsamların biri 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 öğesini alır.

Bir sonraki kardeş 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 kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getNumChildren()

Alt öğe sayısını alır.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

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

Return

Integer - çocuk sayısı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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: Üst öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getPositionedImages()

Paragrafa sabitlenmiş PositionedImage nesnenin tümünü alır.

Return

PositionedImage[]: Konumlandırılmış resimlerin listesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 sahiptir ve geçerli öğeden önce gelir.

Return

Element: Önceki kardeş öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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 sonra punto cinsinden boşluk

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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 önce punto cinsinden boşluk

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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: Metin dizesi olarak öğenin içeriği

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

getTextAlignment()

Metin hizalamasını sağlar. 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 çok türde metin hizalaması içeriyorsa ya da metin hizalaması hiç ayarlanmadıysa null

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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.

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

// Obtain the first element in the document 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 kapsamların 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

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

Return

HorizontalRule — yeni yatay cetvel öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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şturur ve 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertInlineImage(childIndex, image)

Belirtilen InlineImage öğesini belirtilen dizine 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ı, aşağıdaki kapsamların 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 bulunamaz. Geçerli öğe bir tablo hücresinde yer alıyorsa 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertPageBreak(childIndex, pageBreak)

Belirtilen PageBreak öğesini belirtilen dizine ekler.

Not: PageBreaks, TableCells içinde bulunamaz. Geçerli öğe bir tablo hücresinde yer alıyorsa bir istisna atılır.

Parametreler

AdTürAçıklama
childIndexIntegeröğenin ekleneceği dizin
pageBreakPageBreakeklenecek p[yaş aralığı

Return

PageBreak: Eklenen sayfa sonu öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

AdTürAçıklama
childIndexIntegeröğenin ekleneceği dizin
textStringmetin içeriği

Return

Text - yeni metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

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

Return

Text - eklenen metin öğesi

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri 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 dokümanın sonunda olup olmadığı.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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ı getirir.

Return

Boolean: soldan sağa ayarı

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 eşdüzey öğe ile birleştirir.

Yalnızca aynı ElementType öğesinin öğeleri birleştirilebilir. Geçerli öğenin içerdiği tüm alt öğeler, önceki eşdüzey öğeye taşınır.

Geçerli öğe dokümandan kaldırılır.

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

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

Return

ListItem: Birleştirilmiş öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

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

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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.

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

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

Return

ListItem: Kaldırılan öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 bir PositionedImage kaldırılır.

Parametreler

AdTürAçıklama
idString

Return

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

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

replaceText(searchPattern, replacement)

Normal ifadeler kullanarak belirli bir metin kalıbının tüm tekrarlarını verilen bir yeni dizeyle değiştirir.

Arama kalıbı bir JavaScript normal ifade nesnesi olarak değil, bir dize olarak iletilir. Bu nedenle, kalıptaki ters eğik çizgileri kod dışına almanız gerekir.

Bu yöntem, Google'ın RE2 normal ifade kitaplığını kullanır. Bu kitaplık, desteklenen söz dizimini sınırlar.

Sağlanan normal ifade kalıbı, geçerli öğede bulunan her metin bloğuyla bağımsız olarak eşleştirilir.

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

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

Parametreler

AdTürAçıklama
searchPatternStringnormal ifade kalıbını
replacementStringmetin yerine

Return

Element - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

setAlignment(alignment)

HorizontalAlignment özelliğini ayarlar.

Parametreler

AdTürAçıklama
alignmentHorizontalAlignmentyatay hizalama

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 özellik parametresi, her özellik adının DocumentApp.Attribute numaralandırmasındaki bir öğe ve her özellik değerinin ise uygulanacak yeni değer olduğu bir nesne olmalıdır.

var body = DocumentApp.getActiveDocument().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

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

Return

ListItem: Geçerli öğe.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 özelliğini ayarlar.

Parametreler

AdTürAçıklama
glyphTypeGlyphTypeglif türü

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

setHeading(heading)

ParagraphHeading özelliğini ayarlar.

Parametreler

AdTürAçıklama
headingParagraphHeadingbaşlık

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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

setIndentEnd(indentEnd)

Bitiş girintisini punto cinsinden ayarlar.

Parametreler

AdTürAçıklama
indentEndNumbernokta cinsinden son girinti

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 punto cinsinden ayarlar.

Parametreler

AdTürAçıklama
indentFirstLineNumbernokta cinsinden ilk satır girintisi

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 punto cinsinden ayarlar.

Parametreler

AdTürAçıklama
indentStartNumberpunto cinsinden başlangıç girintisi

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

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

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

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

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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

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

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 ayarlandı. İki ListItems aynı listenin üyeleri olarak değerlendirilir.

Parametreler

AdTürAçıklama
listItemListItemliste kimliği kullanılacak liste öğesi

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 seviyesini ayarlar.

Varsayılan olarak, liste öğelerinin 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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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 boşluk (punto cinsinden)

Return

ListItem - geçerli öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

  • 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ı, aşağıdaki kapsamların 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

AdTürAçıklama
textStringyeni metin içeriği

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların 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 şunlardır: DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ve DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().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ı, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:

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