Class NamedRange

النطاق المُعنوَن

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

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

// Create a named range that includes every table in the active tab.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let 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