Class NamedRange

NamedRange

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

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

// Create a named range that includes every table in the active tab.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var rangeBuilder = documentTab.newRange();
var tables = documentTab.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.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