Class HeaderSection

HeaderSection

Başlık bölümünü temsil eden bir öğe. Document genellikle en fazla bir HeaderSection içerir. HeaderSection, ListItem, Paragraph ve Table öğeleri içerebilir. Belge yapısı hakkında daha fazla bilgi için Google Dokümanlar'ı genişletme kılavuzuna bakın.

Yöntemler

YöntemDönüş türüKısa açıklama
appendHorizontalRule()HorizontalRuleYeni bir HorizontalRule oluşturup ekler.
appendImage(image)InlineImageBelirtilen resim blob'undan yeni bir InlineImage oluşturup ekler.
appendImage(image)InlineImageBelirtilen InlineImage değerini ekler.
appendListItem(listItem)ListItemBelirtilen ListItem değerini ekler.
appendListItem(text)ListItemBelirtilen metin içeriklerini içeren yeni bir ListItem oluşturur ve ekler.
appendParagraph(paragraph)ParagraphBelirtilen Paragraph değerini ekler.
appendParagraph(text)ParagraphBelirtilen metin içeriklerini içeren yeni bir Paragraph oluşturur ve ekler.
appendTable()TableYeni bir Table oluşturup ekler.
appendTable(cells)TableBelirtilen her dize değeri için TableCell içeren yeni bir Table ekler.
appendTable(table)TableBelirtilen Table değerini ekler.
clear()HeaderSectionÖğenin içeriğini temizler.
copy()HeaderSectionGeç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.
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.
getImages()InlineImage[]Bölümdeki tüm InlineImages öğelerini alır.
getListItems()ListItem[]Bölümdeki tüm ListItems öğelerini alır.
getNumChildren()IntegerÇocuk sayısını alır.
getParagraphs()Paragraph[]Bölümde bulunan tüm Paragraphs öğelerini (ListItems dahil) alır.
getParent()ContainerElementÖğenin üst öğesini alır.
getTables()Table[]Bölümdeki tüm Tables öğelerini 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 yeni bir HorizontalRule oluşturup ekler.
insertImage(childIndex, image)InlineImageBelirtilen resim blob'undan, belirtilen dizinde bir InlineImage oluşturup ekler.
insertImage(childIndex, image)InlineImageBelirtilen InlineImage öğesini belirtilen dizin içine ekler.
insertListItem(childIndex, listItem)ListItemBelirtilen ListItem öğesini belirtilen dizin içine ekler.
insertListItem(childIndex, text)ListItemBelirtilen dizinde, belirtilen metin içeriklerini içeren yeni bir ListItem oluşturup ekler.
insertParagraph(childIndex, paragraph)ParagraphBelirtilen Paragraph öğesini belirtilen dizin içine ekler.
insertParagraph(childIndex, text)ParagraphBelirtilen dizinde, belirtilen metin içeriklerini içeren yeni bir Paragraph oluşturup ekler.
insertTable(childIndex)TableBelirtilen dizinde yeni bir Table oluşturup ekler.
insertTable(childIndex, cells)TableBelirtilen dizinde, belirtilen hücreleri içeren yeni bir Table oluşturup ekler.
insertTable(childIndex, table)TableBelirtilen Table öğesini belirtilen dizin içine ekler.
removeChild(child)HeaderSectionBelirtilen alt öğeyi kaldırır.
removeFromParent()HeaderSectionÖğeyi üst öğesinden 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.
setAttributes(attributes)HeaderSectionÖğenin özelliklerini ayarlar.
setText(text)HeaderSectionİçeriği düz metin olarak ayarlar.
setTextAlignment(textAlignment)HeaderSectionMetin hizalamasını ayarlar.

Ayrıntılı dokümanlar

appendHorizontalRule()

Yeni bir HorizontalRule oluşturup ekler.

HorizontalRule, yeni bir Paragraph içinde yer alır.

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

appendImage(image)

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

Resim yeni bir Paragraph içinde yer alır.

Parametreler

AdTürAçıklama
imageBlobSourceResim verileri.

Return

InlineImage: Eklenmiş 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

appendImage(image)

Belirtilen InlineImage değerini ekler.

InlineImage, yeni bir Paragraph içinde yer alır.

Mevcut bir InlineImage öğesinin kopyasını eklerken appendImage öğesinin bu sürümünü kullanın.

Parametreler

AdTürAçıklama
imageInlineImageResim verileri.

Return

InlineImage: Eklenmiş 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

appendListItem(listItem)

Belirtilen ListItem değerini ekler.

Mevcut bir ListItem öğesinin kopyasını eklerken appendListItem öğesinin bu sürümünü kullanın.

Parametreler

AdTürAçıklama
listItemListItemEklenecek liste öğesi.

Return

ListItem: Eklenen liste öğ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

appendListItem(text)

Belirtilen metin içeriklerini içeren yeni bir ListItem oluşturur ve ekler.

Ardışık liste öğeleri aynı listenin parçası olarak eklenir.

Parametreler

AdTürAçıklama
textStringListe öğesinin metin içeriği.

Return

ListItem: Yeni liste öğ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

appendParagraph(paragraph)

Belirtilen Paragraph değerini ekler.

Mevcut bir Paragraph öğesinin kopyasını eklerken appendParagraph öğesinin bu sürümünü kullanın.

Parametreler

AdTürAçıklama
paragraphParagraphEklenecek paragraf.

Return

Paragraph: Eklenen paragraf.

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

appendParagraph(text)

Belirtilen metin içeriklerini içeren yeni bir Paragraph oluşturur ve ekler.

Parametreler

AdTürAçıklama
textStringParagrafın metin içeriği.

Return

Paragraph: Yeni paragraf.

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

appendTable()

Yeni bir Table oluşturup ekler.

Google Dokümanlar dokümanları tabloyla sonlanamayacağından bu yöntem, tablodan sonra boş bir paragraf da ekler.

Return

Table: Yeni tablo.

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

appendTable(cells)

Belirtilen her dize değeri için TableCell içeren yeni bir Table ekler.

Google Dokümanlar dokümanları tabloyla sonlanamayacağından bu yöntem, tablodan sonra boş bir paragraf da ekler.

Parametreler

AdTürAçıklama
cellsString[][]Yeni tabloya eklenecek tablo hücrelerinin metin içerikleri.

Return

Table: Eklenen tablo.

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

appendTable(table)

Belirtilen Table değerini ekler.

Mevcut bir Table öğesinin kopyasını eklerken appendTable öğesinin bu sürümünü kullanın. Google Dokümanlar dokümanları tabloyla sonlanamayacağından bu yöntem, tablodan sonra boş bir paragraf da ekler.

Parametreler

AdTürAçıklama
tableTableEklenecek tablo.

Return

Table: Eklenen tablo.

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

HeaderSection: 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

HeaderSection: 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

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

getImages()

Bölümdeki tüm InlineImages öğelerini alır.

Return

InlineImage[]: Bölüm resimleri.

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

getListItems()

Bölümdeki tüm ListItems öğelerini alır.

Return

ListItem[]: Bölüm listesi öğeleri.

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

getParagraphs()

Bölümde bulunan tüm Paragraphs öğelerini (ListItems dahil) alır.

Return

Paragraph[]: Bölüm paragrafları.

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

getTables()

Bölümdeki tüm Tables öğelerini alır.

Return

Table[]: Bölüm tabloları.

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 yeni bir HorizontalRule oluşturup ekler.

HorizontalRule, yeni bir Paragraph içinde yer alır.

Parametreler

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

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

insertImage(childIndex, image)

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

Parametreler

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

Return

InlineImage: Eklenen satır içi 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

insertImage(childIndex, image)

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

Resim yeni bir Paragraph içinde yer alır.

Parametreler

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

Return

InlineImage: Eklenen satır içi 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

insertListItem(childIndex, listItem)

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

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.
listItemListItemEklenecek liste öğesi.

Return

ListItem: Eklenen liste öğ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

insertListItem(childIndex, text)

Belirtilen dizinde, belirtilen metin içeriklerini içeren yeni bir ListItem oluşturup ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.
textStringListe öğesinin metin içeriği.

Return

ListItem: Yeni liste öğ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

insertParagraph(childIndex, paragraph)

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

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.
paragraphParagraphEklenecek paragraf.

Return

Paragraph: Eklenen paragraf.

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

insertParagraph(childIndex, text)

Belirtilen dizinde, belirtilen metin içeriklerini içeren yeni bir Paragraph oluşturup ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.
textStringParagrafın metin içeriği.

Return

Paragraph: Yeni paragraf.

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

insertTable(childIndex)

Belirtilen dizinde yeni bir Table oluşturup ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.

Return

Table: Yeni tablo.

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

insertTable(childIndex, cells)

Belirtilen dizinde, belirtilen hücreleri içeren yeni bir Table oluşturup ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.
cellsString[][]Yeni tabloya eklenecek tablo hücrelerinin metin içerikleri.

Return

Table: Yeni tablo.

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

insertTable(childIndex, table)

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

Parametreler

AdTürAçıklama
childIndexIntegerEklemenin yapılacağı dizin.
tableTableEklenecek tablo.

Return

Table: Eklenen tablo.

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

HeaderSection: 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

HeaderSection: 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

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

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

HeaderSection: 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)

İçeriği düz metin olarak ayarlar.

Not: Mevcut içerikler silinir.

Parametreler

AdTürAçıklama
textStringYeni metin içerikleri.

Return

HeaderSection: 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

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

HeaderSection: 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

Kullanımdan kaldırılan yöntemler