Class Position

Position

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

// Insert some text at the cursor position and make it bold.
var 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.
  var 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 से पहले के चाइल्ड एलिमेंट की संख्या होती है.

रिटर्न

IntegerText एलिमेंट के लिए, इस 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 के बाद वाले वर्ण का इंडेक्स) होता है.

रिटर्न

IntegerParagraph या 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 बनाता और डालता है.

पैरामीटर

नामTypeब्यौरा
imageBlobSourceइस Position पर डाला जाने वाला इमेज डेटा

रिटर्न

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

अनुमति देना

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

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

insertText(text)

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

पैरामीटर

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

रिटर्न

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

अनुमति देना

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

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