Class Document

تضيف هذه الدالة Bookmark إلى علامة التبويب الأولى أو إلى علامة التبويب النشطة في النصوص البرمجية المرتبطة بمستند، وذلك في Position المحدّد. لإضافة إشارة مرجعية إلى أي علامة تبويب، استخدِم الطريقة DocumentTab.addBookmark(position).

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

المعلمات

الإرجاع

Bookmark: الإشارة المرجعية الجديدة

التفويض

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

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

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المحرّرين في Document. إذا كان المستخدم مدرَجًا في قائمة المشاهدين، سيؤدي هذا الإجراء إلى إزالته من القائمة.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المحرّرين في Document. إذا كان المستخدم مدرَجًا في قائمة المشاهدين، سيؤدي هذا الإجراء إلى إزالته من القائمة.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضيف هذه الطريقة مصفوفة المستخدمين المحدّدة إلى قائمة المحرّرين في Document. إذا كان أي من المستخدمين مدرجًا في قائمة المشاهدين، ستؤدي هذه الطريقة إلى إزالته من القائمة.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضيف هذه السمة قسم تذييل، إذا لم يكن هناك قسم، إلى علامة التبويب الأولى أو، بالنسبة إلى النصوص البرمجية المرتبطة بمستند، إلى علامة التبويب النشطة. لإضافة قسم تذييل إلى أي علامة تبويب، استخدِم الطريقة DocumentTab.addFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

الإرجاع

FooterSection: تذييل علامة التبويب

التفويض

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

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

تضيف هذه السمة قسم رأس، إذا لم يكن هناك قسم، إلى علامة التبويب الأولى أو، بالنسبة إلى النصوص البرمجية المرتبطة بمستند، إلى علامة التبويب النشطة. لإضافة قسم عنوان إلى أي علامة تبويب، استخدِم طريقة DocumentTab.addHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Adds a header to the document's active or first tab.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

الإرجاع

HeaderSection: عنوان علامة التبويب

التفويض

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

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

يضيف هذا الرمز NamedRange، وهو Range يتضمّن اسمًا ورقم تعريف لاستخدامهما في عمليات استرداد لاحقة، وذلك في علامة التبويب الأولى أو علامة التبويب النشطة في حال كانت النصوص البرمجية مرتبطة بمستند. لإضافة NamedRange في أي علامة تبويب، استخدِم طريقة DocumentTab.addNamedRange(name, range). لا يشترط أن تكون الأسماء فريدة، إذ يمكن أن تتشارك عدة نطاقات مختلفة في المستند نفسه الاسم نفسه، تمامًا مثل الفئة في HTML. في المقابل، تكون المعرّفات فريدة داخل المستند، مثل المعرّف في HTML. بعد إضافة NamedRange إلى مستند، لا يمكنك تعديله، بل يمكنك فقط إزالته.

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

// Creates a named range that includes every table in the active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
// Adds the named range to the document's active tab.
doc.addNamedRange('Document tables', rangeBuilder.build());

المعلمات

الإرجاع

NamedRange — NamedRange

التفويض

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

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

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المشاهدين في Document. إذا كان المستخدم مدرجًا في قائمة المحرّرين، لن يكون لهذا الإجراء أي تأثير.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المشاهدين في Document. إذا كان المستخدم مدرجًا في قائمة المحرّرين، لن يكون لهذا الإجراء أي تأثير.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضيف هذه الطريقة مصفوفة المستخدمين المحدّدة إلى قائمة المشاهدين في Document. إذا كان أي من المستخدمين مدرجًا في قائمة المحرّرين، لن يكون لهذه الطريقة أي تأثير عليه.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تعرض هذه الدالة Tab المستخدم النشط حاليًا في المستند. لا يمكن للنص البرمجي الوصول إلا إلى علامة التبويب النشطة للمستخدم الذي يشغّل النص البرمجي، وذلك فقط إذا كان النص البرمجي مرتبطًا بالمستند.

// Display a dialog box that shows the title of the tab that the
// user is currently viewing.
const tab = DocumentApp.getActiveDocument().getActiveTab();
DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);

الإرجاع

استبدِل Tab بـ Tab، وهو null النشط حاليًا للمستخدم، إذا لم يكن النص البرمجي مرتبطًا بالمستند.

التفويض

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

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

يسترد محتوى Document الحالي ككائن ثنائي كبير من النوع المحدّد.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

المعلمات

الإرجاع

Blob: المستند الحالي ككائن ثنائي كبير الحجم

يستردّ محتوى Document الحالي ككائن ثنائي كبير.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Retrieves the current document's contents as a blob and logs it to the
// console.
console.log(doc.getBlob().getContentType());

الإرجاع

Blob: المستند الحالي ككائن ثنائي كبير الحجم

تعرض هذه الدالة Body لعلامة التبويب الأولى، أو DocumentBodySection لعلامة التبويب النشطة في النصوص البرمجية المرتبطة بمستند. للحصول على DocumentBodySection أي علامة تبويب، استخدِم الطريقة DocumentTab.getBody().

قد تحتوي علامات التبويب على أنواع مختلفة من الأقسام (مثل HeaderSection وFooterSection). القسم النشط لعلامة التبويب هو Body.

تتم تفويض طرق العناصر في Document إلى Body النشط.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the active or first tab's body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

الإرجاع

Body: قسم نص علامة التبويب

التفويض

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

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

تعرض هذه الدالة Bookmark الذي يحمل المعرّف المحدّد في علامة التبويب الأولى أو علامة التبويب النشطة في النصوص البرمجية المرتبطة بمستند. للحصول على إشارة مرجعية في أي علامة تبويب، استخدِم الطريقة DocumentTab.getBookmark(id). تعرض هذه الطريقة null إذا لم يكن هناك Bookmark من هذا النوع في علامة التبويب.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the bookmark by its ID in the document's active or first tab.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the
// console. otherwise, logs 'No bookmark exists with the given ID.' to the
// console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

المعلمات

الإرجاع

Bookmark|null: Bookmark الذي يحمل رقم التعريف المحدّد، أو null إذا لم يكن هناك Bookmark بهذا الرقم ضمن علامة التبويب

التفويض

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

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

تعرض هذه الدالة جميع عناصر Bookmark في علامة التبويب الأولى أو علامة التبويب النشطة في حال كانت النصوص البرمجية مرتبطة بمستند. للحصول على جميع الإشارات المرجعية في أي علامة تبويب، استخدِم الطريقة DocumentTab.getBookmarks().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('123abc');

// Gets all of the bookmarks in the document's active or first tab.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the tab to the console.
console.log(bookmarks.length);

الإرجاع

Bookmark[]: مصفوفة من عناصر Bookmark في علامة التبويب

التفويض

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

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

تعرض هذه الطريقة موضع مؤشر المستخدم في علامة التبويب النشطة. لا يمكن للنص البرمجي الوصول إلى مؤشر المستخدم الذي يشغّل النص البرمجي إلا إذا كان النص البرمجي مرتبطًا بالمستند.

// Insert some text at the cursor position and make it bold.
const cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns
  // null, the cursor's containing element doesn't allow insertions, so show the
  // user an error message.
  const element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

الإرجاع

‫Position|null: تمثّل مؤشر المستخدم، أو null إذا لم يكن لدى المستخدم مؤشر موضوع في علامة التبويب أو إذا لم يكن النص البرمجي مرتبطًا بالمستند.

التفويض

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

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

تعرض هذه الطريقة قائمة بالمحرّرين في Document.

الإرجاع

User[]: مصفوفة من المستخدمين الذين لديهم إذن التعديل.

التفويض

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

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

تعرض هذه الدالة قسم التذييل لعلامة التبويب الأولى، أو قسم التذييل لعلامة التبويب النشطة في النصوص البرمجية المرتبطة بمستند. للحصول على قسم التذييل في أي علامة تبويب، استخدِم طريقة DocumentTab.getFooter().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's footer and logs it to the console.
console.log(doc.getFooter().getText());

الإرجاع

FooterSection|null: تذييل علامة التبويب

التفويض

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

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

تعرض هذه الدالة جميع عناصر Footnote في نص علامة التبويب الأولى أو، بالنسبة إلى النصوص البرمجية المرتبطة بمستند، نص علامة التبويب النشطة. للحصول على جميع الحواشي السفلية في أي علامة تبويب، استخدِم طريقة DocumentTab.getFootnotes().

تؤدي طلبات البحث إلى getFootnotes إلى تكرار عناصر علامة التبويب. بالنسبة إلى علامات التبويب الكبيرة، تجنَّب إجراء مكالمات غير ضرورية لهذه الطريقة.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the first footnote in the active or first tab's body.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

الإرجاع

Footnote[]|null: الحواشي السفلية للأغنية

التفويض

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

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

تعرض هذه الدالة قسم العنوان لعلامة التبويب الأولى أو قسم العنوان لعلامة التبويب النشطة في النصوص البرمجية المرتبطة بمستند. للحصول على قسم العنوان في أي علامة تبويب، استخدِم الطريقة DocumentTab.getHeader().

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

الإرجاع

HeaderSection|null: عنوان علامة التبويب

التفويض

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

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

تعرض هذه الطريقة المعرّف الفريد للمستند. يتم استخدام معرّف المستند مع DocumentApp.openById() لفتح نسخة مستند معيّنة.

الإرجاع

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

التفويض

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

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

تعرض هذه الطريقة رمز لغة المستند. هذه هي اللغة المعروضة في ملف > اللغة في محرر المستندات، وقد لا تكون هي اللغة الفعلية التي يتضمّنها المستند.

الإرجاع

String: لغة المستند، أو null إذا لم يتم تحديدها.

التفويض

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

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

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

الإرجاع

String: عنوان المستند

التفويض

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

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

تعرض هذه الدالة NamedRange الذي يحمل المعرّف المحدّد في علامة التبويب الأولى أو علامة التبويب النشطة في النصوص البرمجية المرتبطة بمستند. للحصول على NamedRange باستخدام المعرّف المحدّد في أي علامة تبويب، استخدِم طريقة DocumentTab.getNamedRangeById(id). تعرض هذه الطريقة null إذا لم يكن هناك NamedRange في علامة التبويب. ليست الأسماء فريدة بالضرورة، حتى في علامات التبويب المختلفة، فقد تتشارك عدة نطاقات مختلفة في علامة التبويب نفسها الاسم نفسه، تمامًا مثل فئة في HTML. في المقابل، تكون المعرّفات فريدة ضمن علامة التبويب، مثل المعرّف في HTML.

المعلمات

الإرجاع

NamedRange|null: NamedRange الذي يحمل رقم التعريف المحدّد، أو null إذا لم يكن هناك نطاق بهذا الرقم في علامة التبويب

التفويض

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

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

تعرض هذه الدالة جميع عناصر NamedRange في علامة التبويب الأولى أو علامة التبويب النشطة في حال كانت النصوص البرمجية مرتبطة بمستند. للحصول على جميع عناصر NamedRange في أي علامة تبويب، استخدِم الطريقة DocumentTab.getNamedRanges().

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

الإرجاع

NamedRange[]: مصفوفة من عناصر NamedRange في علامة التبويب، وقد تتضمّن نطاقات متعددة بالاسم نفسه.

التفويض

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

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

تعرض هذه الدالة جميع عناصر NamedRange التي تحمل الاسم المحدّد في علامة التبويب الأولى، أو علامة التبويب النشطة في حال كانت النصوص البرمجية مرتبطة بمستند. للحصول على جميع عناصر NamedRange في أي علامة تبويب، استخدِم طريقة DocumentTab.getNamedRanges(name). ليست الأسماء فريدة بالضرورة، حتى في علامات التبويب المختلفة، فقد تتشارك عدة نطاقات مختلفة في علامة التبويب نفسها الاسم نفسه، تمامًا مثل فئة في HTML. في المقابل، تكون المعرّفات فريدة داخل علامة التبويب، مثل المعرّف في HTML.

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

المعلمات

الإرجاع

NamedRange[]: مصفوفة من عناصر NamedRange في علامة التبويب التي تحمل الاسم المحدّد

التفويض

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

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

تعرض هذه الدالة اختيار المستخدم في علامة التبويب النشطة. لا يمكن للنص البرمجي الوصول إلا إلى تحديد المستخدم الذي يشغّل النص البرمجي، وذلك فقط إذا كان النص البرمجي مرتبطًا بالمستند.

// Display a dialog box that tells the user how many elements are included in
// the selection.
const selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  const elements = selection.getRangeElements();
  DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

الإرجاع

Range|null — تمثيل لاختيار المستخدم، أو null إذا لم يحدّد المستخدم أي شيء في علامة التبويب، أو إذا تم تحديد نهاية فقرة فقط، أو إذا تم تحديد نهاية فقرة وسطر جديد فقط، أو إذا لم يكن النص البرمجي مرتبطًا بالمستند.

التفويض

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

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

تعرض هذه الطريقة جميع رموز اللغات المتوافقة مع ملفات "مستندات Google".

الإرجاع

String[]: مصفوفة من رموز اللغات

التفويض

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

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

تعرض هذه الطريقة Tab بالمعرّف المحدّد. يعرض هذا الإجراء null إذا لم يكن هناك Tab. يمكن الوصول إلى علامات التبويب في أي مستوى دمج.

المعلمات

الإرجاع

‫Tab: Tab الذي يحمل رقم التعريف المحدّد، أو null إذا لم يكن هناك Tab بهذا الرقم.

التفويض

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

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

تعرض هذه السمة جميع عناصر Tab غير المتداخلة التي تشكّل جزءًا من المستند.

يمكن أن تحتوي علامات التبويب على علامات تبويب فرعية، أي علامة تبويب مضمّنة في علامة تبويب أخرى. يمكن الوصول إلى علامات التبويب الفرعية باستخدام Tab.getChildTabs().

الإرجاع

Tab[]: قائمة بجميع Tab التي تشكّل جزءًا من المستند.

التفويض

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

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

تعرض هذه السمة عنوان URL للوصول إلى المستند الحالي.

const doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());

الإرجاع

String: عنوان URL للوصول إلى المستند الحالي

التفويض

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

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

تعرض هذه الطريقة قائمة بالمشاهدين والمعلّقين على Document.

الإرجاع

User[]: مصفوفة من المستخدمين الذين لديهم إذن بالاطّلاع أو التعليق

التفويض

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

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

تنشئ هذه السمة Position جديدًا، وهو مرجع إلى موقع جغرافي في علامة التبويب، بالنسبة إلى عنصر معيّن في علامة التبويب الأولى أو، بالنسبة إلى النصوص البرمجية المرتبطة بمستند، علامة التبويب النشطة. لإنشاء Position بالنسبة إلى موقع جغرافي في أي علامة تبويب، استخدِم طريقة DocumentTab.newPosition(element, offset). يتم تمثيل مؤشر المستخدم على شكل Position، من بين استخدامات أخرى.

// Append a paragraph to the active tab, then place the user's cursor after the
// first word of the new paragraph.
const doc = DocumentApp.getActiveDocument();
const paragraph = doc.getBody().appendParagraph('My new paragraph.');
const position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

المعلمات

الإرجاع

Position — Position الجديد

التفويض

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

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

تنشئ هذه الدالة أداة إنشاء تُستخدَم لإنشاء عناصر Range من عناصر علامة التبويب في علامة التبويب الأولى أو، بالنسبة إلى البرامج النصية المرتبطة بمستند، علامة التبويب النشطة. لإنشاء أداة إنشاء تُستخدَم لإنشاء عناصر DocumentRange من عناصر علامة التبويب في أي علامة تبويب، استخدِم الطريقة DocumentTab.newRange().

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const rangeBuilder = doc.newRange();
const tables = doc.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

الإرجاع

RangeBuilder: أداة الإنشاء الجديدة

التفويض

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

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

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحرّرين.

المعلمات

الإرجاع

‫Document: هذا Document للتسلسل.

التفويض

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

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

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

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحرّرين.

المعلمات

الإرجاع

‫Document: هذا Document للتسلسل.

التفويض

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

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

يحفظ هذا الخيار Document الحالي. يؤدي إلى إزالة التحديثات المعلّقة وتطبيقها.

يتم استدعاء طريقة saveAndClose() تلقائيًا في نهاية تنفيذ النص البرمجي لكل Document مفتوح قابل للتعديل.

لا يمكن تعديل Document مغلقة. استخدِم DocumentApp.openById() لإعادة فتح مستند معيّن لتعديله.

التفويض

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

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

يضبط هذا الإجراء Tab المستخدم المحدّد في المستند الحالي على علامة التبويب التي تحمل المعرّف المحدّد.

const doc = DocumentApp.getActiveDocument();

// Sets the user's selected tab by its ID.
// TODO(developer): Replace the ID with your own.
const tab = doc.setActiveTab('123abc');

المعلمات

التفويض

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

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

تضبط هذه السمة موضع مؤشر المستخدم، مع الأخذ في الاعتبار Position. لا يمكن للنص البرمجي الوصول إلى مؤشر المستخدم إلا إذا كان مرتبطًا بالمستند.

يؤدي توفير Position من Tab غير نشط إلى تبديل علامة التبويب النشطة للمستخدم.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Append a paragraph, then place the user's cursor after the first word of the
// new paragraph.
const paragraph = documentTab.getBody().appendParagraph('My new paragraph.');
const position = documentTab.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضبط هذه السمة رمز لغة المستند. هذه هي اللغة المعروضة في ملف > اللغة في محرر المستندات، وقد لا تكون هي اللغة الفعلية التي يتضمّنها المستند. استخدِم getSupportedLanguageCodes() للحصول على جميع رموز اللغة الصالحة.

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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

تضبط هذه السمة عنوان المستند.

المعلمات

الإرجاع

‫Document: المستند الحالي

التفويض

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

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

تضبط هذه السمة اختيار المستخدم في علامة التبويب النشطة، مع الأخذ في الاعتبار Range. لا يمكن للنص البرمجي الوصول إلا إلى المحتوى الذي يحدّده المستخدم الذي يشغّل النص البرمجي، وذلك فقط إذا كان النص البرمجي مرتبطًا بالمستند.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Change the user's selection to a range that includes every table in the
// document.
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

المعلمات

الإرجاع

Document: هذا Document، يُستخدَم لربط السلاسل.

التفويض

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

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