Class NamedRange

NamedRange

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

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

// Create a named range that includes every table in the active tab.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
getId()Stringइस NamedRange का आईडी मिलता है.
getName()Stringइस NamedRange का नाम मिलता है.
getRange()Rangeइस NamedRange से जुड़े एलिमेंट की रेंज मिलती है.
remove()voidइस NamedRange को टैब से हटाता है.

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

getId()

इस NamedRange का आईडी मिलता है. यह आईडी, टैब में यूनीक होता है.

वापसी का टिकट

String — रेंज का आईडी, जो टैब में यूनीक होता है.

getName()

इस NamedRange का नाम मिलता है. यह ज़रूरी नहीं है कि नाम यूनीक हो.

वापसी का टिकट

String — रेंज का नाम. यह ज़रूरी नहीं है कि यह यूनीक हो.

अनुमति देना

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

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

getRange()

इस NamedRange से जुड़े एलिमेंट की रेंज मिलती है.

वापसी का टिकट

Range — नाम और आईडी से जुड़े एलिमेंट की रेंज.

अनुमति देना

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

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

remove()

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

अनुमति देना

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

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