Class 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() Integer افست این Position را در عنصر Text که توسط getSurroundingText() برگردانده شده است، دریافت می کند.
insertBookmark() Bookmark یک Bookmark جدید را در این Position ایجاد و درج می کند.
insertInlineImage(image) InlineImage یک InlineImage جدید در این Position از حباب تصویر مشخص شده ایجاد و درج می کند.
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 است، به طور مستقیم یا از طریق زنجیره ای از عناصر فرزند نشان می دهد. برای تعیین افست Position در عنصر Text برگشتی، از getSurroundingTextOffset() استفاده کنید.

بازگشت

Text - عنصری معادل نتیجه فراخوانی editAsText() در Paragraph یا ListItem که حاوی Position است، مستقیماً یا از طریق زنجیره ای از عناصر فرزند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

getSurroundingTextOffset()

افست این Position را در عنصر Text که توسط getSurroundingText() برگردانده شده است، دریافت می کند. افست تعداد کاراکترهای قبل از Position است (یعنی شاخص کاراکتر بعد از این Position ).

بازگشت

Integer - تعداد نویسه‌های قبل از این Position در Paragraph یا ListItem که حاوی Position است، مستقیماً یا از طریق زنجیره‌ای از عناصر فرزند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

insertBookmark()

یک Bookmark جدید را در این Position ایجاد و درج می کند.

بازگشت

Bookmark - نشانک جدید

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

insertInlineImage(image)

یک InlineImage جدید در این Position از حباب تصویر مشخص شده ایجاد و درج می کند.

پارامترها

نام تایپ کنید توضیحات
image BlobSource داده های تصویر برای درج در این Position

بازگشت

InlineImage - عنصر تصویر جدید، یا اگر عنصری که این Position در آن قرار دارد اجازه درج تصاویر را نمی دهد، null

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

insertText(text)

متن مشخص شده را در این Position درج می کند. این روش یک عنصر Text جدید ایجاد می کند، حتی اگر رشته در یک عنصر Text موجود درج شود، به طوری که استایل دادن به عنصر جدید آسان باشد.

پارامترها

نام تایپ کنید توضیحات
text String رشته ای که باید در این Position درج شود

بازگشت

Text - عنصر متن جدید، یا اگر عنصری که این Position در آن قرار دارد اجازه درج متن را نمی دهد، null است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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