ऐसा Range
जिसमें एक नाम और आईडी होता है, ताकि बाद में डेटा वापस पाया जा सके. नाम ज़रूरी नहीं हैं. एक ही दस्तावेज़ में कई अलग-अलग रेंज में एक ही नाम हो सकता है. यह बिलकुल एचटीएमएल में बनी क्लास की तरह होता है. इसके उलट, दस्तावेज़ में आईडी यूनीक होते हैं, जैसे कि एचटीएमएल में आईडी. दस्तावेज़ में NamedRange
जोड़ने के बाद, उसमें बदलाव नहीं किया जा सकता, सिर्फ़ उसे हटाया जा सकता है.
NamedRange
को ऐसी कोई भी स्क्रिप्ट ऐक्सेस कर सकती है जो दस्तावेज़ को ऐक्सेस करती है. स्क्रिप्ट के बीच अनचाहे टकराव से बचने के लिए, रेंज के नामों के पहले एक यूनीक स्ट्रिंग लगाएं.
// Create a named 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.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