Class DocumentApp

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

تنشئ خدمة المستند Documents وتفتحها والتي يمكن تعديلها.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

// Create and open a document.
doc = DocumentApp.create('Document Name');

أماكن إقامة

الخاصيةالنوعالوصف
AttributeAttributeتعداد Attribute
ElementTypeElementTypeتعداد ElementType
FontFamilyFontFamilyتعداد FontFamily
GlyphTypeGlyphTypeتعداد GlyphType
HorizontalAlignmentHorizontalAlignmentتعداد HorizontalAlignment
ParagraphHeadingParagraphHeadingتعداد ParagraphHeading
PositionedLayoutPositionedLayoutتعداد PositionedLayout
TextAlignmentTextAlignmentتعداد TextAlignment
VerticalAlignmentVerticalAlignmentتعداد VerticalAlignment

الطُرق

الطريقةنوع الإرجاعوصف قصير
create(name)Documentتنشئ مستندًا جديدًا وتعرضه.
getActiveDocument()Documentيعرض المستند الذي يكون فيه النص البرمجي container-bound (تم ربط الحساب).
getUi()Uiلعرض نسخة من بيئة واجهة المستخدم في المستند التي تسمح للنص البرمجي بإضافة ميزات، مثل القوائم ومربّعات الحوار والأشرطة الجانبية.
openById(id)Documentعرض المستند الذي يحمل المعرّف المحدّد
openByUrl(url)Documentيفتح المستند ويعرض عنوان URL المحدّد.

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

create(name)

تنشئ مستندًا جديدًا وتعرضه.

// Create and open a new document.
var doc = DocumentApp.create('Document Name');

المعلّمات

الاسمالنوعالوصف
nameStringاسم المستند الجديد

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

Document: مثيل المستند الجديد

التفويض

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

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

getActiveDocument()

يعرض المستند الذي يكون فيه النص البرمجي container-bound (تم ربط الحساب). للتفاعل مع المستند الذي لا يرتبط به النص البرمجي، استخدِم openById(id) أو openByUrl(url) بدلاً منه.

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

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

Document - مثيل المستند

التفويض

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

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

getUi()

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

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

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

Ui — نسخة من بيئة واجهة المستخدم لهذا المستند


openById(id)

عرض المستند الذي يحمل المعرّف المحدّد إذا كان النص البرمجي مرتبطًا ب الحاوية، استخدِم getActiveDocument() بدلاً من ذلك.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف المستند المطلوب فتحه

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

Document - مثيل المستند

التفويض

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

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

openByUrl(url)

يفتح المستند ويعرض عنوان URL المحدّد. إذا كان النص البرمجي مرتبطًا بالمستند في المستند، استخدِم getActiveDocument() بدلاً من ذلك.

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

المعلّمات

الاسمالنوعالوصف
urlStringعنوان URL للمستند المطلوب فتحه

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

Document - مثيل المستند

التفويض

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

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