Class DocumentTab

दस्तावेज़टैब

दस्तावेज़ टैब, जिसमें टेबल और सूचियों जैसे एलिमेंट और रिच टेक्स्ट शामिल होते हैं.

Document.getTabs()[tabIndex].asDocumentTab() का इस्तेमाल करके, दस्तावेज़ का टैब वापस पाएं. 

// Get a specific document tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addBookmark(position)Bookmarkदिए गए Position पर Bookmark जोड़ता है.
addFooter()FooterSectionअगर कोई टैब फ़ुटर सेक्शन मौजूद नहीं है, तो उसे जोड़ता है.
addHeader()HeaderSectionअगर कोई टैब हेडर सेक्शन मौजूद नहीं है, तो उसे जोड़ता है.
addNamedRange(name, range)NamedRangeNamedRange जोड़ता है, जो एक Range होता है. इसमें नाम और आईडी होता है, ताकि बाद में इसे वापस पाया जा सके.
getBody()Bodyटैब का Body दिखाता है.
getBookmark(id)Bookmarkदिए गए आईडी के साथ Bookmark पाता है.
getBookmarks()Bookmark[]टैब में मौजूद सभी Bookmark ऑब्जेक्ट दिखाता है.
getFooter()FooterSectionअगर टैब में फ़ुटर सेक्शन मौजूद है, तो उसे दिखाता है.
getFootnotes()Footnote[]टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट को वापस लाता है.
getHeader()HeaderSectionअगर टैब का हेडर सेक्शन मौजूद है, तो उसे वापस लाता है.
getNamedRangeById(id)NamedRangeदिए गए आईडी के साथ NamedRange पाता है.
getNamedRanges()NamedRange[]टैब में मौजूद सभी NamedRange ऑब्जेक्ट दिखाता है.
getNamedRanges(name)NamedRange[]दिए गए नाम वाले टैब में मौजूद सभी NamedRange ऑब्जेक्ट दिखाता है.
newPosition(element, offset)Positionएक नया Position बनाता है, जो किसी खास एलिमेंट के हिसाब से, टैब में किसी जगह का रेफ़रंस होता है.
newRange()RangeBuilderटैब एलिमेंट से Range ऑब्जेक्ट बनाने के लिए इस्तेमाल किया जाने वाला बिल्डर बनाता है.

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

addBookmark(position)

दिए गए Position पर Bookmark जोड़ता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body and adds a paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = documentTab.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = documentTab.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

पैरामीटर

नामटाइपब्यौरा
positionPositionनए बुकमार्क की जगह.

वापसी का टिकट

Bookmark — नया बुकमार्क.

अनुमति देना

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

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

addFooter()

अगर कोई टैब फ़ुटर सेक्शन मौजूद नहीं है, तो उसे जोड़ता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a footer to the tab.
const footer = documentTab.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

वापसी का टिकट

FooterSection — टैब का फ़ुटर.

अनुमति देना

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

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

addHeader()

अगर कोई टैब हेडर सेक्शन मौजूद नहीं है, तो उसे जोड़ता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Adds a header to the tab.
const header = documentTab.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

वापसी का टिकट

HeaderSection — टैब का हेडर.

अनुमति देना

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

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

addNamedRange(name, range)

NamedRange जोड़ता है, जो एक Range होता है. इसमें नाम और आईडी होता है, ताकि बाद में इसे वापस पाया जा सके. ज़रूरी नहीं है कि नाम यूनीक हों. यह बात सभी टैब के लिए लागू होती है. एक ही दस्तावेज़ में कई अलग-अलग रेंज का एक ही नाम हो सकता है. यह एचटीएमएल की क्लास की तरह ही होता है. इसके उलट, दस्तावेज़ में आईडी एक जैसे नहीं होते. जैसे, एचटीएमएल में आईडी एक जैसे नहीं होते. NamedRange जोड़ने के बाद, उसमें बदलाव नहीं किया जा सकता. इसे सिर्फ़ हटाया जा सकता है.

टैब को ऐक्सेस करने वाली कोई भी स्क्रिप्ट, NamedRange को ऐक्सेस कर सकती है. स्प्रेडशीट में मौजूद अलग-अलग स्क्रिप्ट के बीच, अनचाहे टकराव से बचने के लिए, रेंज के नामों के आगे कोई यूनीक स्ट्रिंग जोड़ें. 

// Creates a named range that includes every table in a tab by its ID.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('Tab t.0 tables', rangeBuilder.build());

पैरामीटर

नामटाइपब्यौरा
nameStringरेंज का नाम, जो यूनीक होना ज़रूरी नहीं है. रेंज के नाम में एक से 256 वर्ण होने चाहिए.
rangeRangeनाम से जोड़ने के लिए एलिमेंट की रेंज; रेंज, खोज का नतीजा हो सकती है या मैन्युअल रूप से newRange() की मदद से बनाई गई हो सकती है.

वापसी का टिकट

NamedRange — NamedRange.

अनुमति देना

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

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

getBody()

टैब का Body दिखाता है.

टैब में अलग-अलग तरह के सेक्शन हो सकते हैं. उदाहरण के लिए, HeaderSection, FooterSection. किसी टैब के लिए चालू सेक्शन Body होता है.

DocumentTab में एलिमेंट के तरीके, Body को डेलिगेट करते हैं. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the tab body.
const body = documentTab.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

वापसी का टिकट

Body — टैब का बॉडी सेक्शन.

अनुमति देना

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

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

getBookmark(id)

दिए गए आईडी के साथ Bookmark पाता है. अगर इस टैब में कोई ऐसा Bookmark मौजूद नहीं है, तो यह तरीका null दिखाता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the bookmark by its ID.
const bookmark = documentTab.getBookmark('id.xyz654321');

// If the bookmark exists within the tab, logs the character offset of its
// position to the console. Otherwise, logs 'No bookmark exists with the given
// ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

पैरामीटर

नामटाइपब्यौरा
idStringBookmark का आईडी.

वापसी का टिकट

Bookmark — दिए गए आईडी वाला Bookmark या अगर टैब में ऐसा कोई Bookmark मौजूद नहीं है, तो null.

अनुमति देना

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

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

getBookmarks()

टैब में मौजूद सभी Bookmark ऑब्जेक्ट दिखाता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets all of the bookmarks in the tab.
const bookmarks = documentTab.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

वापसी का टिकट

Bookmark[] — टैब में मौजूद Bookmark ऑब्जेक्ट का कलेक्शन.

अनुमति देना

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

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

getFooter()

अगर टैब में फ़ुटर सेक्शन मौजूद है, तो उसे दिखाता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's footer and logs it to the console.
console.log(documentTab.getFooter().getText());

वापसी का टिकट

FooterSection — टैब का फ़ुटर.

अनुमति देना

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

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

getFootnotes()

टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट को वापस लाता है.

getFootnotes को कॉल करने पर, टैब के एलिमेंट पर एक बार फिर से फ़ंक्शन लागू होता है. बड़े टैब के लिए, इस तरीके का इस्तेमाल ज़रूरत से ज़्यादा न करें. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the first footnote.
const footnote = documentTab.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

वापसी का टिकट

Footnote[] — टैब के फ़ुटनोट.

अनुमति देना

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

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

getHeader()

अगर टैब का हेडर सेक्शन मौजूद है, तो उसे वापस लाता है. 

// Opens the Docs file and retrieves the tab by its IDs. If you created your
// script from within a Google Docs file, you can use
// DocumentApp.getActiveDocument().getActiveTab() instead.
// TODO(developer): Replace the IDs with your own.
const documentTab =
    DocumentApp.openById('123abc').getTab('123abc').asDocumentTab();

// Gets the text of the tab's header and logs it to the console.
console.log(documentTab.getHeader().getText());

वापसी का टिकट

HeaderSection — टैब का हेडर.

अनुमति देना

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

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

getNamedRangeById(id)

दिए गए आईडी के साथ NamedRange पाता है. अगर टैब में ऐसा कोई NamedRange मौजूद नहीं है, तो यह तरीका null दिखाता है. ज़रूरी नहीं कि नाम यूनीक हों. यह बात सभी टैब के लिए लागू होती है. एक ही दस्तावेज़ में कई अलग-अलग रेंज का नाम एक जैसा हो सकता है. यह ठीक उसी तरह है जैसे HTML में क्लास का नाम एक जैसा होता है. इसके उलट, टैब में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी.

पैरामीटर

नामटाइपब्यौरा
idStringरेंज का आईडी, जो टैब में यूनीक होता है.

वापसी का टिकट

NamedRange — दिए गए आईडी वाला NamedRange या अगर टैब में ऐसी कोई रेंज मौजूद नहीं है, तो null.

अनुमति देना

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

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

getNamedRanges()

टैब में मौजूद सभी NamedRange ऑब्जेक्ट दिखाता है.

NamedRange को टैब को ऐक्सेस करने वाली किसी भी स्क्रिप्ट से ऐक्सेस किया जा सकता है. स्प्रेडशीट में मौजूद अलग-अलग स्क्रिप्ट के नाम एक जैसे होने पर, उनमें गड़बड़ी हो सकती है. इसे रोकने के लिए, रेंज के नामों के आगे कोई यूनीक स्ट्रिंग जोड़ें.

वापसी का टिकट

NamedRange[] — टैब में मौजूद NamedRange ऑब्जेक्ट का कलेक्शन. इसमें एक ही नाम वाली कई रेंज शामिल हो सकती हैं.

अनुमति देना

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

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

getNamedRanges(name)

दिए गए नाम वाले टैब में मौजूद सभी NamedRange ऑब्जेक्ट दिखाता है. ज़रूरी नहीं कि नाम यूनीक हों. यह बात सभी टैब के लिए लागू होती है. एक ही दस्तावेज़ में कई अलग-अलग रेंज का एक ही नाम हो सकता है. यह एचटीएमएल की क्लास की तरह ही होता है. इसके उलट, टैब में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी.

NamedRange को टैब को ऐक्सेस करने वाली किसी भी स्क्रिप्ट से ऐक्सेस किया जा सकता है. स्प्रेडशीट में मौजूद अलग-अलग स्क्रिप्ट के नाम एक जैसे होने पर, उनमें गड़बड़ी हो सकती है. इसे रोकने के लिए, रेंज के नामों के आगे कोई यूनीक स्ट्रिंग जोड़ें.

पैरामीटर

नामटाइपब्यौरा
nameStringरेंज का नाम, जो ज़रूरी नहीं है कि वह यूनीक हो.

वापसी का टिकट

NamedRange[] — दिए गए नाम वाले टैब में NamedRange ऑब्जेक्ट का कलेक्शन.

अनुमति देना

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

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

newPosition(element, offset)

एक नया Position बनाता है, जो किसी खास एलिमेंट के हिसाब से, टैब में किसी जगह का रेफ़रंस होता है. उपयोगकर्ता के कर्सर को Position के तौर पर दिखाया जाता है. 

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

पैरामीटर

नामटाइपब्यौरा
elementElementवह एलिमेंट जिसमें नया Position टैग बनाया गया है. यह Text एलिमेंट या Paragraph जैसे कंटेनर एलिमेंट होना चाहिए.
offsetIntegerText एलिमेंट के लिए, Position से पहले वाले वर्णों की संख्या; अन्य एलिमेंट के लिए, एक ही कंटेनर एलिमेंट में Position से पहले वाले चाइल्ड एलिमेंट की संख्या.

वापसी का टिकट

Position — नया Position.

अनुमति देना

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

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

newRange()

टैब एलिमेंट से Range ऑब्जेक्ट बनाने के लिए इस्तेमाल किया जाने वाला बिल्डर बनाता है. 

// Change the user's selection to a range that includes every table in the tab.
// TODO(developer): Replace the IDs with your own.
const doc = DocumentApp.openById('123abc');
const documentTab = doc.getTab('123abc').asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

वापसी का टिकट

RangeBuilder — नया बिल्डर.

अनुमति देना

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

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