Class Tab

علامة التبويب

علامة تبويب ضمن مستند في "مستندات Google" 

// Get all of the first-level tabs (tabs that are not nested within a parent
// tab) in the document.
// TODO(developer): Replace the ID with your own.
const tabs = DocumentApp.openById('123abc').getTabs();

// Get a specific tab based on the tab ID.
// TODO(developer): Replace the IDs with your own.
const tab = DocumentApp.openById('123abc').getTab('123abc');

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
asDocumentTab()DocumentTabيستردّ محتوى علامة التبويب كـ DocumentTab.
getChildTabs()Tab[]تعرض هذه الطريقة علامات التبويب الفرعية المتداخلة ضمن علامة التبويب هذه.
getId()Stringتعرض هذه السمة رقم تعريف علامة التبويب.
getIndex()Integerتعرض هذه السمة الفهرس المستند إلى الرقم 0 لعلامة التبويب ضمن العنصر الرئيسي.
getTitle()Stringتعرض هذه السمة عنوان علامة التبويب.
getType()TabTypeتعرض هذه الطريقة نوع علامة التبويب.

مستندات تفصيلية

asDocumentTab()

يستردّ محتوى علامة التبويب كـ DocumentTab.

الإرجاع

DocumentTab: علامة التبويب كـ DocumentTab

getChildTabs()

تعرض هذه الطريقة علامات التبويب الفرعية المتداخلة ضمن علامة التبويب هذه.

الإرجاع

Tab[]: علامات التبويب الفرعية المتداخلة ضمن علامة التبويب هذه

التفويض

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

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

getId()

تعرض هذه السمة رقم تعريف علامة التبويب.

الإرجاع

String: رقم تعريف علامة التبويب.

التفويض

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

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

getIndex()

تعرض هذه السمة الفهرس المستند إلى الرقم 0 لعلامة التبويب ضمن العنصر الرئيسي.

الإرجاع

‫Integer: فهرس علامة التبويب ضمن العنصر الرئيسي

التفويض

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

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

getTitle()

تعرض هذه السمة عنوان علامة التبويب.

الإرجاع

String: تمثّل هذه السمة عنوان علامة التبويب.

التفويض

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

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

getType()

تعرض هذه الطريقة نوع علامة التبويب.

استخدِم هذه الطريقة لتحديد نوع محتوى Tab هذا قبل تحويله إلى النوع الأكثر تحديدًا باستخدام asDocumentTab(). 

const tab = DocumentApp.getActiveDocument().getActiveTab();
// Use getType() to determine the tab's type before casting.
if (tab.getType() === DocumentApp.TabType.DOCUMENT_TAB) {
  // It's a document tab, write some text to it.
  tab.asDocumentTab().setText('Hello World!');
} else {
  // There are currently no types other than DOCUMENT_TAB.
}

الإرجاع

‫TabType: نوع علامة التبويب

التفويض

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

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