Class FootnoteSection

FootnoteSection

Bir dipnot bölümünü temsil eden öğe. Bir FootnoteSection, Footnote ile eşleşen metni içerir. FootnoteSection, ListItem veya Paragraph öğeleri 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
appendParagraph(paragraph)ParagraphBelirtilen Paragraph eklenir.
appendParagraph(text)ParagraphBelirtilen metin içeriklerini içeren yeni bir Paragraph oluşturur ve ekler.
clear()FootnoteSectionÖğenin içeriğini temizler.
copy()FootnoteSectionGeç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.
getNextSibling()Element|nullÖğenin sonraki kardeş öğesini 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.
getPreviousSibling()Element|nullÖğenin önceki kardeş öğesini 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.
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.
removeChild(child)FootnoteSectionBelirtilen alt öğeyi kaldırır.
removeFromParent()FootnoteSection|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)FootnoteSectionÖğenin özelliklerini ayarlar.
setText(text)FootnoteSectionİçeriği düz metin olarak ayarlar.
setTextAlignment(textAlignment)FootnoteSectionMetin hizalamasını ayarlar.

Ayrıntılı belgeler

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

clear()

Öğenin içeriğini temizler.

Return

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

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

getNextSibling()

Öğenin sonraki kardeş öğesini alır.

Bir sonraki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeyi takip eder.

Return

Element|null: Sonraki kardeş öğe.

Yetkilendirme

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

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

getNumChildren()

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

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

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

Return

Integer: Çocuk sayısı.

Yetkilendirme

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

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

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

getPreviousSibling()

Öğenin önceki kardeş öğesini alır.

Önceki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeden önce gelir.

Return

Element|null: Önceki kardeş öğe.

Yetkilendirme

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

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

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

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

removeChild(child)

Belirtilen alt öğeyi kaldırır.

Parametreler

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

Return

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

FootnoteSection|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

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

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

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