Class NamedRange

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