Class HeaderSection

हेडरसेक्शन

हेडर सेक्शन को दिखाने वाला एलिमेंट. आम तौर पर, किसी Document में ज़्यादा से ज़्यादा एक HeaderSection होता है. HeaderSection में ListItem, Paragraph, और Table एलिमेंट हो सकते हैं. दस्तावेज़ के स्ट्रक्चर के बारे में ज़्यादा जानने के लिए, Google Docs को बड़ा करने के बारे में गाइड देखें.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
appendHorizontalRule()HorizontalRuleनया HorizontalRule बनाता है और उसे जोड़ता है.
appendImage(image)InlineImageतय की गई इमेज ब्लॉब से नया InlineImage बनाता है और उसे जोड़ता है.
appendImage(image)InlineImageदिए गए InlineImage को जोड़ता है.
appendListItem(listItem)ListItemदिए गए ListItem को जोड़ता है.
appendListItem(text)ListItemतय किए गए टेक्स्ट कॉन्टेंट वाला नया ListItem बनाता है और उसे जोड़ता है.
appendParagraph(paragraph)Paragraphदिए गए Paragraph को जोड़ता है.
appendParagraph(text)Paragraphतय किए गए टेक्स्ट कॉन्टेंट वाला नया Paragraph बनाता है और उसे जोड़ता है.
appendTable()Tableनया Table बनाता है और उसे जोड़ता है.
appendTable(cells)Tableतय की गई हर स्ट्रिंग वैल्यू के लिए, TableCell वाला नया Table जोड़ता है.
appendTable(table)Tableदिए गए Table को जोड़ता है.
clear()HeaderSectionएलिमेंट का कॉन्टेंट हटा देता है.
copy()HeaderSectionमौजूदा एलिमेंट की डीप कॉपी दिखाता है.
editAsText()Textबदलाव करने के लिए, मौजूदा एलिमेंट का Text वर्शन पाता है.
findElement(elementType)RangeElementएलिमेंट के कॉन्टेंट में, बताए गए टाइप के डिसेंटेंट को खोजता है.
findElement(elementType, from)RangeElementएलिमेंट के कॉन्टेंट में, तय किए गए RangeElement से शुरू होकर, तय किए गए टाइप के डिसेंटेंट को खोजता है.
findText(searchPattern)RangeElementरेगुलर एक्सप्रेशन का इस्तेमाल करके, एलिमेंट के कॉन्टेंट में दिए गए टेक्स्ट पैटर्न को खोजता है.
findText(searchPattern, from)RangeElementकिसी खोज के नतीजे से शुरू करके, एलिमेंट के कॉन्टेंट में दिए गए टेक्स्ट पैटर्न को खोजता है.
getAttributes()Objectएलिमेंट के एट्रिब्यूट दिखाता है.
getChild(childIndex)Elementबताए गए चाइल्ड इंडेक्स पर चाइल्ड एलिमेंट को वापस लाता है.
getChildIndex(child)Integerबताए गए चाइल्ड एलिमेंट के लिए चाइल्ड इंडेक्स को वापस लाता है.
getImages()InlineImage[]सेक्शन में मौजूद सभी InlineImages को वापस लाता है.
getListItems()ListItem[]सेक्शन में मौजूद सभी ListItems को वापस लाता है.
getNumChildren()Integerबच्चों की संख्या दिखाता है.
getParagraphs()Paragraph[]सेक्शन में मौजूद सभी Paragraphs को वापस लाता है. इनमें ListItems भी शामिल है.
getParent()ContainerElementएलिमेंट का पैरंट एलिमेंट दिखाता है.
getTables()Table[]सेक्शन में मौजूद सभी Tables को वापस लाता है.
getText()Stringएलिमेंट के कॉन्टेंट को टेक्स्ट स्ट्रिंग के तौर पर दिखाता है.
getTextAlignment()TextAlignmentटेक्स्ट अलाइनमेंट की जानकारी मिलती है.
getType()ElementTypeएलिमेंट का ElementType दिखाता है.
insertHorizontalRule(childIndex)HorizontalRuleतय किए गए इंडेक्स पर एक नया HorizontalRule बनाता है और उसे डालता है.
insertImage(childIndex, image)InlineImageतय किए गए इंडेक्स पर, तय की गई इमेज ब्लॉब से InlineImage बनाता है और उसे शामिल करता है.
insertImage(childIndex, image)InlineImageदिए गए इंडेक्स में, दिया गया InlineImage डालता है.
insertListItem(childIndex, listItem)ListItemदिए गए इंडेक्स में, दिया गया ListItem डालता है.
insertListItem(childIndex, text)ListItemतय किए गए इंडेक्स में एक नया ListItem बनाता है और उसे शामिल करता है. इसमें तय किए गए टेक्स्ट कॉन्टेंट होते हैं.
insertParagraph(childIndex, paragraph)Paragraphदिए गए इंडेक्स में, दिया गया Paragraph डालता है.
insertParagraph(childIndex, text)Paragraphतय किए गए इंडेक्स में एक नया Paragraph बनाता है और उसे शामिल करता है. इसमें तय किए गए टेक्स्ट कॉन्टेंट होते हैं.
insertTable(childIndex)Tableतय किए गए इंडेक्स पर एक नया Table बनाता है और उसे डालता है.
insertTable(childIndex, cells)Tableतय किए गए इंडेक्स में, तय की गई सेल वाला नया Table बनाता है और उसे डालता है.
insertTable(childIndex, table)Tableदिए गए इंडेक्स में, दिया गया Table डालता है.
removeChild(child)HeaderSectionचुने गए चाइल्ड एलिमेंट को हटाता है.
removeFromParent()HeaderSectionएलिमेंट को उसके पैरंट से हटाता है.
replaceText(searchPattern, replacement)Elementरेगुलर एक्सप्रेशन का इस्तेमाल करके, किसी दिए गए टेक्स्ट पैटर्न की सभी जगहों पर, दी गई रिप्लेसमेंट स्ट्रिंग से बदल देता है.
setAttributes(attributes)HeaderSectionएलिमेंट के एट्रिब्यूट सेट करता है.
setText(text)HeaderSectionकॉन्टेंट को सादे टेक्स्ट के तौर पर सेट करता है.
setTextAlignment(textAlignment)HeaderSectionटेक्स्ट अलाइनमेंट सेट करता है.

ज़्यादा जानकारी वाला दस्तावेज़

appendHorizontalRule()

नया HorizontalRule बनाता है और उसे जोड़ता है.

HorizontalRule, नए Paragraph में शामिल होगा.

वापसी का टिकट

HorizontalRule — नया हॉरिज़ॉन्टल नियम.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendImage(image)

तय की गई इमेज ब्लॉब से नया InlineImage बनाता है और उसे जोड़ता है.

इमेज, नए Paragraph में शामिल होगी.

पैरामीटर

नामटाइपब्यौरा
imageBlobSourceइमेज का डेटा.

वापसी का टिकट

InlineImage — अटैच की गई इमेज.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendImage(image)

दिए गए InlineImage को जोड़ता है.

InlineImage, नए Paragraph में शामिल होगा.

किसी मौजूदा InlineImage की कॉपी जोड़ते समय, appendImage के इस वर्शन का इस्तेमाल करें.

पैरामीटर

नामटाइपब्यौरा
imageInlineImageइमेज का डेटा.

वापसी का टिकट

InlineImage — अटैच की गई इमेज.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendListItem(listItem)

दिए गए ListItem को जोड़ता है.

किसी मौजूदा ListItem की कॉपी जोड़ते समय, appendListItem के इस वर्शन का इस्तेमाल करें.

पैरामीटर

नामटाइपब्यौरा
listItemListItemसूची में जोड़ने के लिए आइटम.

वापसी का टिकट

ListItem — सूची में जोड़ा गया आइटम.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendListItem(text)

तय किए गए टेक्स्ट कॉन्टेंट वाला नया ListItem बनाता है और उसे जोड़ता है.

एक के बाद एक जोड़े गए आइटम, एक ही सूची में जोड़े जाते हैं.

पैरामीटर

नामटाइपब्यौरा
textStringसूची के आइटम का टेक्स्ट कॉन्टेंट.

वापसी का टिकट

ListItem — सूची का नया आइटम.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendParagraph(paragraph)

दिए गए Paragraph को जोड़ता है.

किसी मौजूदा Paragraph की कॉपी जोड़ते समय, appendParagraph के इस वर्शन का इस्तेमाल करें.

पैरामीटर

नामटाइपब्यौरा
paragraphParagraphजोड़ा जाने वाला पैराग्राफ़.

वापसी का टिकट

Paragraph — जोड़ा गया पैराग्राफ़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendParagraph(text)

तय किए गए टेक्स्ट कॉन्टेंट वाला नया Paragraph बनाता है और उसे जोड़ता है.

पैरामीटर

नामटाइपब्यौरा
textStringपैराग्राफ़ का टेक्स्ट कॉन्टेंट.

वापसी का टिकट

Paragraph — नया पैराग्राफ़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendTable()

नया Table बनाता है और उसे जोड़ता है.

इस तरीके से टेबल के बाद एक खाली पैराग्राफ़ भी जुड़ जाएगा, क्योंकि Google Docs दस्तावेज़ों के आखिर में टेबल नहीं हो सकती.

वापसी का टिकट

Table — नई टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendTable(cells)

तय की गई हर स्ट्रिंग वैल्यू के लिए, TableCell वाला नया Table जोड़ता है.

इस तरीके से टेबल के बाद एक खाली पैराग्राफ़ भी जुड़ जाएगा, क्योंकि Google Docs दस्तावेज़ों के आखिर में टेबल नहीं हो सकती.

पैरामीटर

नामटाइपब्यौरा
cellsString[][]नई टेबल में जोड़ने के लिए, टेबल सेल का टेक्स्ट कॉन्टेंट.

वापसी का टिकट

Table — जोड़ी गई टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

appendTable(table)

दिए गए Table को जोड़ता है.

किसी मौजूदा Table की कॉपी जोड़ते समय, appendTable के इस वर्शन का इस्तेमाल करें. इस तरीके से टेबल के बाद एक खाली पैराग्राफ़ भी जुड़ जाएगा, क्योंकि Google Docs दस्तावेज़ों के आखिर में टेबल नहीं हो सकती.

पैरामीटर

नामटाइपब्यौरा
tableTableवह टेबल जिसे जोड़ना है.

वापसी का टिकट

Table — जोड़ी गई टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

clear()

एलिमेंट का कॉन्टेंट हटा देता है.

वापसी का टिकट

HeaderSection — मौजूदा एलिमेंट.


copy()

मौजूदा एलिमेंट की डीप कॉपी दिखाता है.

एलिमेंट में मौजूद सभी चाइल्ड एलिमेंट भी कॉपी हो जाते हैं. नए एलिमेंट का कोई पैरंट नहीं है.

वापसी का टिकट

HeaderSection — नई कॉपी.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

editAsText()

बदलाव करने के लिए, मौजूदा एलिमेंट का Text वर्शन पाता है.

एलिमेंट के कॉन्टेंट को रिच टेक्स्ट के तौर पर मैनिप्युलेट करने के लिए, editAsText का इस्तेमाल करें. editAsText मोड, टेक्स्ट के अलावा अन्य एलिमेंट (जैसे, InlineImage और HorizontalRule) को अनदेखा करता है.

मिटाए गए टेक्स्ट की रेंज में पूरी तरह से शामिल चाइल्ड एलिमेंट, एलिमेंट से हटा दिए जाते हैं.

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);

वापसी का टिकट

Text — मौजूदा एलिमेंट का टेक्स्ट वर्शन


findElement(elementType)

एलिमेंट के कॉन्टेंट में, बताए गए टाइप के डिसेंटेंट को खोजता है.

पैरामीटर

नामटाइपब्यौरा
elementTypeElementTypeखोजने के लिए एलिमेंट का टाइप.

वापसी का टिकट

RangeElement — खोज के नतीजे में, खोज एलिमेंट की रैंकिंग दिखाने वाला एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

findElement(elementType, from)

एलिमेंट के कॉन्टेंट में, तय किए गए RangeElement से शुरू होकर, तय किए गए टाइप के डिसेंटेंट को खोजता है.

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;
  }
}

पैरामीटर

नामटाइपब्यौरा
elementTypeElementTypeखोजने के लिए एलिमेंट का टाइप.
fromRangeElementखोज के लिए इस्तेमाल किया जाने वाला नतीजा.

वापसी का टिकट

RangeElement — खोज के नतीजे में, खोज एलिमेंट की अगली रैंकिंग की जानकारी देने वाला एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

findText(searchPattern)

रेगुलर एक्सप्रेशन का इस्तेमाल करके, एलिमेंट के कॉन्टेंट में दिए गए टेक्स्ट पैटर्न को खोजता है.

JavaScript रेगुलर एक्सप्रेशन की कुछ सुविधाएं पूरी तरह काम नहीं करतीं. जैसे, कैप्चर ग्रुप और मोड मॉडिफ़ायर.

दिए गए रेगुलर एक्सप्रेशन पैटर्न का मिलान, मौजूदा एलिमेंट में मौजूद हर टेक्स्ट ब्लॉक से अलग-अलग किया जाता है.

पैरामीटर

नामटाइपब्यौरा
searchPatternStringखोजने के लिए पैटर्न

वापसी का टिकट

RangeElement — खोज के नतीजे में, खोज के लिए इस्तेमाल हुए टेक्स्ट की पोज़िशन दिखती है. अगर कोई मैच नहीं मिलता है, तो यह वैल्यू शून्य होती है

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

findText(searchPattern, from)

किसी खोज के नतीजे से शुरू करके, एलिमेंट के कॉन्टेंट में दिए गए टेक्स्ट पैटर्न को खोजता है.

JavaScript रेगुलर एक्सप्रेशन की कुछ सुविधाएं पूरी तरह काम नहीं करतीं. जैसे, कैप्चर ग्रुप और मोड मॉडिफ़ायर.

दिए गए रेगुलर एक्सप्रेशन पैटर्न का मिलान, मौजूदा एलिमेंट में मौजूद हर टेक्स्ट ब्लॉक से अलग-अलग किया जाता है.

पैरामीटर

नामटाइपब्यौरा
searchPatternStringखोजने के लिए पैटर्न
fromRangeElementखोज के जिस नतीजे में खोजना है

वापसी का टिकट

RangeElement — खोज के नतीजे में, खोज के लिए इस्तेमाल हुए टेक्स्ट की अगली पोज़िशन दिखती है. अगर कोई मैच नहीं मिलता है, तो यह वैल्यू शून्य होती है

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getAttributes()

एलिमेंट के एट्रिब्यूट दिखाता है.

इसका नतीजा एक ऑब्जेक्ट होता है, जिसमें हर मान्य एलिमेंट एट्रिब्यूट के लिए एक प्रॉपर्टी होती है. इसमें हर प्रॉपर्टी का नाम, DocumentApp.Attribute एनोटेशन में मौजूद किसी आइटम से मेल खाता है.

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]}`);
}

वापसी का टिकट

Object — एलिमेंट के एट्रिब्यूट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getChild(childIndex)

बताए गए चाइल्ड इंडेक्स पर चाइल्ड एलिमेंट को वापस लाता है.

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.');
}

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerजिस चाइल्ड एलिमेंट को वापस लाना है उसका इंडेक्स.

वापसी का टिकट

Element — तय किए गए इंडेक्स पर मौजूद चाइल्ड एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getChildIndex(child)

बताए गए चाइल्ड एलिमेंट के लिए चाइल्ड इंडेक्स को वापस लाता है.

पैरामीटर

नामटाइपब्यौरा
childElementवह चाइल्ड एलिमेंट जिसके लिए इंडेक्स को वापस लाना है.

वापसी का टिकट

Integer — चाइल्ड इंडेक्स.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getImages()

सेक्शन में मौजूद सभी InlineImages को वापस लाता है.

वापसी का टिकट

InlineImage[] — सेक्शन की इमेज.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getListItems()

सेक्शन में मौजूद सभी ListItems को वापस लाता है.

वापसी का टिकट

ListItem[] — सेक्शन में मौजूद आइटम की सूची.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getNumChildren()

बच्चों की संख्या दिखाता है.

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.`);

वापसी का टिकट

Integer — बच्चों की संख्या.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getParagraphs()

सेक्शन में मौजूद सभी Paragraphs को वापस लाता है. इनमें ListItems भी शामिल है.

वापसी का टिकट

Paragraph[] — सेक्शन के पैराग्राफ़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getParent()

एलिमेंट का पैरंट एलिमेंट दिखाता है.

पैरंट एलिमेंट में मौजूदा एलिमेंट होता है.

वापसी का टिकट

ContainerElement — पैरंट एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getTables()

सेक्शन में मौजूद सभी Tables को वापस लाता है.

वापसी का टिकट

Table[] — सेक्शन टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getText()

एलिमेंट के कॉन्टेंट को टेक्स्ट स्ट्रिंग के तौर पर दिखाता है.

वापसी का टिकट

String — टेक्स्ट स्ट्रिंग के तौर पर एलिमेंट का कॉन्टेंट

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getTextAlignment()

टेक्स्ट अलाइनमेंट की जानकारी मिलती है. अलाइनमेंट के लिए ये टाइप उपलब्ध हैं: DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, और DocumentApp.TextAlignment.SUPERSCRIPT.

वापसी का टिकट

TextAlignment — टेक्स्ट अलाइनमेंट का टाइप या null, अगर टेक्स्ट में एक से ज़्यादा तरह के टेक्स्ट अलाइनमेंट हैं या टेक्स्ट अलाइनमेंट कभी सेट नहीं किया गया है

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

getType()

एलिमेंट का ElementType दिखाता है.

किसी एलिमेंट के टाइप का सटीक पता लगाने के लिए, getType() का इस्तेमाल करें.

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.');
}

वापसी का टिकट

ElementType — एलिमेंट का टाइप.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertHorizontalRule(childIndex)

तय किए गए इंडेक्स पर एक नया HorizontalRule बनाता है और उसे डालता है.

HorizontalRule, नए Paragraph में शामिल होगा.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां एलिमेंट डालना है.

वापसी का टिकट

HorizontalRule — नया हॉरिज़ॉन्टल नियम.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertImage(childIndex, image)

तय किए गए इंडेक्स पर, तय की गई इमेज ब्लॉब से InlineImage बनाता है और उसे शामिल करता है.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां एलिमेंट डालना है.
imageBlobSourceइमेज का डेटा.

वापसी का टिकट

InlineImage — शामिल की गई इनलाइन इमेज.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertImage(childIndex, image)

दिए गए इंडेक्स में, दिया गया InlineImage डालता है.

इमेज, नए Paragraph में शामिल होगी.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां एलिमेंट डालना है.
imageInlineImageवह इमेज जिसे शामिल करना है.

वापसी का टिकट

InlineImage — शामिल की गई इनलाइन इमेज.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertListItem(childIndex, listItem)

दिए गए इंडेक्स में, दिया गया ListItem डालता है.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.
listItemListItemसूची में शामिल किया जाने वाला आइटम.

वापसी का टिकट

ListItem — सूची में शामिल किया गया आइटम.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertListItem(childIndex, text)

तय किए गए इंडेक्स में एक नया ListItem बनाता है और उसे शामिल करता है. इसमें तय किए गए टेक्स्ट कॉन्टेंट होते हैं.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.
textStringसूची के आइटम का टेक्स्ट कॉन्टेंट.

वापसी का टिकट

ListItem — सूची का नया आइटम.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertParagraph(childIndex, paragraph)

दिए गए इंडेक्स में, दिया गया Paragraph डालता है.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.
paragraphParagraphडाला जाने वाला पैराग्राफ़.

वापसी का टिकट

Paragraph — शामिल किया गया पैराग्राफ़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertParagraph(childIndex, text)

तय किए गए इंडेक्स में एक नया Paragraph बनाता है और उसे शामिल करता है. इसमें तय किए गए टेक्स्ट कॉन्टेंट होते हैं.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.
textStringपैराग्राफ़ का टेक्स्ट कॉन्टेंट.

वापसी का टिकट

Paragraph — नया पैराग्राफ़.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertTable(childIndex)

तय किए गए इंडेक्स पर एक नया Table बनाता है और उसे डालता है.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.

वापसी का टिकट

Table — नई टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertTable(childIndex, cells)

तय किए गए इंडेक्स में, तय की गई सेल वाला नया Table बनाता है और उसे डालता है.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.
cellsString[][]नई टेबल में जोड़ने के लिए, टेबल सेल का टेक्स्ट कॉन्टेंट.

वापसी का टिकट

Table — नई टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

insertTable(childIndex, table)

दिए गए इंडेक्स में, दिया गया Table डालता है.

पैरामीटर

नामटाइपब्यौरा
childIndexIntegerवह इंडेक्स जहां शामिल करना है.
tableTableडाली जाने वाली टेबल.

वापसी का टिकट

Table — शामिल की गई टेबल.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

removeChild(child)

चुने गए चाइल्ड एलिमेंट को हटाता है.

पैरामीटर

नामटाइपब्यौरा
childElementवह चाइल्ड एलिमेंट जिसे हटाना है.

वापसी का टिकट

HeaderSection — मौजूदा एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

removeFromParent()

एलिमेंट को उसके पैरंट से हटाता है.

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();
}

वापसी का टिकट

HeaderSection — हटाया गया एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

replaceText(searchPattern, replacement)

रेगुलर एक्सप्रेशन का इस्तेमाल करके, किसी दिए गए टेक्स्ट पैटर्न की सभी जगहों पर, दी गई रिप्लेसमेंट स्ट्रिंग से बदल देता है.

खोज पैटर्न को JavaScript रेगुलर एक्सप्रेशन ऑब्जेक्ट के बजाय, स्ट्रिंग के तौर पर पास किया जाता है. इसलिए, आपको पैटर्न में मौजूद किसी भी बैकस्लैश को एस्केप करना होगा.

इस तरीके में, Google की RE2 रेगुलर एक्सप्रेशन लाइब्रेरी का इस्तेमाल किया जाता है. इससे, काम करने वाले सिंटैक्स की संख्या सीमित हो जाती है.

दिए गए रेगुलर एक्सप्रेशन पैटर्न का मिलान, मौजूदा एलिमेंट में मौजूद हर टेक्स्ट ब्लॉक से अलग-अलग किया जाता है.

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

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

पैरामीटर

नामटाइपब्यौरा
searchPatternStringखोजने के लिए रेगुलर एक्सप्रेशन पैटर्न
replacementStringवह टेक्स्ट जिसे बदलने के लिए इस्तेमाल करना है

वापसी का टिकट

Element — मौजूदा एलिमेंट

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

setAttributes(attributes)

एलिमेंट के एट्रिब्यूट सेट करता है.

एट्रिब्यूट पैरामीटर, एक ऑब्जेक्ट होना चाहिए. इसमें हर प्रॉपर्टी का नाम, DocumentApp.Attribute एनोटेशन में मौजूद किसी आइटम के तौर पर होना चाहिए. साथ ही, हर प्रॉपर्टी की वैल्यू, लागू की जाने वाली नई वैल्यू होनी चाहिए.

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);

पैरामीटर

नामटाइपब्यौरा
attributesObjectएलिमेंट के एट्रिब्यूट.

वापसी का टिकट

HeaderSection — मौजूदा एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

setText(text)

कॉन्टेंट को सादे टेक्स्ट के तौर पर सेट करता है.

ध्यान दें: मौजूदा कॉन्टेंट मिटा दिए जाते हैं.

पैरामीटर

नामटाइपब्यौरा
textStringनए टेक्स्ट कॉन्टेंट.

वापसी का टिकट

HeaderSection — मौजूदा एलिमेंट.

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

setTextAlignment(textAlignment)

टेक्स्ट अलाइनमेंट सेट करता है. अलाइनमेंट के लिए ये टाइप उपलब्ध हैं: DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT, और DocumentApp.TextAlignment.SUPERSCRIPT.

// 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);

पैरामीटर

नामटाइपब्यौरा
textAlignmentTextAlignmentलागू करने के लिए टेक्स्ट अलाइनमेंट का टाइप

वापसी का टिकट

HeaderSection — मौजूदा एलिमेंट

अनुमति देना

इस तरीके का इस्तेमाल करने वाली स्क्रिप्ट को, इनमें से एक या एक से ज़्यादा स्कोप के लिए अनुमति की ज़रूरत होती है:

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

अब काम न करने वाले तरीके