محتوى علامة تبويب في مستند "مستندات Google" وقد يحتوي Body
على ListItem
،
العناصر Paragraph
وTable
وTableOfContents
لمزيد من المعلومات حول
بنية المستند، فراجع دليل
"مستندات Google"
يشتمل Body
عادةً على محتوى علامة التبويب بالكامل باستثناء العناصر HeaderSection
وFooterSection
وأي عناصر FootnoteSection
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph("A paragraph."); body.appendPageBreak();
الطُرق
الطريقة | نوع الإرجاع | وصف قصير |
---|---|---|
appendHorizontalRule() | HorizontalRule | تنشئ سمة HorizontalRule جديدة وتلحقها |
appendImage(image) | InlineImage | تنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة. |
appendImage(image) | InlineImage | تُرفِق السمة InlineImage المحدّدة. |
appendListItem(listItem) | ListItem | تُرفِق السمة ListItem المحدّدة. |
appendListItem(text) | ListItem | تنشئ هذه السمة ListItem جديدًا وتلحقها به المحتوى النصي المحدّد. |
appendPageBreak() | PageBreak | تنشئ سمة PageBreak جديدة وتلحقها |
appendPageBreak(pageBreak) | PageBreak | تُرفِق السمة PageBreak المحدّدة. |
appendParagraph(paragraph) | Paragraph | تُرفِق السمة Paragraph المحدّدة. |
appendParagraph(text) | Paragraph | تنشئ هذه السمة Paragraph جديدًا وتلحقها به المحتوى النصي المحدّد. |
appendTable() | Table | تنشئ سمة Table جديدة وتلحقها |
appendTable(cells) | Table | لإلحاق Table جديد يحتوي على TableCell لكل قيمة سلسلة محددة. |
appendTable(table) | Table | تُرفِق السمة Table المحدّدة. |
clear() | Body | يؤدي إلى محو محتوى العنصر. |
copy() | Body | لعرض نسخة منفصلة عميقة من العنصر الحالي. |
editAsText() | Text | الحصول على نسخة Text من العنصر الحالي للتعديل. |
findElement(elementType) | RangeElement | يبحث في محتوى العنصر عن تابع من النوع المحدد. |
findElement(elementType, from) | RangeElement | يبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من
تم تحديد RangeElement . |
findText(searchPattern) | RangeElement | للبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية. |
findText(searchPattern, from) | RangeElement | يبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث. |
getAttributes() | Object | يسترد سمات العنصر. |
getChild(childIndex) | Element | استرداد العنصر الفرعي في الفهرس الفرعي المحدد. |
getChildIndex(child) | Integer | استرداد الفهرس الفرعي للعنصر الفرعي المحدد. |
getHeadingAttributes(paragraphHeading) | Object | لاسترداد مجموعة السمات لـ ParagraphHeading المقدَّم. |
getImages() | InlineImage[] | لاسترداد كل InlineImages المضمَّنة في القسم |
getListItems() | ListItem[] | لاسترداد كل ListItems المضمَّنة في القسم |
getMarginBottom() | Number | لاسترداد الهامش السفلي بالنقاط. |
getMarginLeft() | Number | لاسترداد الهامش الأيسر، بالنقاط. |
getMarginRight() | Number | استرداد الهامش الأيمن. |
getMarginTop() | Number | لاسترداد الهامش العلوي. |
getNumChildren() | Integer | لاسترداد عدد الأطفال. |
getPageHeight() | Number | لاسترداد ارتفاع الصفحة بالنقاط. |
getPageWidth() | Number | لاسترداد عرض الصفحة بالنقاط. |
getParagraphs() | Paragraph[] | استرداد كل Paragraphs المضمَّنة في القسم (بما في ذلك ListItems ). |
getParent() | ContainerElement | استرداد العنصر الأصلي للعنصر. |
getTables() | Table[] | لاسترداد كل Tables المضمَّنة في القسم |
getText() | String | لاسترداد محتوى العنصر كسلسلة نصية. |
getTextAlignment() | TextAlignment | الحصول على محاذاة النص |
getType() | ElementType | لاسترداد ElementType للعنصر. |
insertHorizontalRule(childIndex) | HorizontalRule | تنشئ السمة HorizontalRule جديدة وإدراجها في الفهرس المحدّد. |
insertImage(childIndex, image) | InlineImage | تنشئ وإدراج InlineImage من الكائن الثنائي الكبير (blob) الخاص بالصورة المحدد،
الفهرس. |
insertImage(childIndex, image) | InlineImage | إدراج InlineImage المحدّد في الفهرس المحدّد |
insertListItem(childIndex, listItem) | ListItem | إدراج ListItem المحدّد في الفهرس المحدّد |
insertListItem(childIndex, text) | ListItem | تنشئ وإدراج ListItem جديدة في الفهرس المحدد، وتحتوي على المحددة
المحتوى النصي. |
insertPageBreak(childIndex) | PageBreak | تنشئ السمة PageBreak جديدة وإدراجها في الفهرس المحدّد. |
insertPageBreak(childIndex, pageBreak) | PageBreak | إدراج PageBreak المحدّد في الفهرس المحدّد |
insertParagraph(childIndex, paragraph) | Paragraph | إدراج Paragraph المحدّد في الفهرس المحدّد |
insertParagraph(childIndex, text) | Paragraph | تنشئ وإدراج Paragraph جديدة في الفهرس المحدد، وتحتوي على المحددة
المحتوى النصي. |
insertTable(childIndex) | Table | تنشئ السمة Table جديدة وإدراجها في الفهرس المحدّد. |
insertTable(childIndex, cells) | Table | تنشئ وإدراج Table جديدة تحتوي على الخلايا المحددة، في الفهرس المحدد. |
insertTable(childIndex, table) | Table | إدراج Table المحدّد في الفهرس المحدّد |
removeChild(child) | Body | إزالة العنصر الفرعي المحدد |
replaceText(searchPattern, replacement) | Element | لاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات. |
setAttributes(attributes) | Body | يعيّن سمات العنصر. |
setHeadingAttributes(paragraphHeading, attributes) | Body | تضبط السمات للسمة ParagraphHeading المقدَّمة. |
setMarginBottom(marginBottom) | Body | لضبط الهامش السفلي بالنقاط. |
setMarginLeft(marginLeft) | Body | لتعيين الهامش الأيسر، بالنقاط. |
setMarginRight(marginRight) | Body | لتعيين الهامش الأيمن بالنقاط. |
setMarginTop(marginTop) | Body | لضبط الهامش العلوي. |
setPageHeight(pageHeight) | Body | لضبط ارتفاع الصفحة بالنقاط. |
setPageWidth(pageWidth) | Body | لضبط عرض الصفحة بالنقاط. |
setText(text) | Body | لضبط المحتوى كنص عادي |
setTextAlignment(textAlignment) | Body | لضبط محاذاة النص. |
الوثائق التفصيلية
appendHorizontalRule()
تنشئ سمة HorizontalRule
جديدة وتلحقها
سيتم تضمين HorizontalRule
في Paragraph
جديد.
الإرجاع
HorizontalRule
— القاعدة الأفقية الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
تنشئ هذه الدالة InlineImage
جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
سيتم تضمين الصورة في Paragraph
جديد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
image | BlobSource | بيانات الصورة |
الإرجاع
InlineImage
— الصورة الملحقة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
تُرفِق السمة InlineImage
المحدّدة.
سيتم تضمين InlineImage
في Paragraph
جديد.
استخدام هذا الإصدار من appendImage
عند إلحاق نسخة من InlineImage
حالية.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
image | InlineImage | بيانات الصورة |
الإرجاع
InlineImage
— الصورة الملحقة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
تُرفِق السمة ListItem
المحدّدة.
استخدام هذا الإصدار من appendListItem
عند إلحاق نسخة من ListItem
حالية.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
listItem | ListItem | عنصر القائمة المطلوب إلحاقه. |
الإرجاع
ListItem
— عنصر القائمة الملحق
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
تنشئ هذه السمة ListItem
جديدًا وتلحقها به المحتوى النصي المحدّد.
تتم إضافة عناصر القائمة المتتالية كجزء من القائمة نفسها.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
text | String | المحتوى النصي لعنصر القائمة. |
الإرجاع
ListItem
— عنصر القائمة الجديد.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
تنشئ سمة PageBreak
جديدة وتلحقها
سيتم تضمين PageBreak
في Paragraph
جديد.
الإرجاع
PageBreak
— فاصل الصفحات الجديد.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
تُرفِق السمة PageBreak
المحدّدة.
سيتم تضمين PageBreak
في Paragraph
جديد.
استخدام هذا الإصدار من appendPageBreak
عند إلحاق نسخة من PageBreak
حالية.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
pageBreak | PageBreak | فاصل الصفحة المطلوب إلحاقه. |
الإرجاع
PageBreak
— فاصل الصفحة الملحق.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
تُرفِق السمة Paragraph
المحدّدة.
استخدام هذا الإصدار من appendParagraph
عند إلحاق نسخة من Paragraph
حالية.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
paragraph | Paragraph | الفقرة المطلوب إلحاقها. |
الإرجاع
Paragraph
— الفقرة الملحقة.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendParagraph(text)
تنشئ هذه السمة Paragraph
جديدًا وتلحقها به المحتوى النصي المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
text | String | المحتوى النصي للفقرة |
الإرجاع
Paragraph
— الفقرة الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable()
تنشئ سمة Table
جديدة وتلحقها
ستعمل هذه الطريقة أيضًا على إلحاق فقرة فارغة بعد الجدول، نظرًا لأن مستندات Google Docs لا يمكن أن ينتهي بجدول.
الإرجاع
Table
: الجدول الجديد
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(cells)
لإلحاق Table
جديد يحتوي على TableCell
لكل قيمة سلسلة محددة.
ستعمل هذه الطريقة أيضًا على إلحاق فقرة فارغة بعد الجدول، نظرًا لأن مستندات Google Docs لا يمكن أن ينتهي بجدول.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
cells | String[][] | المحتوى النصي لخلايا الجدول المطلوب إضافتها إلى الجدول الجديد. |
الإرجاع
Table
— الجدول الملحق.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
تُرفِق السمة Table
المحدّدة.
استخدام هذا الإصدار من appendTable
عند إلحاق نسخة من Table
حالية.
ستعمل هذه الطريقة أيضًا على إلحاق فقرة فارغة بعد الجدول، نظرًا لأن مستندات Google Docs
لا يمكن أن ينتهي بجدول.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
table | Table | الجدول المطلوب إلحاقه. |
الإرجاع
Table
— الجدول الملحق.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
لعرض نسخة منفصلة عميقة من العنصر الحالي.
ويتم أيضًا نسخ أي عناصر فرعية موجودة في العنصر. لا يحتوي العنصر الجديد على أحد الوالدين.
الإرجاع
Body
: النسخة الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
الحصول على نسخة Text
من العنصر الحالي للتعديل.
استخدام editAsText
لمعالجة محتوى العناصر كنص منسق. يتجاهل وضع editAsText
العناصر غير النصية (مثل InlineImage
وHorizontalRule
).
تتم إزالة العناصر الثانوية الموجودة بالكامل داخل نطاق نص محذوف من العنصر.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
الإرجاع
Text
- نسخة نصية من العنصر الحالي
findElement(elementType)
يبحث في محتوى العنصر عن تابع من النوع المحدد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
elementType | ElementType | نوع العنصر المطلوب البحث عنه. |
الإرجاع
RangeElement
: نتيجة بحث تشير إلى موضع عنصر البحث
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
يبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من
تم تحديد RangeElement
.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
المعلمات
الاسم | النوع | الوصف |
---|---|---|
elementType | ElementType | نوع العنصر المطلوب البحث عنه. |
from | RangeElement | نتيجة البحث المطلوب البحث منها. |
الإرجاع
RangeElement
- نتيجة بحث تشير إلى الموضع التالي لعنصر البحث.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
للبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
هناك مجموعة فرعية من ميزات التعبير العادي في JavaScript غير متوافقة بالكامل، مثل التقاط المجموعات ومعدِّلات الأوضاع.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
searchPattern | String | النمط للبحث عن |
الإرجاع
RangeElement
— نتيجة بحث تشير إلى موضع نص البحث أو "فارغ" إذا لم يكن هناك
مطابقة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
يبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
هناك مجموعة فرعية من ميزات التعبير العادي في JavaScript غير متوافقة بالكامل، مثل التقاط المجموعات ومعدِّلات الأوضاع.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
searchPattern | String | النمط للبحث عن |
from | RangeElement | نتيجة البحث للبحث منها |
الإرجاع
RangeElement
- نتيجة بحث تشير إلى الموضع التالي من نص البحث، أو "فارغة" إذا لم يكن هناك
مطابقة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
يسترد سمات العنصر.
والنتيجة هي كائن يحتوي على خاصية لكل سمة عنصر صالح حيث تكون
يتجاوب اسم السمة مع عنصر في التعداد DocumentApp.Attribute
.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
الإرجاع
Object
— سمات العنصر
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
استرداد العنصر الفرعي في الفهرس الفرعي المحدد.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | فهرس العنصر الفرعي المطلوب استرداده. |
الإرجاع
Element
— العنصر الثانوي في الفهرس المحدد.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Element | العنصر الفرعي المطلوب استرداد الفهرس له. |
الإرجاع
Integer
— الفهرس الفرعي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeadingAttributes(paragraphHeading)
لاسترداد مجموعة السمات لـ ParagraphHeading
المقدَّم.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
paragraphHeading | ParagraphHeading | العنوان الذي يجب استرداد سماته |
الإرجاع
Object
— خريطة للسمات وقيمها الحالية.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
لاسترداد كل InlineImages
المضمَّنة في القسم
الإرجاع
InlineImage[]
— صور القسم
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
لاسترداد كل ListItems
المضمَّنة في القسم
الإرجاع
ListItem[]
— يعرض هذا القسم العناصر في قائمة.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginBottom()
لاسترداد الهامش السفلي بالنقاط.
الإرجاع
Number
— الهامش السفلي، بالنقاط
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginLeft()
لاسترداد الهامش الأيسر، بالنقاط.
الإرجاع
Number
— الهامش الأيسر، بالنقاط
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginRight()
استرداد الهامش الأيمن.
الإرجاع
Number
— الهامش الأيمن بالنقاط
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getMarginTop()
لاسترداد الهامش العلوي.
الإرجاع
Number
— الهامش العلوي بالنقاط
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
لاسترداد عدد الأطفال.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log("There are " + body.getNumChildren() + " elements in the tab's body.");
الإرجاع
Integer
— عدد الأطفال.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageHeight()
لاسترداد ارتفاع الصفحة بالنقاط.
الإرجاع
Number
— ارتفاع الصفحة بالنقاط
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPageWidth()
لاسترداد عرض الصفحة بالنقاط.
الإرجاع
Number
— عرض الصفحة بالنقاط
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
استرداد كل Paragraphs
المضمَّنة في القسم (بما في ذلك ListItems
).
الإرجاع
Paragraph[]
— فقرات القسم.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
استرداد العنصر الأصلي للعنصر.
يحتوي العنصر الأصلي على العنصر الحالي.
الإرجاع
ContainerElement
: العنصر الرئيسي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTables()
getText()
لاسترداد محتوى العنصر كسلسلة نصية.
الإرجاع
String
: محتوى العنصر كسلسلة نصية
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
الحصول على محاذاة النص أنواع المحاذاة المتاحة هي DocumentApp.TextAlignment.NORMAL
وDocumentApp.TextAlignment.SUBSCRIPT
وDocumentApp.TextAlignment.SUPERSCRIPT
.
الإرجاع
TextAlignment
- نوع محاذاة النص أو null
إذا كان النص يحتوي على أنواع متعددة من النص
المحاذاة أو إذا لم يتم تعيين محاذاة النص
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
لاسترداد ElementType
للعنصر.
استخدِم getType()
لتحديد نوع عنصر معيَّن بالضبط.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
الإرجاع
ElementType
— نوع العنصر
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
تنشئ السمة HorizontalRule
جديدة وإدراجها في الفهرس المحدّد.
سيتم تضمين HorizontalRule
في Paragraph
جديد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي يتم إدراج العنصر فيه. |
الإرجاع
HorizontalRule
— القاعدة الأفقية الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
تنشئ وإدراج InlineImage
من الكائن الثنائي الكبير (blob) الخاص بالصورة المحدد،
الفهرس.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي يتم إدراج العنصر فيه. |
image | BlobSource | بيانات الصورة |
الإرجاع
InlineImage
— الصورة المضمّنة التي تم إدراجها.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
إدراج InlineImage
المحدّد في الفهرس المحدّد
سيتم تضمين الصورة في Paragraph
جديد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي يتم إدراج العنصر فيه. |
image | InlineImage | الصورة المطلوب إدراجها. |
الإرجاع
InlineImage
— الصورة المضمّنة التي تم إدراجها.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
إدراج ListItem
المحدّد في الفهرس المحدّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
listItem | ListItem | عنصر القائمة المطلوب إدراجه. |
الإرجاع
ListItem
— عنصر القائمة المُدرَج
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
تنشئ وإدراج ListItem
جديدة في الفهرس المحدد، وتحتوي على المحددة
المحتوى النصي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
text | String | المحتوى النصي لعنصر القائمة. |
الإرجاع
ListItem
— عنصر القائمة الجديد.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
تنشئ السمة PageBreak
جديدة وإدراجها في الفهرس المحدّد.
سيتم تضمين PageBreak
في Paragraph
جديد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي يتم إدراج العنصر فيه. |
الإرجاع
PageBreak
— فاصل الصفحات الجديد.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
إدراج PageBreak
المحدّد في الفهرس المحدّد
سيتم تضمين PageBreak
في Paragraph
جديد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي يتم إدراج العنصر فيه. |
pageBreak | PageBreak | فاصل الصفحة المطلوب إدراجه. |
الإرجاع
PageBreak
— فاصل الصفحة الذي تم إدراجه
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
إدراج Paragraph
المحدّد في الفهرس المحدّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
paragraph | Paragraph | الفقرة المطلوب إدراجها. |
الإرجاع
Paragraph
— الفقرة المُدرجة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
تنشئ وإدراج Paragraph
جديدة في الفهرس المحدد، وتحتوي على المحددة
المحتوى النصي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
text | String | المحتوى النصي للفقرة |
الإرجاع
Paragraph
— الفقرة الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
تنشئ السمة Table
جديدة وإدراجها في الفهرس المحدّد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
الإرجاع
Table
: الجدول الجديد
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
تنشئ وإدراج Table
جديدة تحتوي على الخلايا المحددة، في الفهرس المحدد.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
cells | String[][] | المحتوى النصي لخلايا الجدول المطلوب إضافتها إلى الجدول الجديد. |
الإرجاع
Table
: الجدول الجديد
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
إدراج Table
المحدّد في الفهرس المحدّد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
childIndex | Integer | الفهرس الذي سيتم الإدراج فيه. |
table | Table | الجدول المطلوب إدراجه. |
الإرجاع
Table
— الجدول المدرج.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
إزالة العنصر الفرعي المحدد
المعلمات
الاسم | النوع | الوصف |
---|---|---|
child | Element | العنصر الثانوي المطلوب إزالته. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
لاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
ويتم تمرير نمط البحث كسلسلة، وليس ككائن تعبير عادي في JavaScript. لهذا السبب، ستحتاج إلى تجنب أي شرطات مائلة للخلف في النمط.
تستخدم هذه الطرق طريقة RE2 العادية من Google. مكتبة التعبيرات، التي تحدّ من البنية المتوافقة.
تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
المعلمات
الاسم | النوع | الوصف |
---|---|---|
searchPattern | String | نمط التعبير العادي للبحث عن |
replacement | String | النص المطلوب استخدامه كبديل |
الإرجاع
Element
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
يعيّن سمات العنصر.
يجب أن تكون معلَمة السمات المحدّدة كائنًا يكون فيه كل اسم سمة عنصرًا في
عدد DocumentApp.Attribute
وكل قيمة خاصية هي القيمة الجديدة التي يجب
المنهجية.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
المعلمات
الاسم | النوع | الوصف |
---|---|---|
attributes | Object | سمات العنصر. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeadingAttributes(paragraphHeading, attributes)
تضبط السمات للسمة ParagraphHeading
المقدَّمة.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
paragraphHeading | ParagraphHeading | العنوان الذي يجب ضبط سماته. |
attributes | Object | يشير ذلك المصطلح إلى خريطة للسمات والقيم المطلوب ضبطها عليها. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginBottom(marginBottom)
لضبط الهامش السفلي بالنقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
marginBottom | Number | الهامش السفلي، بالنقاط. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginLeft(marginLeft)
لتعيين الهامش الأيسر، بالنقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
marginLeft | Number | الهامش الأيسر، بالنقاط. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginRight(marginRight)
لتعيين الهامش الأيمن بالنقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
marginRight | Number | الهامش الأيمن. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setMarginTop(marginTop)
لضبط الهامش العلوي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
marginTop | Number | الهامش العلوي بالنقاط. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPageHeight(pageHeight)
لضبط ارتفاع الصفحة بالنقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
pageHeight | Number | ارتفاع الصفحة بالنقاط. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPageWidth(pageWidth)
لضبط عرض الصفحة بالنقاط.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
pageWidth | Number | عرض الصفحة بالنقاط. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
لضبط المحتوى كنص عادي
ملاحظة: يتم محو المحتوى الحالي.
المعلمات
الاسم | النوع | الوصف |
---|---|---|
text | String | المحتوى النصي الجديد. |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
لضبط محاذاة النص. أنواع المحاذاة المتاحة هي DocumentApp.TextAlignment.NORMAL
وDocumentApp.TextAlignment.SUBSCRIPT
وDocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
المعلمات
الاسم | النوع | الوصف |
---|---|---|
textAlignment | TextAlignment | نوع محاذاة النص لتطبيقه |
الإرجاع
Body
— العنصر الحالي
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة إذنًا باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents