تنشئ خدمة المستندات Documents
ويمكن تعديلها.
// Open a document by ID. var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE'); // Create and open a document. doc = DocumentApp.create('Document Name');
أماكن إقامة
الموقع | Type | الوصف |
---|---|---|
Attribute | Attribute | التعداد Attribute . |
ElementType | ElementType | التعداد ElementType . |
FontFamily |
| التعداد . |
GlyphType | GlyphType | التعداد GlyphType . |
HorizontalAlignment | HorizontalAlignment | التعداد HorizontalAlignment . |
ParagraphHeading | ParagraphHeading | التعداد ParagraphHeading . |
PositionedLayout | PositionedLayout | التعداد PositionedLayout . |
TextAlignment | TextAlignment | التعداد TextAlignment . |
VerticalAlignment | VerticalAlignment | التعداد 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');
المَعلمات
الاسم | Type | الوصف |
---|---|---|
name | String | اسم المستند الجديد |
استرجاع الكرة
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. var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');
المَعلمات
الاسم | Type | الوصف |
---|---|---|
id | String | معرف المستند لفتحه |
استرجاع الكرة
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');
المَعلمات
الاسم | Type | الوصف |
---|---|---|
url | String | عنوان URL للمستند لفتح |
استرجاع الكرة
Document
- مثيل المستند
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents