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()Integerयह getSurroundingText() से मिले Text एलिमेंट में मौजूद इस Position का ऑफ़सेट दिखाता है.
insertBookmark()Bookmarkइस Position पर एक नया Bookmark बनाता है और उसे डालता है.
insertInlineImage(image)InlineImage|nullयह फ़ंक्शन, दी गई इमेज के ब्लब से इस Position पर एक नया InlineImage बनाता है और उसे डालता है.
insertText(text)Text|nullइस 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 से पहले के वर्णों की संख्या. Paragraph या ListItem में 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 — नया इमेज एलिमेंट या null, अगर Position मौजूद एलिमेंट में इमेज डालने की अनुमति नहीं है

अनुमति देना

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

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

insertText(text)

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

पैरामीटर

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

वापसी का टिकट

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

अनुमति देना

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

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