Class HeaderSection

HeaderSection

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

Yöntemler

YöntemDönüş türüKısa açıklama
appendHorizontalRule()HorizontalRuleYeni bir HorizontalRule oluşturur ve ekler.
appendImage(image)InlineImageBelirtilen resim blob'undan yeni bir InlineImage oluşturur ve ekler.
appendImage(image)InlineImageBelirtilen InlineImage eklenir.
appendListItem(listItem)ListItemBelirtilen ListItem eklenir.
appendListItem(text)ListItemBelirtilen metin içeriklerini içeren yeni bir ListItem oluşturur ve ekler.
appendParagraph(paragraph)ParagraphBelirtilen Paragraph eklenir.
appendParagraph(text)ParagraphBelirtilen metin içeriklerini içeren yeni bir Paragraph oluşturur ve ekler.
appendTable()TableYeni bir Table oluşturur ve ekler.
appendTable(cells)TableBelirtilen her dize değeri için TableCell içeren yeni bir Table ekler.
appendTable(table)TableBelirtilen Table eklenir.
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|nullÖğenin içeriğinde, belirtilen türde bir alt öğe arar.
findElement(elementType, from)RangeElement|nullBelirtilen RangeElement ile başlayarak, belirtilen türde bir alt öğe için öğenin içeriğini arar.
findText(searchPattern)RangeElement|nullNormal ifadeleri kullanarak öğenin içeriğinde belirtilen metin kalıbını arar.
findText(searchPattern, from)RangeElement|nullBelirtilen metin kalıbını, belirli bir arama sonucundan başlayarak öğenin içeriğinde arar.
getAttributes()ObjectÖğenin özelliklerini alır.
getChild(childIndex)ElementBelirtilen alt dizindeki alt öğeyi alır.
getChildIndex(child)IntegerBelirtilen alt öğenin alt dizinini alır.
getImages()InlineImage[]|nullBölümde bulunan tüm InlineImages öğelerini alır.
getListItems()ListItem[]|nullBölümde bulunan tüm ListItems öğelerini alır.
getNumChildren()IntegerÇocuk sayısını alır.
getParagraphs()Paragraph[]|nullBölümde bulunan tüm Paragraphs öğelerini (ListItems dahil) alır.
getParent()ContainerElement|nullÖğenin üst öğesini alır.
getTables()Table[]|nullBölümde bulunan tüm Tables öğelerini alır.
getText()StringÖğenin içeriğini metin dizesi olarak alır.
getTextAlignment()TextAlignment|nullMetin hizalamasını alır.
getType()ElementTypeÖğenin ElementType değerini alır.
insertHorizontalRule(childIndex)HorizontalRuleBelirtilen dizinde yeni bir HorizontalRule oluşturur ve ekler.
insertImage(childIndex, image)InlineImageBelirtilen görüntü blob'undan belirtilen dizinde bir InlineImage oluşturur ve ekler.
insertImage(childIndex, image)InlineImageBelirtilen dizine verilen InlineImage öğesini ekler.
insertListItem(childIndex, listItem)ListItemBelirtilen dizine verilen ListItem öğesini ekler.
insertListItem(childIndex, text)ListItemBelirtilen dizinde, belirtilen metin içeriğini içeren yeni bir ListItem oluşturup ekler.
insertParagraph(childIndex, paragraph)ParagraphBelirtilen dizine verilen Paragraph öğesini ekler.
insertParagraph(childIndex, text)ParagraphBelirtilen dizinde, belirtilen metin içeriğini içeren yeni bir Paragraph oluşturup ekler.
insertTable(childIndex)TableBelirtilen dizinde yeni bir Table oluşturur ve ekler.
insertTable(childIndex, cells)TableBelirtilen hücreleri içeren yeni bir Table oluşturup belirtilen dizine ekler.
insertTable(childIndex, table)TableBelirtilen dizine verilen Table öğesini ekler.
removeChild(child)HeaderSectionBelirtilen alt öğeyi kaldırır.
removeFromParent()HeaderSection|nullÖğeyi üst öğesinden kaldırır.
replaceText(searchPattern, replacement)ElementNormal ifadeleri kullanarak belirli bir metin kalıbının tüm örneklerini belirli bir yeni dizeyle değiştirir.
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ı belgeler

appendHorizontalRule()

Yeni bir HorizontalRule oluşturur ve ekler.

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

Return

HorizontalRule — Yeni yatay kural.

Yetkilendirme

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

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

appendImage(image)

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

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

Parametreler

AdTürAçıklama
imageBlobSourceResim verileri.

Return

InlineImage: Eklenen resim.

Yetkilendirme

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

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

appendImage(image)

Belirtilen InlineImage eklenir.

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

Mevcut bir InlineImage kopyasını eklerken appendImage'nın bu sürümünü kullanın.

Parametreler

AdTürAçıklama
imageInlineImageResim verileri.

Return

InlineImage: Eklenen resim.

Yetkilendirme

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

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

appendListItem(listItem)

Belirtilen ListItem eklenir.

Mevcut bir ListItem kopyasını eklerken appendListItem'nın 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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

Return

ListItem: Yeni liste öğesi.

Yetkilendirme

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

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

appendParagraph(paragraph)

Belirtilen Paragraph eklenir.

Mevcut bir Paragraph kopyasını eklerken appendParagraph'nın bu sürümünü kullanın.

Parametreler

AdTürAçıklama
paragraphParagraphEklenecek paragraf.

Return

Paragraph: Eklenen paragraf.

Yetkilendirme

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

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

appendParagraph(text)

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

Parametreler

AdTürAçıklama
textStringParagrafın metin içerikleri.

Return

Paragraph: Yeni paragraf.

Yetkilendirme

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

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

appendTable()

Yeni bir Table oluşturur ve ekler.

Google Dokümanlar belgeleri tabloyla bitirilemediğinden bu yöntem, tablonun sonuna boş bir paragraf da ekler.

Return

Table: Yeni tablo.

Yetkilendirme

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

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

appendTable(cells)

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

Google Dokümanlar belgeleri tabloyla bitirilemediğinden bu yöntem, tablonun sonuna 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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

appendTable(table)

Belirtilen Table eklenir.

Mevcut bir Table kopyasını eklerken appendTable'nın bu sürümünü kullanın. Google Dokümanlar belgeleri tabloyla bitirilemediğinden bu yöntem, tablonun sonuna boş bir paragraf da ekler.

Parametreler

AdTürAçıklama
tableTableEklenecek tablo.

Return

Table: Eklenen tablo.

Yetkilendirme

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

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

clear()

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

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

editAsText()

Düzenlemek için mevcut öğenin Text sürümünü alır.

Öğelerin içeriğini zengin metin olarak değiştirmek için editAsText kullanın. editAsText modu, metin olmayan öğeleri (ör. InlineImage ve HorizontalRule) yoksayar.

Silinen metin aralığında tamamen yer alan alt öğeler, öğeden kaldırılır. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Return

Text: Geçerli öğenin metin sürümü

findElement(elementType)

Öğenin içeriğinde, belirtilen türde bir alt öğe arar.

Parametreler

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

Return

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

Yetkilendirme

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

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

findElement(elementType, from)

Belirtilen RangeElement ile başlayarak, belirtilen türde bir alt öğe için öğenin içeriğini arar. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parametreler

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

Return

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

Yetkilendirme

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

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

findText(searchPattern)

Normal ifadeleri kullanarak öğenin içeriğinde belirtilen metin kalıbını arar.

JavaScript normal ifade özelliklerinin bir alt kümesi (ör. yakalama grupları ve mod değiştiriciler) tam olarak desteklenmez.

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

Parametreler

AdTürAçıklama
searchPatternStringAranacak desen

Return

RangeElement|null — arama metninin konumunu gösteren bir arama sonucu veya eşleşme yoksa null

Yetkilendirme

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

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

findText(searchPattern, from)

Belirtilen metin kalıbını, belirli bir arama sonucundan başlayarak öğenin içeriğinde arar.

JavaScript normal ifade özelliklerinin bir alt kümesi (ör. yakalama grupları ve mod değiştiriciler) tam olarak desteklenmez.

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

Parametreler

AdTürAçıklama
searchPatternStringAranacak desen
fromRangeElementArama yapılacak arama sonucu

Return

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

Yetkilendirme

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

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

getAttributes()

Öğenin özelliklerini alır.

Sonuç, her geçerli öğe özelliği için bir özellik içeren bir nesnedir. Her özellik adı, DocumentApp.Attribute numaralandırmasındaki bir öğeye karşılık gelir. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Return

Object: Öğenin özellikleri.

Yetkilendirme

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

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

getChild(childIndex)

Belirtilen alt dizindeki alt öğeyi alır. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parametreler

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

Return

Element: Belirtilen dizindeki alt öğe.

Yetkilendirme

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

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

getChildIndex(child)

Belirtilen alt öğenin alt dizinini alır.

Parametreler

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

Return

Integer: Çocuk dizini.

Yetkilendirme

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

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

getImages()

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

Return

InlineImage[]|null: Bölüm resimleri.

Yetkilendirme

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

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

getListItems()

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

Return

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

Yetkilendirme

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

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

getNumChildren()

Çocuk sayısını alır. 

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Return

Integer: Çocuk sayısı.

Yetkilendirme

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

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

getParagraphs()

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

Return

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

Yetkilendirme

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

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

getParent()

Öğenin üst öğesini alır.

Üst öğe, geçerli öğeyi içerir.

Return

ContainerElement|null: Üst öğe.

Yetkilendirme

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

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

getTables()

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

Return

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

Yetkilendirme

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

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

getText()

Öğenin içeriğini metin dizesi olarak alır.

Return

String: Öğenin metin dizesi olarak içeriği

Yetkilendirme

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

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

getTextAlignment()

Metin hizalamasını alır. Kullanılabilir hizalama türleri DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ve DocumentApp.TextAlignment.SUPERSCRIPT'dir.

Return

TextAlignment|null: Metin hizalama türü veya metin birden fazla metin hizalama türü içeriyorsa ya da metin hizalama hiç ayarlanmamışsa null

Yetkilendirme

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

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

getType()

Öğenin ElementType değerini alır.

Belirli bir öğenin tam türünü belirlemek için getType() kullanın. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Return

ElementType: Öğe türü.

Yetkilendirme

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

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

insertHorizontalRule(childIndex)

Belirtilen dizinde yeni bir HorizontalRule oluşturur ve 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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertImage(childIndex, image)

Belirtilen görüntü blob'undan belirtilen dizinde 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.

Yetkilendirme

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

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

insertImage(childIndex, image)

Belirtilen dizine verilen InlineImage öğesini 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ı, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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

insertListItem(childIndex, listItem)

Belirtilen dizine verilen ListItem öğesini ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEkleme yapılacak dizin.
listItemListItemEklenecek liste öğesi.

Return

ListItem: Eklenen liste öğesi.

Yetkilendirme

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

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

insertListItem(childIndex, text)

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

Parametreler

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

Return

ListItem: Yeni liste öğesi.

Yetkilendirme

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

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

insertParagraph(childIndex, paragraph)

Belirtilen dizine verilen Paragraph öğesini ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEkleme yapılacak dizin.
paragraphParagraphEklenecek paragraf.

Return

Paragraph: Eklenen paragraf.

Yetkilendirme

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

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

insertParagraph(childIndex, text)

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

Parametreler

AdTürAçıklama
childIndexIntegerEkleme yapılacak dizin.
textStringParagrafın metin içerikleri.

Return

Paragraph: Yeni paragraf.

Yetkilendirme

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

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

insertTable(childIndex)

Belirtilen dizinde yeni bir Table oluşturur ve ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEkleme yapılacak dizin.

Return

Table: Yeni tablo.

Yetkilendirme

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

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

insertTable(childIndex, cells)

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

Parametreler

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

Return

Table: Yeni tablo.

Yetkilendirme

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

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

insertTable(childIndex, table)

Belirtilen dizine verilen Table öğesini ekler.

Parametreler

AdTürAçıklama
childIndexIntegerEkleme yapılacak dizin.
tableTableEklenecek tablo.

Return

Table: Eklenen tablo.

Yetkilendirme

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

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

removeChild(child)

Belirtilen alt öğeyi kaldırır.

Parametreler

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

Return

HeaderSection: Geçerli öğe.

Yetkilendirme

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

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

removeFromParent()

Öğeyi üst öğesinden kaldırır. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Return

HeaderSection|null: Kaldırılan öğe.

Yetkilendirme

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

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

replaceText(searchPattern, replacement)

Normal ifadeleri kullanarak belirli bir metin kalıbının tüm örneklerini belirli bir yeni dizeyle değiştirir.

Arama kalıbı, JavaScript normal ifade nesnesi olarak değil, dize olarak iletilir. Bu nedenle, desendeki tüm ters eğik çizgileri çıkış karakteriyle belirtmeniz gerekir.

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

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

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

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

Parametreler

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

Return

Element: Geçerli öğe

Yetkilendirme

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

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

setAttributes(attributes)

Öğenin özelliklerini ayarlar.

Belirtilen özellikler parametresi, her özellik adının DocumentApp.Attribute numaralandırmasındaki bir öğe ve her özellik değerinin uygulanacak yeni değer olduğu bir nesne olmalıdır. 

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parametreler

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

Return

HeaderSection: Geçerli öğe.

Yetkilendirme

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

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

setText(text)

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

Not: Mevcut içerikler temizlenir.

Parametreler

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

Return

HeaderSection: Geçerli öğe.

Yetkilendirme

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

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

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 hizalama türü

Return

HeaderSection: Geçerli öğe

Yetkilendirme

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

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

Kullanımdan kaldırılan yöntemler