تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class Document

مستند يحتوي على نص منسق وعناصر مثل الجداول والقوائم.

يمكن فتح المستندات أو إنشاؤها باستخدام DocumentApp.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

الطُرق

الطريقة	نوع الإرجاع	وصف قصير
`addBookmark(position)`	`Bookmark`	لإضافة `Bookmark` في `Position` المحددة.
`addEditor(emailAddress)`	`Document`	إضافة المستخدم المحدد إلى قائمة محرِّري `Document`.
`addEditor(user)`	`Document`	إضافة المستخدم المحدد إلى قائمة محرِّري `Document`.
`addEditors(emailAddresses)`	`Document`	لإضافة الصفيف المحدد من المستخدمين إلى قائمة المحررين لـ `Document`.
`addFooter()`	`FooterSection`	إضافة قسم تذييل المستند، في حالة عدم وجوده.
`addHeader()`	`HeaderSection`	لإضافة قسم رأس المستند، في حالة عدم وجوده.
`addNamedRange(name, range)`	`NamedRange`	تتم إضافة `NamedRange`، وهو `Range` وله اسم ورقم تعريف للاستخدام في وقت لاحق للاسترجاع.
`addViewer(emailAddress)`	`Document`	لإضافة المستخدم المحدد إلى قائمة مشاهدي `Document`.
`addViewer(user)`	`Document`	لإضافة المستخدم المحدد إلى قائمة مشاهدي `Document`.
`addViewers(emailAddresses)`	`Document`	لإضافة الصفيف المحدد من المستخدمين إلى قائمة مشاهدي `Document`.
`getAs(contentType)`	`Blob`	لاسترداد محتويات `Document` الحالية ككائن كائن تخزين بيانات من نوع محدد.
`getBlob()`	`Blob`	لاسترداد محتويات `Document` الحالية ككائن كائن ثنائي كبير.
`getBody()`	`Body`	لاسترداد `Body` للمستند النشط في المستند.
`getBookmark(id)`	`Bookmark`	تحصل على `Bookmark` مع المعرّف المحدّد.
`getBookmarks()`	`Bookmark[]`	للحصول على جميع كائنات `Bookmark` في المستند.
`getCursor()`	`Position`	للحصول على مؤشر المستخدم في المستند النشط.
`getEditors()`	`User[]`	للحصول على قائمة بالمحررين لهذه `Document`.
`getFooter()`	`FooterSection`	لاسترداد قسم تذييل المستند، إن وجد.
`getFootnotes()`	`Footnote[]`	لاسترداد جميع عناصر `Footnote` في نص المستند.
`getHeader()`	`HeaderSection`	لاسترداد قسم رأس المستند، إذا كان موجودًا.
`getId()`	`String`	لاسترداد المعرّف الفريد للمستند.
`getLanguage()`	`String`	للحصول على رمز لغة المستند.
`getName()`	`String`	لاسترداد عنوان المستند.
`getNamedRangeById(id)`	`NamedRange`	تحصل على `NamedRange` مع المعرّف المحدّد.
`getNamedRanges()`	`NamedRange[]`	للحصول على جميع كائنات `NamedRange` في المستند.
`getNamedRanges(name)`	`NamedRange[]`	للحصول على جميع كائنات `NamedRange` في المستند بالاسم الذي تم تحديده.
`getSelection()`	`Range`	للحصول على اختيار المستخدم في المستند النشط.
`getSupportedLanguageCodes()`	`String[]`	الحصول على جميع رموز اللغات المتوافقة في ملفات "مستندات Google"
`getUrl()`	`String`	لاسترداد عنوان URL للدخول إلى المستند الحالي.
`getViewers()`	`User[]`	لعرض قائمة المشاهدين والمعلقين على `Document`.
`newPosition(element, offset)`	`Position`	تنشئ `Position` جديدة، والتي تكون مرجعًا إلى موقع في المستند، بالنسبة إلى عنصر معين.
`newRange()`	`RangeBuilder`	لإنشاء أداة إنشاء تُستخدم لإنشاء كائنات `Range` من عناصر المستند.
`removeEditor(emailAddress)`	`Document`	إزالة المستخدم المحدد من قائمة المحررين لـ `Document`.
`removeEditor(user)`	`Document`	إزالة المستخدم المحدد من قائمة المحررين لـ `Document`.
`removeViewer(emailAddress)`	`Document`	يزيل المستخدم المعين من قائمة المشاهدين والمعلقين في `Document`.
`removeViewer(user)`	`Document`	يزيل المستخدم المعين من قائمة المشاهدين والمعلقين في `Document`.
`saveAndClose()`	`void`	لحفظ `Document` الحالية.
`setCursor(position)`	`Document`	تُحدِّد مؤشر المستخدم في المستند النشط، مع وضع `Position` في الاعتبار.
`setLanguage(languageCode)`	`Document`	لتعيين رمز لغة المستند.
`setName(name)`	`Document`	لتعيين عنوان المستند.
`setSelection(range)`	`Document`	لضبط اختيار المستخدم في المستند النشط، وفقًا لـ `Range`.

الوثائق التفصيلية

`addBookmark(position)`

لإضافة Bookmark في Position المحددة.

المعلَمات

الاسم	النوع	الوصف
`position`	`Position`	موضع الإشارة الجديدة

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addEditor(emailAddress)`

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

المعلَمات

الاسم	النوع	الوصف
`emailAddress`	`String`	عنوان البريد الإلكتروني للمستخدم المراد إضافته.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addEditor(user)`

المعلَمات

الاسم	النوع	الوصف
`user`	`User`	تمثيل للمستخدم لإضافته.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addEditors(emailAddresses)`

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

المعلَمات

الاسم	النوع	الوصف
`emailAddresses`	`String[]`	مصفوفة من عناوين البريد الإلكتروني للمستخدمين المطلوب إضافتهم.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addFooter()`

إضافة قسم تذييل المستند، في حالة عدم وجوده.

تذكرة ذهاب وعودة

FooterSection — تذييل المستند

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addHeader()`

لإضافة قسم رأس المستند، في حالة عدم وجوده.

تذكرة ذهاب وعودة

HeaderSection — عنوان المستند

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addNamedRange(name, range)`

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

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

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

المعلَمات

الاسم	النوع	الوصف
`name`	`String`	اسم النطاق الذي لا يلزم أن يكون فريدًا، بل يجب أن يتراوح عدد أحرف أسماء النطاقات بين 1 و256 حرفًا
`range`	`Range`	نطاق العناصر المراد إقرانه بالاسم، ويمكن أن يكون النطاق التحديد النشط أو نتيجة بحث أو تم إنشاؤه يدويًا باستخدام `newRange()`.

تذكرة ذهاب وعودة

NamedRange — NamedRange.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addViewer(emailAddress)`

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

المعلَمات

الاسم	النوع	الوصف
`emailAddress`	`String`	عنوان البريد الإلكتروني للمستخدم المراد إضافته.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addViewer(user)`

المعلَمات

الاسم	النوع	الوصف
`user`	`User`	تمثيل للمستخدم لإضافته.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`addViewers(emailAddresses)`

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

المعلَمات

الاسم	النوع	الوصف
`emailAddresses`	`String[]`	مصفوفة من عناوين البريد الإلكتروني للمستخدمين المطلوب إضافتهم.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getAs(contentType)`

لاسترداد محتويات Document الحالية ككائن كائن تخزين بيانات من نوع محدد.

المعلَمات

الاسم	النوع	الوصف
`contentType`	`String`	نوع MIME المراد التحويل إليه، لا يتوفر في الوقت الحالي سوى `'application/pdf'`

تذكرة ذهاب وعودة

Blob — المستند الحالي ككائن تخزين البيانات الثنائية الكبيرة

`getBlob()`

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

تذكرة ذهاب وعودة

Blob — المستند الحالي ككائن تخزين البيانات الثنائية الكبيرة

`getBody()`

لاسترداد Body للمستند النشط في المستند.

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

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

تذكرة ذهاب وعودة

Body — قسم نص المستند النشط

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getBookmark(id)`

تحصل على Bookmark مع المعرّف المحدّد. تعرض هذه الطريقة null في حال عدم وجود Bookmark.

المعلَمات

الاسم	النوع	الوصف
`id`	`String`	رقم تعريف `Bookmark`

تذكرة ذهاب وعودة

Bookmark - Bookmark بالمعرّف المحدّد، أو null في حال عدم توفّر Bookmark

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getBookmarks()`

للحصول على جميع كائنات Bookmark في المستند.

تذكرة ذهاب وعودة

Bookmark[] — مصفوفة من Bookmark من الكائنات في المستند

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getCursor()`

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

// Insert some text at the cursor position and make it bold.
var 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.
  var 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

`getEditors()`

للحصول على قائمة بالمحررين لهذه Document.

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getFooter()`

لاسترداد قسم تذييل المستند، إن وجد.

تذكرة ذهاب وعودة

FooterSection — تذييل المستند

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getFootnotes()`

لاسترداد جميع عناصر Footnote في نص المستند.

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

تذكرة ذهاب وعودة

Footnote[] — حواشي المستند

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getHeader()`

لاسترداد قسم رأس المستند، إذا كان موجودًا.

تذكرة ذهاب وعودة

HeaderSection — عنوان المستند

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getId()`

لاسترداد المعرّف الفريد للمستند. يتم استخدام معرّف المستند مع DocumentApp.openById() لفتح مثيل مستند محدّد.

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getLanguage()`

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

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getName()`

لاسترداد عنوان المستند.

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getNamedRangeById(id)`

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

المعلَمات

الاسم	النوع	الوصف
`id`	`String`	رقم تعريف النطاق، وهو فريد داخل المستند

تذكرة ذهاب وعودة

NamedRange - NamedRange برقم التعريف المحدّد، أو null في حال عدم وجود هذا النطاق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getNamedRanges()`

للحصول على جميع كائنات NamedRange في المستند.

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

تذكرة ذهاب وعودة

NamedRange[] — مصفوفة من NamedRange من العناصر في المستند، ومن المحتمل أن تتضمن نطاقات متعددة تحمل الاسم نفسه

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getNamedRanges(name)`

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

المعلَمات

الاسم	النوع	الوصف
`name`	`String`	اسم النطاق، والذي ليس بالضرورة فريدًا

تذكرة ذهاب وعودة

NamedRange[] — مصفوفة من NamedRange من الكائنات في المستند بالاسم المحدد

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getSelection()`

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

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var 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

`getSupportedLanguageCodes()`

الحصول على جميع رموز اللغات المتوافقة في ملفات "مستندات Google"

تذكرة ذهاب وعودة

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`getUrl()`

لاسترداد عنوان URL للدخول إلى المستند الحالي.

var 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

`getViewers()`

لعرض قائمة المشاهدين والمعلقين على Document.

تذكرة ذهاب وعودة

User[] — مصفوفة من المستخدمين الذين لديهم إذن بعرض أو تعليق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`newPosition(element, offset)`

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

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

المعلَمات

الاسم	النوع	الوصف
`element`	`Element`	العنصر الذي سيحتوي على السمة `Position` الجديدة، ويجب أن يكون إما عنصر `Text` أو عنصر حاوية مثل `Paragraph`
`offset`	`Integer`	بالنسبة إلى عناصر `Text`، عدد الأحرف قبل `Position`؛ بالنسبة إلى العناصر الأخرى، عدد العناصر الفرعية قبل `Position` داخل عنصر الحاوية نفسه

تذكرة ذهاب وعودة

Position — Position الجديد

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`newRange()`

لإنشاء أداة إنشاء تُستخدم لإنشاء كائنات Range من عناصر المستند.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var 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

`removeEditor(emailAddress)`

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

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

المعلَمات

الاسم	النوع	الوصف
`emailAddress`	`String`	عنوان البريد الإلكتروني للمستخدم المطلوب إزالته.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`removeEditor(user)`

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

المعلَمات

الاسم	النوع	الوصف
`user`	`User`	تمثيل للمستخدم لإزالته.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`removeViewer(emailAddress)`

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

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

المعلَمات

الاسم	النوع	الوصف
`emailAddress`	`String`	عنوان البريد الإلكتروني للمستخدم المطلوب إزالته.

تذكرة ذهاب وعودة

Document — هذا Document للتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`removeViewer(user)`

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

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

المعلَمات

الاسم	النوع	الوصف
`user`	`User`	تمثيل للمستخدم لإزالته.

تذكرة ذهاب وعودة

Document — هذا Document للتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`saveAndClose()`

لحفظ Document الحالية. يؤدي إلى مسح التحديثات التي في انتظار المراجعة وتطبيقها.

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

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

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`setCursor(position)`

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

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

المعلَمات

الاسم	النوع	الوصف
`position`	`Position`	موقع المؤشر الجديد

تذكرة ذهاب وعودة

Document - هذا Document، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`setLanguage(languageCode)`

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

المعلَمات

الاسم	النوع	الوصف
`languageCode`	`String`	رمز اللغة.

تذكرة ذهاب وعودة

Document — هذا Document، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`setName(name)`

لتعيين عنوان المستند.

المعلَمات

الاسم	النوع	الوصف
`name`	`String`	عنوان المستند الجديد

تذكرة ذهاب وعودة

Document — المستند الحالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

`setSelection(range)`

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

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

المعلَمات

الاسم	النوع	الوصف
`range`	`Range`	النطاق الجديد للعناصر المراد تحديده

تذكرة ذهاب وعودة

Document - هذا Document، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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