Class Position

Position

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

// 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.');
}

तरीके

तरीकारिटर्न टाइपसंक्षिप्त विवरण
getElement()Elementवह एलिमेंट दिखाता है जिसमें यह Position मौजूद है.
getOffset()Integerइस Position की रिलेटिव लोकेशन, उस एलिमेंट में दिखाता है जिसमें यह शामिल है.
getSurroundingText()Textयह एक कृत्रिम Text एलिमेंट बनाता है, जो Paragraph या ListItem के टेक्स्ट और फ़ॉर्मैटिंग को दिखाता है. इसमें Position, सीधे तौर पर या चाइल्ड एलिमेंट की चेन के ज़रिए शामिल होता है.
getSurroundingTextOffset()IntegergetSurroundingText() से दिखाए गए Text एलिमेंट में, इस Position का ऑफ़सेट दिखाता है.
insertBookmark()Bookmarkइस Position पर एक नया Bookmark बनाता है और उसे डालता है.
insertInlineImage(image)InlineImageतय की गई इमेज के ब्लॉक से, इस Position पर एक नया InlineImage बनाता है और उसे डालता है.
insertText(text)Textइस Position में बताए गए टेक्स्ट को डालता है.

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

getElement()

वह एलिमेंट दिखाता है जिसमें यह Position मौजूद है. यह Text एलिमेंट या Paragraph जैसा कंटेनर एलिमेंट होगा. दोनों ही मामलों में, एलिमेंट में रिलेटिव पोज़िशन को getOffset() से तय किया जा सकता है.

वापसी का टिकट

Element — वह कंटेनर या Text एलिमेंट जिसमें यह Position ऑब्जेक्ट मौजूद है

getOffset()

इस Position की रिलेटिव लोकेशन, उस एलिमेंट में दिखाता है जिसमें यह शामिल है. अगर एलिमेंट Text एलिमेंट है, तो ऑफ़सेट Position से पहले के वर्णों की संख्या है. इसका मतलब है कि Position के बाद के वर्ण का इंडेक्स. किसी भी दूसरे एलिमेंट के लिए, ऑफ़सेट उसी कंटेनर एलिमेंट में Position से पहले के चाइल्ड एलिमेंट की संख्या है. इसका मतलब है कि Position के बाद के चाइल्ड एलिमेंट का इंडेक्स.

वापसी का टिकट

Integer — Text एलिमेंट के लिए, इस Position से पहले वाले वर्णों की संख्या; अन्य एलिमेंट के लिए, एक ही कंटेनर एलिमेंट में इस Position से पहले वाले चाइल्ड एलिमेंट की संख्या

अनुमति देना

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

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

getSurroundingText()

यह एक कृत्रिम Text एलिमेंट बनाता है, जो Paragraph या ListItem के टेक्स्ट और फ़ॉर्मैटिंग को दिखाता है. इसमें Position, सीधे तौर पर या चाइल्ड एलिमेंट की चेन के ज़रिए शामिल होता है. Text एलिमेंट में Position के ऑफ़सेट का पता लगाने के लिए, getSurroundingTextOffset() का इस्तेमाल करें.

वापसी का टिकट

Text — Paragraph या ListItem पर editAsText() को कॉल करने के नतीजे के बराबर का एलिमेंट, जिसमें Position सीधे तौर पर या चाइल्ड एलिमेंट की चेन के ज़रिए शामिल होता है

अनुमति देना

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

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

getSurroundingTextOffset()

getSurroundingText() से दिखाए गए Text एलिमेंट में, इस Position का ऑफ़सेट दिखाता है. ऑफ़सेट, Position के पहले वाले वर्णों की संख्या होती है (यानी, इस Position के बाद वाले वर्ण का इंडेक्स).

वापसी का टिकट

Integer — Paragraph या ListItem में इस Position से पहले वाले वर्णों की संख्या, जिसमें Position सीधे तौर पर या चाइल्ड एलिमेंट की चेन के ज़रिए शामिल है

अनुमति देना

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

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

insertBookmark()

इस Position पर एक नया Bookmark बनाता है और उसे डालता है.

वापसी का टिकट

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

अनुमति देना

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

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

insertInlineImage(image)

तय की गई इमेज के ब्लॉक से, इस Position पर एक नया InlineImage बनाता है और उसे डालता है.

पैरामीटर

नामटाइपब्यौरा
imageBlobSourceइस Position में डालने के लिए इमेज का डेटा

वापसी का टिकट

InlineImage — नया इमेज एलिमेंट या null, अगर उस एलिमेंट में Position मौजूद है जिसमें इमेज डालने की अनुमति नहीं है

अनुमति देना

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

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

insertText(text)

इस Position में बताए गए टेक्स्ट को डालता है. इस तरीके से, एक नया Text एलिमेंट बनता है. भले ही, स्ट्रिंग को किसी मौजूदा Text एलिमेंट में डाला गया हो. इससे, नए एलिमेंट को स्टाइल करना आसान हो जाता है.

पैरामीटर

नामटाइपब्यौरा
textStringइस Position में डाली जाने वाली स्ट्रिंग

वापसी का टिकट

Text — नया टेक्स्ट एलिमेंट या null, अगर उस एलिमेंट में Position मौजूद है जिसमें टेक्स्ट डालने की अनुमति नहीं है

अनुमति देना

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

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