Class RangeElement

عنصر محدوده

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

روش ها

روش نوع برگشت شرح مختصر
get Element() Element Element مربوط به این Range Element دریافت می کند.
get End Offset Inclusive() Integer موقعیت انتهای یک محدوده جزئی را در عنصر محدوده بدست می آورد.
get Start Offset() Integer موقعیت شروع یک محدوده جزئی را در عنصر محدوده بدست می آورد.
is Partial() Boolean تعیین می کند که آیا این عنصر محدوده کل عنصر را پوشش می دهد یا بخشی از کاراکترهای عنصر را پوشش می دهد.

مستندات دقیق

get Element()

Element مربوط به این Range Element دریافت می کند. 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// Log debug information about a range element.
Logger.log(`Element type: ${rangeElement.getElement().getType()}`);
if (rangeElement.isPartial()) {
  Logger.log(`The character range begins at ${rangeElement.getStartOffset()}`);
  Logger.log(
      `The character range ends at ${rangeElement.getEndOffsetInclusive()}`,
  );
} else {
  Logger.log('The entire range element is included.');
}

بازگشت

Element - عنصری که با این Range Element مطابقت دارد

مجوز

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

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

get End Offset Inclusive()

موقعیت انتهای یک محدوده جزئی را در عنصر محدوده بدست می آورد. اگر عنصر یک عنصر Text باشد و is Partial() true را برمی گرداند، offset تعداد کاراکترهای قبل از آخرین کاراکتر در محدوده است (یعنی شاخص آخرین کاراکتر در محدوده). در هر حالت دیگری، این روش -1 را برمی گرداند.

بازگشت

Integer - برای عناصر Text ، تعداد کاراکتر قبل از آخرین نویسه در محدوده. برای سایر عناصر، -1

مجوز

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

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

get Start Offset()

موقعیت شروع یک محدوده جزئی را در عنصر محدوده بدست می آورد. اگر عنصر یک عنصر Text باشد و is Partial() true برمی گرداند، offset تعداد کاراکترهای قبل از شروع محدوده است (یعنی شاخص اولین کاراکتر در محدوده). در هر حالت دیگری، این روش -1 را برمی گرداند.

بازگشت

Integer - برای عناصر Text ، تعداد کاراکترها قبل از شروع محدوده. برای سایر عناصر، -1

مجوز

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

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

is Partial()

تعیین می کند که آیا این عنصر محدوده کل عنصر را پوشش می دهد یا بخشی از کاراکترهای عنصر را پوشش می دهد. شروع و پایان محدوده یک عنصر محدوده جزئی را می توان به ترتیب با استفاده از get Start Offset() و get End Offset Inclusive() تعیین کرد.

بازگشت

Boolean - true اگر عنصر تا حدی گنجانده شده باشد. false اگر نه

مجوز

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

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