Class DocumentApp

DocumentApp

تنشئ خدمة المستندات 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');

الخصائص

الموقع	النوع	الوصف
Attribute	Attribute	تعداد Attribute
ElementType	ElementType	تعداد ElementType
FontFamily	FontFamily	تعداد 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.
const doc = DocumentApp.create('Document Name');

المَعلمات

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

الإرجاع

‫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');

المَعلمات

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

الإرجاع

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',
);

المَعلمات

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

الإرجاع

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

التفويض

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

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