Class RangeElement

عنصر محدوده

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

روش‌ها

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

مستندات دقیق

getElement()

Element را که با این RangeElement مطابقت دارد، برمی‌گرداند.

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 - عنصری که با این RangeElement مطابقت دارد

مجوز

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

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

getEndOffsetInclusive()

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

بازگشت

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

مجوز

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

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

getStartOffset()

موقعیت شروع یک محدوده جزئی را در عنصر محدوده دریافت می‌کند. اگر عنصر یک عنصر Text باشد و isPartial() true را برگرداند، مقدار offset تعداد کاراکترهای قبل از شروع محدوده است (یعنی اندیس اولین کاراکتر در محدوده)؛ در هر حالت دیگر، این متد -1 را برمی‌گرداند.

بازگشت

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

مجوز

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

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

isPartial()

تعیین می‌کند که آیا این عنصر محدوده، کل عنصر یا بخشی از کاراکترهای عنصر را پوشش می‌دهد. ابتدا و انتهای محدوده یک عنصر محدوده جزئی را می‌توان به ترتیب با استفاده از getStartOffset() و getEndOffsetInclusive() تعیین کرد.

بازگشت

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

مجوز

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

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