Class Document

पहले टैब में दिए गए Position पर Bookmark जोड़ता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब में भी 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());

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

अगर कोई हेडर सेक्शन मौजूद नहीं है, तो पहले टैब में हेडर सेक्शन जोड़ता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब में हेडर सेक्शन जोड़ता है. किसी टैब में हेडर सेक्शन जोड़ने के लिए, 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

यह एक NamedRange जोड़ता है, जो एक Range होता है. इसमें एक नाम और आईडी होता है, जिसका इस्तेमाल बाद में डेटा को फिर से पाने के लिए किया जाता है. यह डेटा, पहले टैब में या किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब में सेव होता है. किसी भी टैब में NamedRange जोड़ने के लिए, DocumentTab.addNamedRange(name, range) का इस्तेमाल करें. नाम ज़रूरी नहीं है कि यूनीक हों. एक ही दस्तावेज़ में कई अलग-अलग रेंज का नाम एक जैसा हो सकता है, ठीक वैसे ही जैसे HTML में किसी क्लास का नाम. इसके उलट, दस्तावेज़ में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी. किसी दस्तावेज़ में 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());

पैरामीटर

वापसी का टिकट

NamedRange — NamedRange.

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

दस्तावेज़ में, उपयोगकर्ता का फ़िलहाल चालू 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 — उपयोगकर्ता का फ़िलहाल चालू Tab या null, अगर स्क्रिप्ट दस्तावेज़ से बंधी नहीं है.

अनुमति देना

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

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

यह फ़ंक्शन, मौजूदा 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());

पैरामीटर

वापसी का टिकट

Blob — मौजूदा दस्तावेज़ को ब्लॉब के तौर पर.

मौजूदा 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');

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

वापसी का टिकट

Blob — मौजूदा दस्तावेज़ को ब्लॉब के तौर पर.

पहले टैब का 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

पहले टैब में दिए गए आईडी के साथ 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.');
}

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

यह फ़ंक्शन, पहले टैब में मौजूद सभी 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

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

// 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, अगर उपयोगकर्ता के पास टैब में कोई कर्सर नहीं है या स्क्रिप्ट दस्तावेज़ से बंधी नहीं है.

अनुमति देना

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

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

इस Document के लिए, एडिटर की सूची दिखाता है.

वापसी का टिकट

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

अनुमति देना

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

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

पहले टैब के फ़ुटर सेक्शन को दिखाता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब के फ़ुटर सेक्शन को दिखाता है. किसी भी टैब का फ़ुटर सेक्शन पाने के लिए, 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 — टैब का फ़ुटर.

अनुमति देना

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

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

यह फ़ंक्शन, पहले टैब के मुख्य हिस्से में मौजूद सभी 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

पहले टैब के हेडर सेक्शन को दिखाता है. इसके अलावा, किसी दस्तावेज़ से बाउंड स्क्रिप्ट के लिए, ऐक्टिव टैब के हेडर सेक्शन को दिखाता है. किसी भी टैब का हेडर सेक्शन पाने के लिए, 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 — टैब का हेडर.

अनुमति देना

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

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

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

वापसी का टिकट

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

अनुमति देना

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

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

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

वापसी का टिकट

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

अनुमति देना

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

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

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

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

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

वापसी का टिकट

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

अनुमति देना

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

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

// 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 दिखता है. ऐसा तब भी होता है, जब सिर्फ़ पैराग्राफ़ का आखिरी हिस्सा चुना गया हो, सिर्फ़ पैराग्राफ़ का आखिरी हिस्सा और नई लाइन चुना गया हो या स्क्रिप्ट, दस्तावेज़ से बंधी न हो.

अनुमति देना

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

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

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

वापसी का टिकट

String[] — भाषा कोड का कलेक्शन.

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

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

वापसी का टिकट

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

अनुमति देना

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

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

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

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

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

वापसी का टिकट

User[] — उन उपयोगकर्ताओं का कलेक्शन जिन्हें फ़ाइल देखने या उस पर टिप्पणी करने की अनुमति है.

अनुमति देना

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

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

एक नया 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);

पैरामीटर

वापसी का टिकट

Position — नया Position.

अनुमति देना

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

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

यह एक बिल्डर बनाता है, जिसका इस्तेमाल पहले टैब में टैब एलिमेंट से 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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

मौजूदा Document सेव करता है. इससे, बाकी बचे अपडेट फ़्लश हो जाते हैं और लागू हो जाते हैं.

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

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

अनुमति देना

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

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

यह फ़ंक्शन, मौजूदा दस्तावेज़ में उपयोगकर्ता के चुने गए 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');

पैरामीटर

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

दस्तावेज़ का टाइटल सेट करता है.

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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

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

पैरामीटर

वापसी का टिकट

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

अनुमति देना

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

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