Class Document

दस्तावेज़

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

DocumentApp का इस्तेमाल करके दस्तावेज़ खोले या बनाए जा सकते हैं. 

// Open a document by ID.
let doc = DocumentApp.openById('<my-id>');

// Create and open a document.
doc = DocumentApp.create('Document Title');

Document क्लास के ऐसे तरीके जो सीधे तौर पर टेक्स्ट कॉन्टेंट को ऐक्सेस और उसमें बदलाव करते हैं, वे किसी खास दस्तावेज़ से बाउंड स्क्रिप्ट में मौजूद ऐक्टिव टैब या पहले टैब पर काम करते हैं. ऐसा तब होता है, जब कोई ऐक्टिव टैब उपलब्ध न हो. इन तरीकों पर निर्भर रहने वाली स्क्रिप्ट (उदाहरण के लिए, getBody()) को, getTabs() और फिर Tab.asDocumentTab() का इस्तेमाल करके टैब के साथ काम करने के लिए माइग्रेट किया जा सकता है.

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
addBookmark(position)Bookmarkयह फ़ंक्शन, पहले टैब या दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब में दिए गए Position पर Bookmark जोड़ता है.
addEditor(emailAddress)Documentयह फ़ंक्शन, दिए गए उपयोगकर्ता को Document के लिए संपादकों की सूची में जोड़ता है.
addEditor(user)Documentयह फ़ंक्शन, दिए गए उपयोगकर्ता को Document के लिए संपादकों की सूची में जोड़ता है.
addEditors(emailAddresses)Documentयह फ़ंक्शन, उपयोगकर्ताओं के दिए गए ऐरे को Document के लिए संपादकों की सूची में जोड़ता है.
addFooter()FooterSectionअगर पहले टैब में फ़ुटर सेक्शन मौजूद नहीं है, तो यह उसे जोड़ता है. इसके अलावा, अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो यह फ़ुटर सेक्शन को ऐक्टिव टैब में जोड़ता है.
addHeader()HeaderSectionअगर पहले टैब में कोई हेडर सेक्शन मौजूद नहीं है, तो यह उसे जोड़ता है. इसके अलावा, अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो यह ऐक्टिव टैब में हेडर सेक्शन जोड़ता है.
addNamedRange(name, range)NamedRangeयह फ़ंक्शन, पहले टैब में या किसी दस्तावेज़ से बाइंड की गई स्क्रिप्ट के लिए, ऐक्टिव टैब में NamedRange जोड़ता है. यह एक Range होता है, जिसका नाम और आईडी होता है. इसका इस्तेमाल बाद में किया जा सकता है.
addViewer(emailAddress)Documentइस फ़ंक्शन का इस्तेमाल करके, दिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ा जाता है.
addViewer(user)Documentइस फ़ंक्शन का इस्तेमाल करके, दिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ा जाता है.
addViewers(emailAddresses)Documentयह फ़ंक्शन, उपयोगकर्ताओं के दिए गए ऐरे को Document के दर्शकों की सूची में जोड़ता है.
getActiveTab()Tab|nullदस्तावेज़ में उपयोगकर्ता के लिए फ़िलहाल चालू Tab को दिखाता है.
getAs(contentType)Blobयह फ़ंक्शन, मौजूदा Document के कॉन्टेंट को तय किए गए टाइप के ब्लब के तौर पर वापस लाता है.
getBlob()Blobयह मौजूदा Document के कॉन्टेंट को blob के तौर पर वापस लाता है.
getBody()Bodyयह फ़ंक्शन, पहले टैब का Body या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब का DocumentBodySection वापस लाता है.
getBookmark(id)Bookmark|nullयह पहले टैब में मौजूद, दिए गए आईडी वाला Bookmark ऑब्जेक्ट दिखाता है. अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो यह ऐक्टिव टैब में मौजूद Bookmark ऑब्जेक्ट दिखाता है.
getBookmarks()Bookmark[]यह पहले टैब में मौजूद सभी Bookmark ऑब्जेक्ट को फ़ेच करता है. इसके अलावा, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह ऐक्टिव टैब में मौजूद सभी Bookmark ऑब्जेक्ट को फ़ेच करता है.
getCursor()Position|nullइस कुकी से, ऐक्टिव टैब में उपयोगकर्ता के कर्सर की जानकारी मिलती है.
getEditors()User[]इस Document के लिए एडिटर की सूची मिलती है.
getFooter()FooterSection|nullयह फ़ंक्शन, पहले टैब के फ़ुटर सेक्शन को वापस लाता है. साथ ही, दस्तावेज़ से बाइंड की गई स्क्रिप्ट के लिए, यह फ़ंक्शन ऐक्टिव टैब के फ़ुटर सेक्शन को वापस लाता है.
getFootnotes()Footnote[]यह फ़ंक्शन, पहले टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट को वापस लाता है. इसके अलावा, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह फ़ंक्शन ऐक्टिव टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट को वापस लाता है.
getHeader()HeaderSection|nullयह फ़ंक्शन, पहले टैब के हेडर सेक्शन को वापस लाता है. साथ ही, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह फ़ंक्शन ऐक्टिव टैब के हेडर सेक्शन को वापस लाता है.
getId()Stringयह कुकी, दस्तावेज़ का यूनीक आइडेंटिफ़ायर वापस लाती है.
getLanguage()String|nullइससे दस्तावेज़ की भाषा का कोड मिलता है.
getName()Stringयह कुकी, दस्तावेज़ का टाइटल वापस पाती है.
getNamedRangeById(id)NamedRange|nullयह पहले टैब में मौजूद, दिए गए आईडी वाला NamedRange ऑब्जेक्ट दिखाता है. अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो यह ऐक्टिव टैब में मौजूद NamedRange ऑब्जेक्ट दिखाता है.
getNamedRanges()NamedRange[]यह पहले टैब में मौजूद सभी NamedRange ऑब्जेक्ट को फ़ेच करता है. इसके अलावा, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह ऐक्टिव टैब में मौजूद सभी NamedRange ऑब्जेक्ट को फ़ेच करता है.
getNamedRanges(name)NamedRange[]यह फ़ंक्शन, पहले टैब में दिए गए नाम वाले सभी NamedRange ऑब्जेक्ट को दिखाता है. अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो यह फ़ंक्शन चालू टैब में मौजूद ऑब्जेक्ट दिखाता है.
getSelection()Range|nullइस फ़ंक्शन से, ऐक्टिव टैब में उपयोगकर्ता के चुने गए आइटम की जानकारी मिलती है.
getSupportedLanguageCodes()String[]Google Docs फ़ाइलों में इस्तेमाल की जा सकने वाली सभी भाषाओं के कोड मिलते हैं.
getTab(tabId)Tab|nullइस तरीके से, दिए गए आईडी वाला Tab मिलता है.
getTabs()Tab[]यह दस्तावेज़ में मौजूद सभी अननेस्टेड Tab को दिखाता है.
getUrl()Stringइस फ़ंक्शन का इस्तेमाल करके, मौजूदा दस्तावेज़ को ऐक्सेस करने के लिए यूआरएल वापस पाया जा सकता है.
getViewers()User[]इस Document के लिए, दर्शकों और टिप्पणी करने वालों की सूची मिलती है.
newPosition(element, offset)Positionयह एक नया Position बनाता है. यह टैब में किसी जगह का रेफ़रंस होता है. यह रेफ़रंस, पहले टैब में मौजूद किसी खास एलिमेंट या दस्तावेज़ से बाइंड की गई स्क्रिप्ट के लिए, ऐक्टिव टैब के हिसाब से होता है.
newRange()RangeBuilderयह एक बिल्डर बनाता है. इसका इस्तेमाल, पहले टैब में मौजूद टैब एलिमेंट से Range ऑब्जेक्ट बनाने के लिए किया जाता है. अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो इसका इस्तेमाल चालू टैब से Range ऑब्जेक्ट बनाने के लिए किया जाता है.
removeEditor(emailAddress)Documentइस विकल्प से, दिए गए उपयोगकर्ता को Document के एडिटर की सूची से हटा दिया जाता है.
removeEditor(user)Documentइस विकल्प से, दिए गए उपयोगकर्ता को Document के एडिटर की सूची से हटा दिया जाता है.
removeViewer(emailAddress)Documentइस फ़ंक्शन का इस्तेमाल करके, किसी उपयोगकर्ता को Document के दर्शकों और टिप्पणीकारों की सूची से हटाया जा सकता है.
removeViewer(user)Documentइस फ़ंक्शन का इस्तेमाल करके, किसी उपयोगकर्ता को Document के दर्शकों और टिप्पणीकारों की सूची से हटाया जा सकता है.
saveAndClose()voidइससे मौजूदा Document सेव हो जाता है.
setActiveTab(tabId)voidयह फ़ंक्शन, मौजूदा दस्तावेज़ में उपयोगकर्ता के चुने गए Tab को, तय किए गए आईडी वाले टैब पर सेट करता है.
setCursor(position)Documentयह कुकी, उपयोगकर्ता के कर्सर को सेट करती है. इसके लिए, Position का इस्तेमाल किया जाता है.
setLanguage(languageCode)Documentइससे दस्तावेज़ की भाषा का कोड सेट किया जाता है.
setName(name)Documentइस विकल्प से, दस्तावेज़ का टाइटल सेट किया जाता है.
setSelection(range)Documentयह कुकी, Range के आधार पर ऐक्टिव टैब में उपयोगकर्ता के चुने गए विकल्प को सेट करती है.

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

addBookmark(position)

यह फ़ंक्शन, पहले टैब या दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब में दिए गए Position पर Bookmark जोड़ता है. किसी टैब में बुकमार्क जोड़ने के लिए, DocumentTab.addBookmark(position) तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

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

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.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

addEditor(emailAddress)

यह फ़ंक्शन, दिए गए उपयोगकर्ता को Document के लिए संपादकों की सूची में जोड़ता है. अगर उपयोगकर्ता पहले से ही दर्शकों की सूची में शामिल था, तो यह तरीका उपयोगकर्ता को दर्शकों की सूची से हटा देता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringजिस उपयोगकर्ता को जोड़ना है उसका ईमेल पता.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

addEditor(user)

यह फ़ंक्शन, दिए गए उपयोगकर्ता को Document के लिए संपादकों की सूची में जोड़ता है. अगर उपयोगकर्ता पहले से ही दर्शकों की सूची में शामिल था, तो यह तरीका उपयोगकर्ता को दर्शकों की सूची से हटा देता है.

पैरामीटर

नामटाइपब्यौरा
userUserजोड़े जाने वाले उपयोगकर्ता का प्रतिनिधित्व.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

addEditors(emailAddresses)

यह फ़ंक्शन, उपयोगकर्ताओं के दिए गए ऐरे को Document के लिए संपादकों की सूची में जोड़ता है. अगर कोई उपयोगकर्ता पहले से ही दर्शकों की सूची में शामिल है, तो इस तरीके से उसे दर्शकों की सूची से हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressesString[]जोड़े जाने वाले उपयोगकर्ताओं के ईमेल पतों की एक कैटगरी.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

addFooter()

अगर पहले टैब में फ़ुटर सेक्शन मौजूद नहीं है, तो यह उसे जोड़ता है. इसके अलावा, अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो यह फ़ुटर सेक्शन को ऐक्टिव टैब में जोड़ता है. किसी भी टैब में फ़ुटर सेक्शन जोड़ने के लिए, DocumentTab.addFooter() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.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()

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.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 जोड़ने के लिए, DocumentTab.addNamedRange(name, range) तरीके का इस्तेमाल करें. यह ज़रूरी नहीं है कि नाम यूनीक हों. एक ही दस्तावेज़ में मौजूद कई अलग-अलग रेंज का नाम एक जैसा हो सकता है. यह कुछ हद तक एचटीएमएल में मौजूद क्लास की तरह होता है. इसके उलट, आईडी किसी दस्तावेज़ में यूनीक होते हैं. जैसे, एचटीएमएल में आईडी. किसी दस्तावेज़ में NamedRange जोड़ने के बाद, उसमें बदलाव नहीं किया जा सकता. हालांकि, उसे हटाया जा सकता है.

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

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

पैरामीटर

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

वापसी का टिकट

NamedRange — NamedRange.

अनुमति देना

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

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

addViewer(emailAddress)

इस फ़ंक्शन का इस्तेमाल करके, दिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ा जाता है. अगर उपयोगकर्ता पहले से ही संपादकों की सूची में शामिल है, तो इस तरीके का कोई असर नहीं होगा.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringजिस उपयोगकर्ता को जोड़ना है उसका ईमेल पता.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

addViewer(user)

इस फ़ंक्शन का इस्तेमाल करके, दिए गए उपयोगकर्ता को Document के दर्शकों की सूची में जोड़ा जाता है. अगर उपयोगकर्ता पहले से ही संपादकों की सूची में शामिल है, तो इस तरीके का कोई असर नहीं होगा.

पैरामीटर

नामटाइपब्यौरा
userUserजोड़े जाने वाले उपयोगकर्ता का प्रतिनिधित्व.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

addViewers(emailAddresses)

यह फ़ंक्शन, उपयोगकर्ताओं के दिए गए ऐरे को Document के दर्शकों की सूची में जोड़ता है. अगर कोई उपयोगकर्ता पहले से ही संपादकों की सूची में शामिल है, तो इस तरीके का उस पर कोई असर नहीं पड़ेगा.

पैरामीटर

नामटाइपब्यौरा
emailAddressesString[]जोड़े जाने वाले उपयोगकर्ताओं के ईमेल पतों की एक कैटगरी.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

getActiveTab()

दस्तावेज़ में उपयोगकर्ता के लिए फ़िलहाल चालू Tab को दिखाता है. कोई स्क्रिप्ट सिर्फ़ उस उपयोगकर्ता के ऐक्टिव टैब को ऐक्सेस कर सकती है जो स्क्रिप्ट चला रहा है. ऐसा सिर्फ़ तब किया जा सकता है, जब स्क्रिप्ट दस्तावेज़ से बाइंड हो. 

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

वापसी का टिकट

Tab|null — उपयोगकर्ता की फ़िलहाल चालू Tab या null, अगर स्क्रिप्ट दस्तावेज़ से नहीं जुड़ी है.

अनुमति देना

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

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

getAs(contentType)

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

पैरामीटर

नामटाइपब्यौरा
contentTypeStringबदलने के लिए MIME टाइप; 'application/pdf' और 'text/markdown' काम करते हैं.

वापसी का टिकट

Blob — मौजूदा दस्तावेज़ को blob के तौर पर दिखाता है.

getBlob()

यह मौजूदा Document के कॉन्टेंट को blob के तौर पर वापस लाता है. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

वापसी का टिकट

Blob — मौजूदा दस्तावेज़ को blob के तौर पर दिखाता है.

getBody()

यह फ़ंक्शन, पहले टैब का Body या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब का DocumentBodySection वापस लाता है. किसी टैब का DocumentBodySection पाने के लिए, DocumentTab.getBody() तरीके का इस्तेमाल करें.

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

Document में मौजूद एलिमेंट के तरीके, ऐक्टिव Body को सौंपे जाते हैं. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.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 ऑब्जेक्ट दिखाता है. किसी भी टैब में बुकमार्क पाने के लिए, DocumentTab.getBookmark(id) तरीके का इस्तेमाल करें. अगर टैब में ऐसा कोई Bookmark मौजूद नहीं है, तो यह तरीका null दिखाता है. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, 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|null — दिए गए आईडी वाला Bookmark या अगर टैब में ऐसा कोई Bookmark मौजूद नहीं है, तो null.

अनुमति देना

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

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

getBookmarks()

यह पहले टैब में मौजूद सभी Bookmark ऑब्जेक्ट को फ़ेच करता है. इसके अलावा, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह ऐक्टिव टैब में मौजूद सभी Bookmark ऑब्जेक्ट को फ़ेच करता है. किसी भी टैब में मौजूद सभी बुकमार्क पाने के लिए, DocumentTab.getBookmarks() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.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

getCursor()

इस कुकी से, ऐक्टिव टैब में उपयोगकर्ता के कर्सर की जानकारी मिलती है. कोई स्क्रिप्ट सिर्फ़ उस उपयोगकर्ता के कर्सर को ऐक्सेस कर सकती है जो स्क्रिप्ट चला रहा है. ऐसा सिर्फ़ तब किया जा सकता है, जब स्क्रिप्ट दस्तावेज़ से बाइंड हो. 

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

वापसी का टिकट

Position|null — यह उपयोगकर्ता के कर्सर को दिखाता है. अगर उपयोगकर्ता ने टैब में कर्सर नहीं रखा है या स्क्रिप्ट दस्तावेज़ से नहीं जुड़ी है, तो null दिखता है.

अनुमति देना

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

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

getEditors()

इस Document के लिए एडिटर की सूची मिलती है.

वापसी का टिकट

User[] — बदलाव करने की अनुमति वाले उपयोगकर्ताओं की एक सूची.

अनुमति देना

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

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

getFooter()

यह फ़ंक्शन, पहले टैब के फ़ुटर सेक्शन को वापस लाता है. साथ ही, दस्तावेज़ से बाइंड की गई स्क्रिप्ट के लिए, यह फ़ंक्शन ऐक्टिव टैब के फ़ुटर सेक्शन को वापस लाता है. किसी भी टैब का फ़ुटर सेक्शन पाने के लिए, DocumentTab.getFooter() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

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

वापसी का टिकट

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

अनुमति देना

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

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

getFootnotes()

यह फ़ंक्शन, पहले टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट को वापस लाता है. इसके अलावा, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह फ़ंक्शन ऐक्टिव टैब के मुख्य हिस्से में मौजूद सभी Footnote एलिमेंट को वापस लाता है. किसी टैब में मौजूद सभी फ़ुटनोट पाने के लिए, DocumentTab.getFootnotes() तरीके का इस्तेमाल करें.

getFootnotes को कॉल करने पर, टैब के एलिमेंट पर बार-बार फ़ोकस होता है. बड़े टैब के लिए, इस तरीके को बेवजह कॉल करने से बचें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.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()

यह फ़ंक्शन, पहले टैब के हेडर सेक्शन को वापस लाता है. साथ ही, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह फ़ंक्शन ऐक्टिव टैब के हेडर सेक्शन को वापस लाता है. किसी भी टैब का हेडर सेक्शन पाने के लिए, DocumentTab.getHeader() तरीके का इस्तेमाल करें. 

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

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

वापसी का टिकट

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

अनुमति देना

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

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

getId()

यह कुकी, दस्तावेज़ का यूनीक आइडेंटिफ़ायर वापस लाती है. किसी खास दस्तावेज़ इंस्टेंस को खोलने के लिए, दस्तावेज़ आईडी का इस्तेमाल DocumentApp.openById() के साथ किया जाता है.

वापसी का टिकट

String — दस्तावेज़ का आईडी.

अनुमति देना

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

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

getLanguage()

इससे दस्तावेज़ की भाषा का कोड मिलता है. यह वह भाषा है जो दस्तावेज़ एडिटर के फ़ाइल > भाषा में दिखती है. ऐसा हो सकता है कि दस्तावेज़ में मौजूद भाषा इससे अलग हो.

वापसी का टिकट

String|null — दस्तावेज़ की भाषा या अगर तय नहीं की गई है, तो null.

अनुमति देना

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

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

getName()

यह कुकी, दस्तावेज़ का टाइटल वापस पाती है.

वापसी का टिकट

String — दस्तावेज़ का टाइटल.

अनुमति देना

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

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

getNamedRangeById(id)

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

पैरामीटर

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

वापसी का टिकट

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

अनुमति देना

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

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

getNamedRanges()

यह पहले टैब में मौजूद सभी NamedRange ऑब्जेक्ट को फ़ेच करता है. इसके अलावा, दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, यह ऐक्टिव टैब में मौजूद सभी NamedRange ऑब्जेक्ट को फ़ेच करता है. किसी भी टैब में मौजूद सभी NamedRange ऑब्जेक्ट पाने के लिए, DocumentTab.getNamedRanges() तरीके का इस्तेमाल करें.

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

वापसी का टिकट

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

अनुमति देना

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

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

getNamedRanges(name)

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

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

पैरामीटर

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

वापसी का टिकट

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

अनुमति देना

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

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

getSelection()

इस फ़ंक्शन से, ऐक्टिव टैब में उपयोगकर्ता के चुने गए आइटम की जानकारी मिलती है. कोई स्क्रिप्ट सिर्फ़ उस उपयोगकर्ता के चुने गए डेटा को ऐक्सेस कर सकती है जो स्क्रिप्ट चला रहा है. ऐसा सिर्फ़ तब हो सकता है, जब स्क्रिप्ट दस्तावेज़ से बाइंड हो. 

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

वापसी का टिकट

Range|null — यह उपयोगकर्ता के चुने गए टेक्स्ट को दिखाता है. अगर उपयोगकर्ता ने टैब में कुछ भी नहीं चुना है, तो null दिखेगा. ऐसा तब भी होता है, जब सिर्फ़ पैराग्राफ़ का आखिरी हिस्सा चुना गया हो, सिर्फ़ पैराग्राफ़ का आखिरी हिस्सा और नई लाइन चुनी गई हो या स्क्रिप्ट को दस्तावेज़ से नहीं जोड़ा गया हो.

अनुमति देना

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

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

getSupportedLanguageCodes()

Google Docs फ़ाइलों में इस्तेमाल की जा सकने वाली सभी भाषाओं के कोड मिलते हैं.

वापसी का टिकट

String[] — यह भाषा कोड का एक कलेक्शन होता है.

अनुमति देना

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

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

getTab(tabId)

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

पैरामीटर

नामटाइपब्यौरा
tabIdStringउस टैब का आईडी जिसे पाना है.

वापसी का टिकट

Tab|null — डाला गया आईडी वाला Tab या अगर ऐसा कोई Tab मौजूद नहीं है, तो null.

अनुमति देना

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

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

getTabs()

यह दस्तावेज़ में मौजूद सभी अननेस्टेड Tab को दिखाता है.

टैब में चाइल्ड टैब हो सकते हैं. चाइल्ड टैब, किसी दूसरे टैब में नेस्ट किया गया टैब होता है. Tab.getChildTabs() का इस्तेमाल करके, चाइल्ड टैब ऐक्सेस किए जा सकते हैं.

वापसी का टिकट

Tab[] — दस्तावेज़ में मौजूद सभी Tab की सूची.

अनुमति देना

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

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

getUrl()

इस फ़ंक्शन का इस्तेमाल करके, मौजूदा दस्तावेज़ को ऐक्सेस करने के लिए यूआरएल वापस पाया जा सकता है. 

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

वापसी का टिकट

String — मौजूदा दस्तावेज़ को ऐक्सेस करने का यूआरएल.

अनुमति देना

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

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

getViewers()

इस Document के लिए, दर्शकों और टिप्पणी करने वालों की सूची मिलती है.

वापसी का टिकट

User[] — व्यू या टिप्पणी करने की अनुमति वाले उपयोगकर्ताओं की एक सूची.

अनुमति देना

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

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

newPosition(element, offset)

यह एक नया Position बनाता है. यह टैब में किसी जगह का रेफ़रंस होता है. यह रेफ़रंस, पहले टैब में मौजूद किसी खास एलिमेंट या दस्तावेज़ से बाइंड की गई स्क्रिप्ट के लिए, ऐक्टिव टैब के हिसाब से होता है. किसी टैब में मौजूद जगह के हिसाब से Position बनाने के लिए, DocumentTab.newPosition(element, offset) तरीके का इस्तेमाल करें. उपयोगकर्ता के कर्सर को Position के तौर पर दिखाया जाता है. इसके अलावा, इसका इस्तेमाल अन्य कामों के लिए भी किया जाता है. 

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.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 ऑब्जेक्ट बनाने के लिए किया जाता है. अगर स्क्रिप्ट किसी दस्तावेज़ से बाइंड है, तो इसका इस्तेमाल चालू टैब से Range ऑब्जेक्ट बनाने के लिए किया जाता है. किसी भी टैब में मौजूद टैब एलिमेंट से DocumentRange ऑब्जेक्ट बनाने के लिए इस्तेमाल किए जाने वाले बिल्डर को बनाने के लिए, DocumentTab.newRange() तरीके का इस्तेमाल करें. 

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.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

removeEditor(emailAddress)

इस विकल्प से, दिए गए उपयोगकर्ता को Document के एडिटर की सूची से हटा दिया जाता है. अगर उपयोगकर्ता ऐसे लोगों की कैटगरी में आता है जिनके पास सामान्य ऐक्सेस है, तो इस तरीके से उन्हें Document ऐक्सेस करने से नहीं रोका जा सकता. उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन के साथ शेयर किया गया है या अगर Document ऐसी शेयर की गई ड्राइव में है जिसे उपयोगकर्ता ऐक्सेस कर सकता है.

Drive में मौजूद फ़ाइलों के लिए, इससे उपयोगकर्ता को व्यूअर की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringउस उपयोगकर्ता का ईमेल पता जिसे हटाना है.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

removeEditor(user)

इस विकल्प से, दिए गए उपयोगकर्ता को Document के एडिटर की सूची से हटा दिया जाता है. अगर उपयोगकर्ता ऐसे लोगों की कैटगरी में आता है जिनके पास सामान्य ऐक्सेस है, तो इस तरीके से उन्हें Document ऐक्सेस करने से नहीं रोका जा सकता. उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन के साथ शेयर किया गया है या अगर Document ऐसी शेयर की गई ड्राइव में है जिसे उपयोगकर्ता ऐक्सेस कर सकता है.

Drive में मौजूद फ़ाइलों के लिए, इससे उपयोगकर्ता को व्यूअर की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
userUserउस उपयोगकर्ता का प्रतिनिधित्व जिसे हटाना है.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

removeViewer(emailAddress)

इस फ़ंक्शन का इस्तेमाल करके, किसी उपयोगकर्ता को Document के दर्शकों और टिप्पणीकारों की सूची से हटाया जा सकता है. अगर उपयोगकर्ता व्यूअर या टिप्पणीकार नहीं, बल्कि एडिटर है, तो इस तरीके का कोई असर नहीं पड़ता. इस तरीके से, उन उपयोगकर्ताओं को Document ऐक्सेस करने से भी नहीं रोका जाता है जिनके पास सामान्य ऐक्सेस होता है. उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन के साथ शेयर किया गया है या अगर Document किसी ऐसी शेयर की गई ड्राइव में है जिसे उपयोगकर्ता ऐक्सेस कर सकता है.

Drive की फ़ाइलों के लिए, इससे उपयोगकर्ता को संपादकों की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
emailAddressStringउस उपयोगकर्ता का ईमेल पता जिसे हटाना है.

वापसी का टिकट

Document — This Document for chaining.

अनुमति देना

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

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

removeViewer(user)

इस फ़ंक्शन का इस्तेमाल करके, किसी उपयोगकर्ता को Document के दर्शकों और टिप्पणीकारों की सूची से हटाया जा सकता है. अगर उपयोगकर्ता व्यूअर के बजाय एडिटर है, तो इस तरीके का कोई असर नहीं पड़ता. इस तरीके से, उन उपयोगकर्ताओं को Document ऐक्सेस करने से भी नहीं रोका जा सकता जो उपयोगकर्ताओं की ऐसी क्लास से जुड़े हैं जिनके पास सामान्य ऐक्सेस है. उदाहरण के लिए, अगर Document को उपयोगकर्ता के पूरे डोमेन के साथ शेयर किया गया है या अगर Document किसी ऐसी शेयर की गई ड्राइव में है जिसे उपयोगकर्ता ऐक्सेस कर सकता है.

Drive की फ़ाइलों के लिए, इससे उपयोगकर्ता को संपादकों की सूची से भी हटा दिया जाता है.

पैरामीटर

नामटाइपब्यौरा
userUserउस उपयोगकर्ता का प्रतिनिधित्व जिसे हटाना है.

वापसी का टिकट

Document — This Document for chaining.

अनुमति देना

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

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

saveAndClose()

इससे मौजूदा Document सेव हो जाता है. इससे पेंडिंग अपडेट लागू हो जाते हैं.

स्क्रिप्ट के पूरा होने पर, हर खुले हुए और बदलाव किए जा सकने वाले Document के लिए, saveAndClose() तरीका अपने-आप लागू हो जाता है.

बंद हो चुकी Document में बदलाव नहीं किया जा सकता. किसी दस्तावेज़ में बदलाव करने के लिए, उसे फिर से खोलने के लिए DocumentApp.openById() का इस्तेमाल करें.

अनुमति देना

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

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

setActiveTab(tabId)

यह फ़ंक्शन, मौजूदा दस्तावेज़ में उपयोगकर्ता के चुने गए Tab को, तय किए गए आईडी वाले टैब पर सेट करता है. 

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

पैरामीटर

नामटाइपब्यौरा
tabIdStringउस टैब का आईडी जिसे ऐक्टिव के तौर पर सेट करना है.

अनुमति देना

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

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

setCursor(position)

यह कुकी, उपयोगकर्ता के कर्सर को सेट करती है. इसके लिए, Position का इस्तेमाल किया जाता है. कोई स्क्रिप्ट सिर्फ़ उस उपयोगकर्ता के कर्सर को ऐक्सेस कर सकती है जो स्क्रिप्ट चला रहा है. ऐसा सिर्फ़ तब किया जा सकता है, जब स्क्रिप्ट दस्तावेज़ से बाइंड हो.

बंद किए गए Tab से Position देने पर, उपयोगकर्ता का चालू टैब बदल जाता है. 

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

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

पैरामीटर

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

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

setLanguage(languageCode)

इससे दस्तावेज़ की भाषा का कोड सेट किया जाता है. यह वह भाषा है जो दस्तावेज़ एडिटर के फ़ाइल > भाषा में दिखती है. ऐसा हो सकता है कि दस्तावेज़ में मौजूद भाषा इससे अलग हो. मान्य भाषा कोड की पूरी सूची पाने के लिए, getSupportedLanguageCodes() का इस्तेमाल करें.

पैरामीटर

नामटाइपब्यौरा
languageCodeStringभाषा कोड.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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

setName(name)

इस विकल्प से, दस्तावेज़ का टाइटल सेट किया जाता है.

पैरामीटर

नामटाइपब्यौरा
nameStringदस्तावेज़ का नया टाइटल.

वापसी का टिकट

Document — मौजूदा दस्तावेज़.

अनुमति देना

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

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

setSelection(range)

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

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

// Change the user's selection to a range that includes every table in the
// document.
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());

पैरामीटर

नामटाइपब्यौरा
rangeRangeचुने जाने वाले एलिमेंट की नई रेंज.

वापसी का टिकट

Document — यह Document, चेनिंग के लिए है.

अनुमति देना

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

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