Dipnot bölümünü temsil eden bir öğe. Footnote
, Footnote
'a karşılık gelen metni içerir. Footnote
, List
veya Paragraph
öğ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öntem | Dönüş türü | Kısa açıklama |
---|---|---|
append | Paragraph | Belirtilen Paragraph değerini ekler. |
append | Paragraph | Belirtilen metin içeriklerini içeren yeni bir Paragraph oluşturur ve ekler. |
clear() | Footnote | Öğenin içeriğini temizler. |
copy() | Footnote | Geçerli öğenin ayrılmış, derin bir kopyasını döndürür. |
edit | Text | Düzenlemek için mevcut öğenin Text sürümünü alır. |
find | Range | Öğenin içeriğini, belirtilen türün bir alt öğesi için arar. |
find | Range | Belirtilen Range öğesinden başlayarak öğenin içeriğini, belirtilen türün bir alt öğesi için arar. |
find | Range | Normal ifadeleri kullanarak öğenin içeriğinde belirtilen metin kalıbını arar. |
find | Range | Belirli bir arama sonucundan başlayarak öğenin içeriğini belirtilen metin kalıbıyla arar. |
get | Object | Öğenin özelliklerini alır. |
get | Element | Belirtilen alt öğe dizininde alt öğeyi alır. |
get | Integer | Belirtilen alt öğenin alt öğe dizini döndürülür. |
get | Element | Öğenin sonraki kardeş öğesini alır. |
get | Integer | Çocuk sayısını alır. |
get | Paragraph[] | Bölümde bulunan tüm Paragraphs öğelerini (List dahil) alır. |
get | Container | Öğenin üst öğesini alır. |
get | Element | Öğenin önceki kardeş öğesini alır. |
get | String | Öğenin içeriğini metin dizesi olarak alır. |
get | Text | Metin hizalamasını alır. |
get | Element | Öğenin Element değerini alır. |
insert | Paragraph | Belirtilen Paragraph öğesini belirtilen dizin içine ekler. |
insert | Paragraph | Belirtilen dizinde, belirtilen metin içeriklerini içeren yeni bir Paragraph oluşturup ekler. |
remove | Footnote | Belirtilen alt öğeyi kaldırır. |
remove | Footnote | Öğeyi üst öğesinden kaldırır. |
replace | Element | Normal ifadeler kullanılarak belirli bir metin kalıbının tüm örnekleri belirli bir değiştirme dizesiyle değiştirilir. |
set | Footnote | Öğenin özelliklerini ayarlar. |
set | Footnote | İçeriği düz metin olarak ayarlar. |
set | Footnote | Metin hizalamasını ayarlar. |
Ayrıntılı dokümanlar
append Paragraph(paragraph)
Belirtilen Paragraph
değerini ekler.
Mevcut bir Paragraph
öğesinin kopyasını eklerken append
öğesinin bu sürümünü kullanın.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
paragraph | Paragraph | Eklenecek 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
append Paragraph(text)
Belirtilen metin içeriklerini içeren yeni bir Paragraph
oluşturur ve ekler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
text | String | Paragrafı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
clear()
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
Footnote
: 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
edit As Text()
Düzenlemek için mevcut öğenin Text
sürümünü alır.
Öğe içeriklerini zengin metin olarak değiştirmek için edit
öğesini kullanın. edit
modu, metin olmayan öğeleri (Inline
ve Horizontal
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ü
find Element(elementType)
Öğenin içeriğini, belirtilen türün bir alt öğesi için arar.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
element | Element | Aranacak öğe türü. |
Return
Range
: 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
find Element(elementType, from)
Belirtilen Range
öğ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
Ad | Tür | Açıklama |
---|---|---|
element | Element | Aranacak öğe türü. |
from | Range | Arama yapılacak arama sonucu. |
Return
Range
: 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
find Text(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
Ad | Tür | Açıklama |
---|---|---|
search | String | aranacak kalıp |
Return
Range
: 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
find Text(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
Ad | Tür | Açıklama |
---|---|---|
search | String | aranacak kalıp |
from | Range | Arama yapılacak arama sonucu |
Return
Range
: 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
get Attributes()
Öğenin özelliklerini alır.
Sonuç, her geçerli öğe özelliği için bir özellik içeren bir nesnedir. Bu nesnedeki her özellik adı, Document
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
get Child(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
Ad | Tür | Açıklama |
---|---|---|
child | Integer | Alı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
get Child Index(child)
Belirtilen alt öğenin alt öğe dizini döndürülür.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
child | Element | Dizininin 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
get Next Sibling()
Öğenin sonraki kardeş öğesini alır.
Bir sonraki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeyi takip eder.
Return
Element
: Sonraki kardeş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Num Children()
Ç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
get Paragraphs()
Bölümde bulunan tüm Paragraphs
öğelerini (List
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
get Parent()
Öğenin üst öğesini alır.
Üst öğe, geçerli öğeyi içerir.
Return
Container
: Ü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
get Previous Sibling()
Öğenin önceki kardeş öğesini alır.
Önceki kardeş öğe, aynı üst öğeye sahiptir ve geçerli öğeden önce gelir.
Return
Element
: Önceki kardeş öğe.
Yetkilendirme
Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
Öğ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
get Text Alignment()
Metin hizalamasını alır. Kullanılabilir hizalama türleri Document
, Document
ve Document
'dir.
Return
Text
: 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
get Type()
Öğenin Element
değerini alır.
Belirli bir öğenin tam türünü belirlemek için get
öğ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
Element
: Öğ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
insert Paragraph(childIndex, paragraph)
Belirtilen Paragraph
öğesini belirtilen dizin içine ekler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
child | Integer | Eklemenin yapılacağı dizin. |
paragraph | Paragraph | Eklenecek 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
insert Paragraph(childIndex, text)
Belirtilen dizinde, belirtilen metin içeriklerini içeren yeni bir Paragraph
oluşturup ekler.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
child | Integer | Eklemenin yapılacağı dizin. |
text | String | Paragrafı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
remove Child(child)
Belirtilen alt öğeyi kaldırır.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
child | Element | Kaldırılacak alt öğe. |
Return
Footnote
: 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
remove From Parent()
Öğ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
Footnote
: 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
replace Text(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
Ad | Tür | Açıklama |
---|---|---|
search | String | Aranacak normal ifade kalıbı |
replacement | String | Değ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
set Attributes(attributes)
Öğenin özelliklerini ayarlar.
Belirtilen attributes parametresi, her bir özellik adının Document
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
Ad | Tür | Açıklama |
---|---|---|
attributes | Object | Öğenin özellikleri. |
Return
Footnote
: 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
set Text(text)
İçeriği düz metin olarak ayarlar.
Not: Mevcut içerikler silinir.
Parametreler
Ad | Tür | Açıklama |
---|---|---|
text | String | Yeni metin içerikleri. |
Return
Footnote
: 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
set Text Alignment(textAlignment)
Metin hizalamasını ayarlar. Kullanılabilir hizalama türleri Document
, Document
ve Document
'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
Ad | Tür | Açıklama |
---|---|---|
text | Text | uygulanacak metin hizalamasının türü |
Return
Footnote
: 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