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 را شامل می شود).

مستندات دقیق

add Element(element)

یک Element کامل را به این Range Builder اضافه می کند.

پارامترها

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

بازگشت

Range Builder - این سازنده، برای زنجیر کردن

مجوز

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

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

add Element(textElement, startOffset, endOffsetInclusive)

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

پارامترها

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

بازگشت

Range Builder - این سازنده، برای زنجیر کردن

مجوز

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

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

add Elements Between(startElement, endElementInclusive)

دو عنصر کامل و همه عناصر بین آنها را به این Range Builder اضافه می کند.

پارامترها

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

بازگشت

Range Builder - این سازنده، برای زنجیر کردن

مجوز

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

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

add Elements Between(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

پارامترها

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

بازگشت

Range Builder - این سازنده، برای زنجیر کردن

مجوز

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

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

add Range(range)

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

پارامترها

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

بازگشت

Range Builder - این سازنده، برای زنجیر کردن

مجوز

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

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

build()

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

بازگشت

Range - محدوده جدید ساخته شده است

get Range Elements()

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

بازگشت

Range Element[] - آرایه ای از عناصر، به ترتیبی که در سند ظاهر می شوند

مجوز

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

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

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