Class DocumentApp

تطبيق "مستندات Google"

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

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// 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تعرِض هذه السمة المستند الذي يكون النص البرمجي مرتبطًا به.
getUi()Uiتُعيد مثيلًا لبيئة واجهة مستخدم المستند التي تسمح للنص البرمجي بإضافة ميزات مثل القوائم ومربّعات الحوار والأشرطة الجانبية.
openById(id)Documentلعرض المستند الذي يحمل المعرّف المحدّد.
openByUrl(url)Documentتفتح هذه الدالة المستند الذي يتضمّن عنوان URL المحدّد وتُرجعه.

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

create(name)

لإنشاء مستند جديد وإرجاعه 

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getActiveDocument()

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

// Get the document to which this script is bound.
const 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.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

المعلمات

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

الإرجاع

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

التفويض

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

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

openByUrl(url)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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