Class Document

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

تُضيف Bookmark في Position المحدَّد إلى علامة التبويب الأولى أو علامة التبويب النشطة في النصوص البرمجية التي يتم ربطها بمستند. لإضافة bookmarked إلى أي علامة تبويب، استخدِم الطريقة 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 التي تحمل المعرّف المحدّد في علامة التبويب الأولى أو علامة التبويب النشطة للنصوص البرمجية التي تكون مرتبطة بمستند. للحصول على bookmarked في أي علامة تبويب، استخدِم الطريقة 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: 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 إذا لم يكن لدى المستخدم سهم ملف شخصي في علامة التبويب أو إذا لم يكن النص البرمجي مرتبطًا بالمستند.

التفويض

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

• 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: تذييل علامة التبويب

التفويض

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

• 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[]: حواشي سفلية لعلامة التبويب

التفويض

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

• 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: عنوان علامة التبويب

التفويض

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

• 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: 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 إذا لم يكن لدى المستخدم أي عنصر محدّد في علامة التبويب، أو إذا تم اختيار نهاية الفقرة فقط، أو إذا تم اختيار نهاية الفقرة فقط وخط جديد، أو إذا لم يكن النص البرمجي مرتبطًا بالمستند

التفويض

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

• 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 للمستخدم بالكامل، أو إذا كان Document في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

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

المعلمات

الإرجاع

Document — هذا الرمز Document، لإنشاء سلسلة.

التفويض

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

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

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

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

المعلمات

الإرجاع

Document — هذا الرمز Document، لإنشاء سلسلة.

التفويض

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

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

تزيل هذه السمة المستخدم المحدّد من قائمة المشاهدين والمعلّقين في Document. لا تؤثّر هذه المحاولة في حال كان المستخدم محرِّرًا وليس مشاهدًا أو معلِقًا. لا تحظر هذه الطريقة أيضًا المستخدمين من الوصول إلى 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