Class RangeBuilder

رنج‌بیلدر

سازنده‌ای که برای ساخت اشیاء Range از عناصر سند استفاده می‌شود.

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

روش‌ها

روش نوع بازگشتی شرح مختصر
add Element(element) Range Builder یک Element کامل را به این Range Builder اضافه می‌کند.
add Element(textElement, startOffset, endOffsetInclusive) Range Builder یک عنصر Text جزئی به این Range Builder اضافه می‌کند.
add Elements Between(startElement, endElementInclusive) Range Builder دو عنصر کامل و تمام عناصر بین آنها را به این Range Builder اضافه می‌کند.
add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) Range Builder دو عنصر Text ناقص و تمام عناصر بین آنها را به Range Builder اضافه می‌کند.
add Range(range) Range Builder محتویات یک Range دیگر را به این Range Builder اضافه می‌کند.
build() Range یک Range از تنظیمات اعمال شده به سازنده می‌سازد.
get Range Elements() Range Element[] تمام عناصر موجود در این Range ، شامل هر عنصر Text جزئی (برای مثال، در مورد انتخابی که فقط بخشی از یک عنصر Text را شامل می‌شود) را برمی‌گرداند.

مستندات دقیق

addElement(element)

یک Element کامل را به این RangeBuilder اضافه می‌کند.

پارامترها

نام نوع توضیحات
element Element عنصری که قرار است اضافه شود

بازگشت

RangeBuilder — این سازنده، برای زنجیره‌سازی

مجوز

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

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

addElement(textElement, startOffset, endOffsetInclusive)

یک عنصر Text جزئی به این RangeBuilder اضافه می‌کند.

پارامترها

نام نوع توضیحات
text Element Text عنصر متنی که قرار است تا حدی اضافه شود
start Offset Integer تعداد کاراکترهای قبل از اولین کاراکتری که باید اضافه شود (یعنی، اندیس اولین کاراکتر در محدوده)
end Offset Inclusive Integer تعداد کاراکترهای قبل از آخرین کاراکتری که باید گنجانده شود (یعنی، اندیس آخرین کاراکتر در محدوده)

بازگشت

RangeBuilder — این سازنده، برای زنجیره‌سازی

مجوز

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

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

addElementsBetween(startElement, endElementInclusive)

دو عنصر کامل و تمام عناصر بین آنها را به این RangeBuilder اضافه می‌کند.

پارامترها

نام نوع توضیحات
start Element Element اولین عنصری که اضافه می‌شود
end Element Inclusive Element آخرین عنصری که اضافه می‌شود

بازگشت

RangeBuilder — این سازنده، برای زنجیره‌سازی

مجوز

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

دو عنصر Text جزئی و تمام عناصر بین آنها را به RangeBuilder اضافه می‌کند.

پارامترها

نام نوع توضیحات
start Text Element Text اولین عنصر متنی که به صورت جزئی اضافه می‌شود
start Offset Integer تعداد کاراکترهای قبل از اولین کاراکتر start Text Element که باید گنجانده شود (یعنی، اندیس اولین کاراکتر در محدوده)
end Text Element Inclusive Text آخرین عنصر متنی که به صورت جزئی اضافه شده است
end Offset Inclusive Integer تعداد کاراکترهای قبل از آخرین کاراکتر end Text Element Inclusive باید گنجانده شود (یعنی، اندیس آخرین کاراکتر در محدوده)

بازگشت

RangeBuilder — این سازنده، برای زنجیره‌سازی

مجوز

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

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

addRange(range)

محتویات یک Range دیگر را به این RangeBuilder اضافه می‌کند.

پارامترها

نام نوع توضیحات
range Range محدوده‌ای که عناصر آن باید اضافه شوند

بازگشت

RangeBuilder — این سازنده، برای زنجیره‌سازی

مجوز

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

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

build()

یک Range از تنظیمات اعمال شده به سازنده می‌سازد.

بازگشت

Range — محدوده تازه ساخته شده

getRangeElements()

تمام عناصر موجود در این Range ، شامل هر عنصر Text جزئی (برای مثال، در مورد انتخابی که فقط بخشی از یک عنصر Text را شامل می‌شود) را برمی‌گرداند. برای تعیین اینکه آیا یک عنصر Text فقط تا حدی در محدوده گنجانده شده است، به RangeElement.isPartial() مراجعه کنید.

بازگشت

RangeElement[] — آرایه‌ای از عناصر، به ترتیبی که در سند ظاهر می‌شوند

مجوز

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

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

متدهای منسوخ شده