Class DocumentApp

DocumentApp

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

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
var 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.
var 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.
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.
// TODO(developer): Replace the ID with your own.
var doc = DocumentApp.openById('DOCUMENT_ID');

المعلمات

الاسمالنوعالوصف
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