Class RangeBuilder

RangeBuilder

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

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

مواد و روش ها

روش نوع برگشت توضیح مختصر
addElement(element) RangeBuilder یک Element کامل را به این RangeBuilder اضافه می کند.
addElement(textElement, startOffset, endOffsetInclusive) RangeBuilder یک عنصر Text جزئی به این RangeBuilder اضافه می کند.
addElementsBetween(startElement, endElementInclusive) RangeBuilder دو عنصر کامل و همه عناصر بین آنها را به این RangeBuilder اضافه می کند.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) RangeBuilder دو عنصر Text جزئی و همه عناصر بین آنها را به RangeBuilder اضافه می کند.
addRange(range) RangeBuilder محتویات یک Range دیگر را به این RangeBuilder اضافه می کند.
build() Range یک Range از تنظیمات اعمال شده برای سازنده ایجاد می کند.
getRangeElements() RangeElement[] همه عناصر را در این 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 اضافه می کند.

مولفه های

نام تایپ کنید شرح
textElement Text عنصر متنی که باید تا حدی اضافه شود
startOffset Integer تعداد کاراکترهای قبل از اولین کاراکتر مورد نظر (یعنی شاخص اولین کاراکتر در محدوده)
endOffsetInclusive Integer تعداد کاراکترهای قبل از آخرین کاراکتر مورد نظر (یعنی شاخص آخرین کاراکتر در محدوده)

برگشت

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

مجوز

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

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

addElementsBetween(startElement, endElementInclusive)

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

مولفه های

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

برگشت

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

مجوز

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

مولفه های

نام تایپ کنید شرح
startTextElement Text اولین عنصر متنی که تا حدی اضافه می شود
startOffset Integer تعداد کاراکترهای قبل از اولین کاراکتر startTextElement که باید گنجانده شود (یعنی شاخص اولین کاراکتر در محدوده)
endTextElementInclusive Text آخرین عنصر متنی که تا حدی اضافه می شود
endOffsetInclusive Integer تعداد کاراکترهای قبل از آخرین کاراکتر endTextElementInclusive که باید گنجانده شود (یعنی شاخص آخرین کاراکتر در محدوده)

برگشت

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

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