Class NamedRange

NamedRange

Range له اسم ورقم تعريف للسماح باستردادهما لاحقًا الأسماء ليست فريدة بالضرورة؛ فقد تشترك عدة نطاقات مختلفة في نفس المستند في الاسم نفسه، مثل فئة في HTML إلى حد كبير. على النقيض من ذلك، تكون المعرفات فريدة داخل المستند، مثل المعرف في HTML. بعد إضافة NamedRange إلى مستند، لا يمكن تعديله بل تتم إزالته فقط.

يمكن الوصول إلى NamedRange من خلال أي نص برمجي يصل إلى المستند. لتجنب التعارضات غير المقصودة بين النصوص البرمجية، ضع بادئة لأسماء النطاقات بسلسلة فريدة.

// Create a named 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.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
getId()Stringالحصول على رقم تعريف NamedRange
getName()Stringيحصل على اسم هذا NamedRange.
getRange()Rangeللحصول على نطاق العناصر المرتبطة بسمة NamedRange هذه.
remove()voidإزالة NamedRange من المستند

الوثائق التفصيلية

getId()

الحصول على رقم تعريف NamedRange المعرّف فريد داخل المستند.

استرجاع الكرة

String: معرّف النطاق الفريد داخل المستند


getName()

يحصل على اسم هذا NamedRange. ولا يُفترَض أن يكون الاسم فريدًا.

استرجاع الكرة

String: اسم النطاق، والذي ليس فريدًا بالضرورة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

getRange()

للحصول على نطاق العناصر المرتبطة بسمة NamedRange هذه.

استرجاع الكرة

Range - نطاق العناصر المرتبطة بالاسم ورقم التعريف

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

remove()

إزالة NamedRange من المستند لا تحذف هذه الطريقة محتويات النطاق، وإنما تزيل المرجع فقط. إنّ استدعاء هذه الطريقة على NamedRange التي تمت إزالته لا يكون له أي تأثير.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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