Class Document

दस्तावेज़

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

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

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

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

माटिंग में इस्तेमाल हुए तरीके

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

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

addBookmark(position)

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

पैरामीटर

नामटाइपब्यौरा
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()

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

रिटर्न टिकट

FooterSection — दस्तावेज़ का फ़ुटर

अनुमति देना

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

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

addHeader()

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

रिटर्न टिकट

HeaderSection — दस्तावेज़ का हेडर

अनुमति देना

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

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

addNamedRange(name, range)

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

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

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

पैरामीटर

नामटाइपब्यौरा
nameStringरेंज का नाम, जिसे यूनीक नहीं होना चाहिए. रेंज के नामों में कम से कम एक वर्ण और ज़्यादा से ज़्यादा 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

getAs(contentType)

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

पैरामीटर

नामटाइपब्यौरा
contentTypeStringMIME टाइप को ग्राहक में बदलने के लिए इसका इस्तेमाल करें; फ़िलहाल, यह सिर्फ़ 'application/pdf' पर काम करता है

रिटर्न टिकट

Blob — मौजूदा दस्तावेज़ को BLOB के तौर पर इस्तेमाल करें


getBlob()

वर्तमान Document सामग्री को BLOB के तौर पर वापस लाता है.

रिटर्न टिकट

Blob — मौजूदा दस्तावेज़ को BLOB के तौर पर इस्तेमाल करें


getBody()

सक्रिय दस्तावेज़'s Body को फिर से हासिल करता है.

दस्तावेज़ों में अलग-अलग तरह के सेक्शन हो सकते हैं (जैसे, HeaderSection, FooterSection). किसी दस्तावेज़ के लिए जो चालू सेक्शन है वह Body है.

Document में मौजूद एलिमेंट के तरीके, Body के लिए चालू हैं.

रिटर्न टिकट

Body — दस्तावेज़ का मुख्य हिस्सा

अनुमति देना

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

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

getBookmark(id)

Bookmark को दिए गए आईडी से मिलता है. अगर Bookmark नहीं है, तो यह तरीका null दिखाता है.

पैरामीटर

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

रिटर्न टिकट

Bookmark — दिए गए आईडी के साथ Bookmark या अगर ऐसा कोई Bookmark नहीं है, तो null

अनुमति देना

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

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

getBookmarks()

दस्तावेज़ में सभी Bookmark ऑब्जेक्ट पाएं.

रिटर्न टिकट

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.
var 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.
  var 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 को दिखाना.

अनुमति देना

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

  • 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()

अगर दस्तावेज़ का कोई फ़ुटर मौजूद है, तो उसे फिर से हासिल कर लिया जाता है.

रिटर्न टिकट

FooterSection — दस्तावेज़ का फ़ुटर

अनुमति देना

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

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

getFootnotes()

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

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

रिटर्न टिकट

Footnote[] — दस्तावेज़ के फ़ुटनोट

अनुमति देना

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

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

getHeader()

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

रिटर्न टिकट

HeaderSection — दस्तावेज़ का हेडर

अनुमति देना

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

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

getId()

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

रिटर्न टिकट

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

अनुमति देना

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

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

getLanguage()

दस्तावेज़ का भाषा कोड मिलता है. दस्तावेज़ एडिटर में दिखाई गई भाषा &g> भाषा, वह भाषा हो सकती है जो दस्तावेज़ में मौजूद न हो.

रिटर्न टिकट

String — दस्तावेज़ की भाषा या 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 नहीं है, तो यह तरीका null दिखाता है. नाम हमेशा यूनीक नहीं होते; एक ही दस्तावेज़ में कई अलग-अलग रेंज हो सकते हैं, जैसा कि एचटीएमएल में किसी क्लास का होता है. इसके उलट, दस्तावेज़ में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी.

पैरामीटर

नामटाइपब्यौरा
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

getSelection()

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

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

रिटर्न टिकट

Range — उपयोगकर्ता के चुने हुए विकल्प या 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

getUrl()

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

var 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 के रूप में दिखाया जाता है. इसके अलावा, अन्य इस्तेमाल भी किए जाते हैं.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var 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 ऑब्जेक्ट बनाने के लिए इस्तेमाल किया जाने वाला बिल्डर बनाता है.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var 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 — चेन बनाने के लिए यह Document.

अनुमति देना

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

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

removeViewer(user)

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

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

पैरामीटर

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

रिटर्न टिकट

Document — चेन बनाने के लिए यह Document.

अनुमति देना

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

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

saveAndClose()

मौजूदा Document को सेव करता है. इसकी वजह से, अपडेट किए जाने की प्रोसेस खत्म हो जाएगी और प्रोसेस लागू हो जाएगी.

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

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

अनुमति देना

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

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

setCursor(position)

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

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.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)

दस्तावेज़ का भाषा कोड सेट करता है. दस्तावेज़ एडिटर में दिखाई गई भाषा &g> भाषा, वह भाषा हो सकती है जो दस्तावेज़ में मौजूद न हो. सभी मान्य भाषा कोड पाने के लिए, 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 दिए जाने पर, सक्रिय दस्तावेज़ में उपयोगकर्ता और चुने गए को सेट करता है. स्क्रिप्ट सिर्फ़ उस उपयोगकर्ता के चुने हुए ऐक्सेस को ऐक्सेस कर सकती है जो स्क्रिप्ट चला रहा है और सिर्फ़ तब जब स्क्रिप्ट, दस्तावेज़ में बाइंड हो.

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