Document Service

مستند

تسمح هذه الخدمة للنصوص البرمجية بإنشاء ملفات "مستندات Google" والوصول إليها وتعديلها.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

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

صفوف

الاسموصف قصير
Attributeتعداد سمات العناصر.
Bodyمحتوى علامة تبويب في مستند "مستندات Google"
Bookmarkكائن يمثّل إشارة مرجعية
ContainerElementتمثّل هذه السمة عنصرًا عامًا قد يحتوي على عناصر أخرى.
Dateعنصر يمثل تاريخًا منسقًا
Documentمستند يحتوي على كائن Tab واحد أو أكثر، يحتوي كلٌ منه على نص منسق والعناصر مثل الجداول والقوائم.
DocumentAppتنشئ خدمة المستندات Documents الذي يمكن تعديله وتفتحه.
DocumentTabعلامة تبويب في "مستند" تحتوي على نص منسَّق وعناصر مثل الجداول والقوائم.
Elementعنصر عام.
ElementTypeتعداد لجميع أنواع العناصر.
Equationيشير ذلك المصطلح إلى عنصر يمثّل تعبيرًا رياضيًا.
EquationFunctionيشير ذلك المصطلح إلى عنصر يمثّل دالة في دالة Equation الحسابية.
EquationFunctionArgumentSeparatorيشير ذلك المصطلح إلى عنصر يمثّل فاصل دالة في دالة Equation رياضية.
EquationSymbolيشير ذلك المصطلح إلى عنصر يمثّل رمزًا في دالة Equation الحسابية.
FontFamilyتعداد الخطوط المتوافقة.
FooterSectionيشير ذلك المصطلح إلى عنصر يمثّل قسمًا من أقسام التذييل.
Footnoteيشير ذلك المصطلح إلى عنصر يمثّل حاشية سفلية.
FootnoteSectionيشير ذلك المصطلح إلى عنصر يمثّل قسمًا للحاشية السفلية.
GlyphTypeتعداد لأنواع الأحرف الرسومية المتوافقة.
HeaderSectionيشير ذلك المصطلح إلى عنصر يمثّل قسمًا للعنوان.
HorizontalAlignmentتعداد أنواع المحاذاة الأفقية المتوافقة.
HorizontalRuleيشير ذلك المصطلح إلى عنصر يمثّل قاعدة أفقية.
InlineDrawingيشير ذلك المصطلح إلى عنصر يمثّل رسمًا مضمّنًا.
InlineImageيشير ذلك المصطلح إلى عنصر يمثّل صورة مضمّنة.
ListItemيشير ذلك المصطلح إلى عنصر يمثّل عنصر قائمة.
NamedRangeنوع Range يحمل اسمًا ورقم تعريف للسماح باسترداده لاحقًا
PageBreakيشير ذلك المصطلح إلى عنصر يمثّل فاصل صفحة.
Paragraphيشير ذلك المصطلح إلى عنصر يمثّل فقرة.
ParagraphHeadingتعداد لعناوين الفقرات القياسية.
Personعنصر يمثّل رابطًا إلى شخص
Positionمرجع إلى موقع في علامة تبويب المستند، نسبةً إلى عنصر معين.
PositionedImageتم تثبيت الصورة في موضع ثابت على Paragraph.
PositionedLayoutتعداد يحدد كيفية وضع PositionedImage بالنسبة إلى البيئة المحيطة النص.
Rangeيشير ذلك المصطلح إلى مجموعة من العناصر في مستند.
RangeBuilderيشير ذلك المصطلح إلى أداة إنشاء تُستخدَم لإنشاء كائنات Range من عناصر المستند.
RangeElementبرنامج تضمين حول Element مع إزاحة محتملة للبداية والنهاية
RichLinkيشير ذلك المصطلح إلى عنصر يمثّل رابطًا إلى أحد مصادر Google، مثل ملف Drive أو فيديو على YouTube.
Tabعلامة تبويب داخل مستند "مستندات Google"
TabTypeتعداد لجميع أنواع علامات التبويب.
Tableيشير ذلك المصطلح إلى عنصر يمثّل جدولاً.
TableCellيشير ذلك المصطلح إلى عنصر يمثّل خلية جدول.
TableOfContentsعنصر يحتوي على جدول محتويات.
TableRowيشير ذلك المصطلح إلى عنصر يمثّل صفًا في الجدول.
Textيشير ذلك المصطلح إلى عنصر يمثّل منطقة نص منسّق.
TextAlignmentتعداد نوع محاذاة النص.
UnsupportedElementيشير هذا المصطلح إلى عنصر يمثّل منطقة غير معروفة أو لا يمكن أن يتأثر بنص برمجي، مثل رقم الصفحة.
VerticalAlignmentتعداد لأنواع المحاذاة العمودية المتوافقة.

Attribute

أماكن إقامة

الموقعالنوعالوصف
BACKGROUND_COLOREnumلون خلفية أحد العناصر (فقرة أو جدول أو غير ذلك) أو مستند.
BOLDEnumإعداد عرض الخط للنص المنسّق.
BORDER_COLOREnumلون الحد لعناصر الجدول.
BORDER_WIDTHEnumعرض الحدود بالنقاط لعناصر الجدول.
CODEEnumتمثّل هذه السمة محتويات الرمز لعناصر المعادلة.
FONT_FAMILYEnumإعداد مجموعة الخطوط للنص المنسَّق.
FONT_SIZEEnumإعداد حجم الخط بالنقاط للنص المنسّق.
FOREGROUND_COLOREnumإعداد لون المقدّمة للنص المنسَّق.
HEADINGEnumنوع العنوان لعناصر الفقرة (مثلاً DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumإعداد الارتفاع لعناصر الصورة.
HORIZONTAL_ALIGNMENTEnumالمحاذاة الأفقية لعناصر الفقرة (مثلاً DocumentApp.HorizontalAlignment.CENTER)
INDENT_ENDEnumإعداد المسافة البادئة للنهاية بالنقاط لعناصر الفقرة.
INDENT_FIRST_LINEEnumإعداد المسافة البادئة للسطر الأول بالنقاط، لعناصر الفقرة.
INDENT_STARTEnumإعداد المسافة البادئة بالنقاط، لعناصر الفقرة.
ITALICEnumإعداد نمط الخط للنص المنسَّق.
GLYPH_TYPEEnumالنوع الرسومي لعناصر عنصر القائمة.
LEFT_TO_RIGHTEnumإعداد اتجاه النص للنص المنسّق.
LINE_SPACINGEnumإعداد تباعد الأسطر كمُضاعف لعناصر الفقرة.
LINK_URLEnumعنوان URL للرابط الخاص بالنص المنسّق.
LIST_IDEnumرقم تعريف القائمة التي تضم عناصر قائمة.
MARGIN_BOTTOMEnumإعداد الهامش السفلي بالنقاط، لعناصر الفقرة.
MARGIN_LEFTEnumإعداد الهامش الأيسر بالنقاط، لعناصر الفقرة.
MARGIN_RIGHTEnumإعداد الهامش الأيمن بالنقاط، لعناصر الفقرة.
MARGIN_TOPEnumإعداد الهامش العلوي بالنقاط، لعناصر الفقرة.
NESTING_LEVELEnumمستوى تداخل العناصر لعناصر القائمة.
MINIMUM_HEIGHTEnumتمثّل هذه السمة إعداد الحد الأدنى للارتفاع بالنقاط، وذلك لعناصر الصفوف في الجدول.
PADDING_BOTTOMEnumإعداد المساحة المتروكة السفلية بالنقاط لعناصر خلايا الجدول.
PADDING_LEFTEnumإعداد المساحة المتروكة اليسرى بالنقاط لعناصر خلايا الجدول.
PADDING_RIGHTEnumإعداد المساحة المتروكة اليمنى بالنقاط لعناصر خلايا الجدول.
PADDING_TOPEnumإعداد المساحة المتروكة العلوي بالنقاط لعناصر خلايا الجدول.
PAGE_HEIGHTEnumإعداد ارتفاع الصفحة بالنقاط، بالنسبة إلى المستندات
PAGE_WIDTHEnumإعداد عرض الصفحة بالنقاط، بالنسبة إلى المستندات
SPACING_AFTEREnumإعداد التباعد السفلي بالنقاط، لعناصر الفقرة.
SPACING_BEFOREEnumيشير ذلك المصطلح إلى إعداد التباعد العلوي بالنقاط لعناصر الفقرة.
STRIKETHROUGHEnumإعداد يتوسطه خط للنص المنسَّق.
UNDERLINEEnumإعداد التسطير للنص المنسَّق.
VERTICAL_ALIGNMENTEnumإعداد المحاذاة العمودية لعناصر خلايا الجدول.
WIDTHEnumإعداد العرض، لخلية الجدول وعناصر الصورة.

Body

الطُرق

الطريقةنوع الإرجاعوصف قصير
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لضبط محاذاة النص.

Bookmark

الطُرق

الطريقةنوع الإرجاعوصف قصير
getId()Stringالحصول على رقم تعريف Bookmark
getPosition()Positionيحصل على Position من Bookmark ضمن DocumentTab.
remove()voidيؤدي النقر على هذا الزر إلى حذف Bookmark.

ContainerElement

الطُرق

الطريقةنوع الإرجاعوصف قصير
asBody()Bodyلعرض العنصر الحالي كعنصر Body.
asEquation()Equationلعرض العنصر الحالي كعنصر Equation.
asFooterSection()FooterSectionلعرض العنصر الحالي كعنصر FooterSection.
asFootnoteSection()FootnoteSectionلعرض العنصر الحالي كعنصر FootnoteSection.
asHeaderSection()HeaderSectionلعرض العنصر الحالي كعنصر HeaderSection.
asListItem()ListItemلعرض العنصر الحالي كعنصر ListItem.
asParagraph()Paragraphلعرض العنصر الحالي كعنصر Paragraph.
asTable()Tableلعرض العنصر الحالي كعنصر Table.
asTableCell()TableCellلعرض العنصر الحالي كعنصر TableCell.
asTableOfContents()TableOfContentsلعرض العنصر الحالي كعنصر TableOfContents.
asTableRow()TableRowلعرض العنصر الحالي كعنصر TableRow.
clear()ContainerElementيؤدي إلى محو محتوى العنصر.
copy()ContainerElementلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()ContainerElementتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()ContainerElementإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)ContainerElementيعيّن سمات العنصر.
setLinkUrl(url)ContainerElementلضبط عنوان URL للرابط.
setTextAlignment(textAlignment)ContainerElementلضبط محاذاة النص.

Date

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()Dateلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getDisplayText()Stringلعرض قيمة العرض المعروضة في المستند.
getLocale()Stringلعرض لغة التاريخ المستخدمة لقيمة العرض.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getTimestamp()Dateتعرض الطابع الزمني المرتبط بالتاريخ.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()Dateتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()Dateإزالة العنصر من عنصره الأساسي
setAttributes(attributes)Dateيعيّن سمات العنصر.

Document

تعمل الطرق في فئة المستند التي يمكنها الوصول إلى محتوى النص وتعديله مباشرةً إما على علامة التبويب النشطة (في النصوص البرمجية مرتبطة بمستند معيّن) أو على علامة التبويب الأولى (إذا لم تكن علامة التبويب نشطة متاحة). يمكن تعديل النصوص البرمجية التي تعتمد على هذه الطرق (مثل Document.getBody()) لإتاحة استخدام علامات التبويب في إحدى الميزات التالية:

  • استخدام علامة التبويب الأولى: Document.getTabs()[0].asDocumentTab().getBody()
  • استخدام جميع علامات التبويب: يمكنك اجتياز شجرة علامات التبويب باستخدام Document.getTabs() وTab.getChildTabs(). لكل علامة تبويب في الشجرة، عليك الاتصال بـ Tab.asDocumentTab().getBody()
  • استخدام علامة التبويب المحدّدة: Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
    • ملاحظة: يؤدي ذلك إلى حدوث خطأ إذا لم يتم ضبط علامة التبويب النشطة من خلال النص البرمجي باستخدام Document.setActiveTab(tabId)
  • استخدام علامة تبويب محدّدة: Document.getTab(TAB_ID).asDocumentTab().getBody()

لمزيد من المعلومات حول ميزة علامات التبويب، يُرجى الاطّلاع على التعامل مع علامات التبويب.

الطُرق

الطريقةنوع الإرجاعوصف قصير
addBookmark(position)Bookmarkإضافة Bookmark في علامة التبويب Position المحددة إلى علامة التبويب الأولى، أو بالنسبة إلى النصوص البرمجية التي تكون مرتبط بمستند، علامة التبويب النشطة.
addEditor(emailAddress)Documentيؤدي هذا الإجراء إلى إضافة المستخدم المحدّد إلى قائمة محرّري Document.
addEditor(user)Documentيؤدي هذا الإجراء إلى إضافة المستخدم المحدّد إلى قائمة محرّري Document.
addEditors(emailAddresses)Documentلإضافة مصفوفة معيّنة من المستخدمين إلى قائمة المحرِّرين في Document
addFooter()FooterSectionلإضافة قسم تذييل، في حال عدم وجوده، إلى علامة التبويب الأولى أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
addHeader()HeaderSectionيضيف قسم رأس، في حال عدم وجوده، إلى علامة التبويب الأولى أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
addNamedRange(name, range)NamedRangeإضافة NamedRange، وهو Range الذي يحمل اسمًا ورقم تعريف يمكن استخدامهما استردادها لاحقًا، في علامة التبويب الأولى أو في علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
addViewer(emailAddress)Documentلإضافة المستخدم المحدّد إلى قائمة مشاهدي Document
addViewer(user)Documentلإضافة المستخدم المحدّد إلى قائمة مشاهدي Document
addViewers(emailAddresses)Documentتتم إضافة مصفوفة المستخدمين المحدّدة إلى قائمة مشاهدي Document.
getActiveTab()Tabالحصول على رمز Tab النشط حاليًا للمستخدم في المستند
getAs(contentType)Blobلاسترداد محتوى Document الحالي ككائن ثنائي كبير من النوع المحدّد.
getBlob()Blobلاسترداد محتوى Document الحالي في شكل كائن ثنائي كبير.
getBody()Bodyلاسترداد Body لعلامة التبويب الأولى، أو DocumentBodySection الخاص بعلامة التبويب النشطة، بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
getBookmark(id)Bookmarkيحصل على Bookmark مع المعرّف المحدّد في علامة التبويب الأولى، أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
getBookmarks()Bookmark[]للحصول على جميع كائنات Bookmark في علامة التبويب الأولى، أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
getCursor()Positionالحصول على مؤشر المستخدم في علامة التبويب النشطة
getEditors()User[]يحصل على قائمة محرّري Document هذا.
getFooter()FooterSectionاسترداد قسم تذييل علامة التبويب الأولى أو تذييل علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند .
getFootnotes()Footnote[]لاسترداد جميع عناصر Footnote في النص الأساسي لعلامة التبويب الأولى، أو النص الأساسي لعلامة التبويب النشطة المرتبطة بمستند.
getHeader()HeaderSectionيسترد قسم رأس علامة التبويب الأولى، أو عنوان علامة التبويب النشطة، بالنسبة إلى النصوص البرمجية المرتبطة بمستند، .
getId()Stringلاسترداد المعرف الفريد للمستند.
getLanguage()Stringالحصول على رمز لغة المستند
getName()Stringاسترداد عنوان المستند.
getNamedRangeById(id)NamedRangeيحصل على NamedRange مع المعرّف المحدّد في علامة التبويب الأولى، أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
getNamedRanges()NamedRange[]للحصول على جميع كائنات NamedRange في علامة التبويب الأولى، أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
getNamedRanges(name)NamedRange[]الحصول على جميع عناصر NamedRange بالاسم المحدّد في علامة التبويب الأولى، أو بالنسبة إلى النصوص البرمجية التي مرتبطة بمستند، بعلامة التبويب النشطة.
getSelection()Rangeالحصول على اختيار المستخدم في علامة التبويب "النشطة"
getSupportedLanguageCodes()String[]الحصول على جميع رموز اللغات المتوافقة في ملفات "مستندات Google"
getTab(tabId)Tabالحصول على Tab مع المعرّف المحدّد
getTabs()Tab[]الحصول على جميع Tab غير المتداخلة التي تشكّل جزءًا من المستند.
getUrl()Stringلاسترداد عنوان URL للوصول إلى المستند الحالي.
getViewers()User[]الحصول على قائمة المشاهدين والمعلِّقين لهذا Document
newPosition(element, offset)Positionتنشئ Position جديدة، وهي إشارة إلى موقع جغرافي في علامة التبويب، بالنسبة إلى عنصر محدد في علامة التبويب الأولى أو علامة التبويب النشطة بالنسبة إلى النصوص البرمجية المرتبطة بمستند.
newRange()RangeBuilderتنشئ أداة إنشاء تُستخدم لإنشاء كائنات Range من عناصر علامة التبويب في علامة التبويب الأولى أو بالنسبة إلى النصوص البرمجية المرتبطة بـ المستند، علامة التبويب النشطة.
removeEditor(emailAddress)Documentإزالة المستخدم المحدّد من قائمة محرِّري Document
removeEditor(user)Documentإزالة المستخدم المحدّد من قائمة محرِّري Document
removeViewer(emailAddress)Documentلإزالة المستخدم المحدّد من قائمة المشاهدين والمعلِّقين على Document.
removeViewer(user)Documentلإزالة المستخدم المحدّد من قائمة المشاهدين والمعلِّقين على Document.
saveAndClose()voidيتم حفظ قيمة Document الحالية.
setActiveTab(tabId)voidتضبط هذه السياسة خيار Tab الذي اختاره المستخدم في المستند الحالي على علامة التبويب التي تتضمّن المعرّف المحدّد.
setCursor(position)Documentتضبط هذه السياسة مؤشر المستخدم مع تحديد Position.
setLanguage(languageCode)Documentلضبط رمز لغة المستند.
setName(name)Documentلضبط عنوان المستند.
setSelection(range)Documentتضبط هذه السياسة اختيار المستخدم في علامة التبويب النشطة، مع تحديد Range.

DocumentApp

أماكن إقامة

الموقعالنوعالوصف
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 المحدَّد وعرضه.

DocumentTab

الطُرق

الطريقةنوع الإرجاعوصف قصير
addBookmark(position)Bookmarkلإضافة Bookmark عند السمة Position المحددة.
addFooter()FooterSectionتضيف قسمًا لتذييل علامة التبويب، في حال عدم توفّرها.
addHeader()HeaderSectionتضيف قسمًا لعنوان علامة التبويب، في حال عدم توفّرها.
addNamedRange(name, range)NamedRangeإضافة NamedRange، وهو Range الذي يحمل اسمًا ورقم تعريف يمكن استخدامهما والاسترداد اللاحق.
getBody()Bodyيسترد Body لعلامة التبويب.
getBookmark(id)Bookmarkالحصول على Bookmark مع المعرّف المحدّد.
getBookmarks()Bookmark[]الحصول على كل العناصر البالغ عددها Bookmark في علامة التبويب
getFooter()FooterSectionلاسترداد قسم تذييل علامة التبويب، في حال توفّره.
getFootnotes()Footnote[]لاسترداد جميع عناصر Footnote في النص الأساسي لعلامة التبويب
getHeader()HeaderSectionلاسترداد قسم عنوان علامة التبويب، إن وجد.
getNamedRangeById(id)NamedRangeالحصول على NamedRange مع المعرّف المحدّد.
getNamedRanges()NamedRange[]الحصول على كل العناصر البالغ عددها NamedRange في علامة التبويب
getNamedRanges(name)NamedRange[]جلب جميع العناصر NamedRange في علامة التبويب التي تحمل الاسم المحدّد
newPosition(element, offset)Positionتنشئ Position جديدة، وهي إشارة إلى موقع جغرافي في علامة التبويب، بالنسبة إلى العنصر المحدد.
newRange()RangeBuilderتنشئ أداة إنشاء تُستخدم لإنشاء كائنات Range من عناصر علامة التبويب.

Element

الطُرق

الطريقةنوع الإرجاعوصف قصير
asBody()Bodyلعرض العنصر الحالي كعنصر Body.
asDate()Dateلعرض العنصر الحالي كعنصر Date.
asEquation()Equationلعرض العنصر الحالي كعنصر Equation.
asEquationFunction()EquationFunctionلعرض العنصر الحالي كعنصر EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorلعرض العنصر الحالي كعنصر EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolلعرض العنصر الحالي كعنصر EquationSymbol.
asFooterSection()FooterSectionلعرض العنصر الحالي كعنصر FooterSection.
asFootnote()Footnoteلعرض العنصر الحالي كعنصر Footnote.
asFootnoteSection()FootnoteSectionلعرض العنصر الحالي كعنصر FootnoteSection.
asHeaderSection()HeaderSectionلعرض العنصر الحالي كعنصر HeaderSection.
asHorizontalRule()HorizontalRuleلعرض العنصر الحالي كعنصر HorizontalRule.
asInlineDrawing()InlineDrawingلعرض العنصر الحالي كعنصر InlineDrawing.
asInlineImage()InlineImageلعرض العنصر الحالي كعنصر InlineImage.
asListItem()ListItemلعرض العنصر الحالي كعنصر ListItem.
asPageBreak()PageBreakلعرض العنصر الحالي كعنصر PageBreak.
asParagraph()Paragraphلعرض العنصر الحالي كعنصر Paragraph.
asPerson()Personلعرض العنصر الحالي كعنصر Person.
asRichLink()RichLinkعرض العنصر الحالي على أنّه RichLink، على سبيل المثال، رابط إلى ملف في "جداول بيانات Google".
asTable()Tableلعرض العنصر الحالي كعنصر Table.
asTableCell()TableCellلعرض العنصر الحالي كعنصر TableCell.
asTableOfContents()TableOfContentsلعرض العنصر الحالي كعنصر TableOfContents.
asTableRow()TableRowلعرض العنصر الحالي كعنصر TableRow.
asText()Textلعرض العنصر الحالي كعنصر Text.
copy()Elementلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()Elementتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()Elementإزالة العنصر من عنصره الأساسي
setAttributes(attributes)Elementيعيّن سمات العنصر.

ElementType

أماكن إقامة

الموقعالنوعالوصف
BODY_SECTIONEnumالنوع المتوافق مع العنصر Body.
COMMENT_SECTIONEnumالنوع المتوافق مع العنصر CommentSection.
DATEEnumالنوع المتوافق مع Date العنصر.
EQUATIONEnumالنوع المتوافق مع العنصر Equation.
EQUATION_FUNCTIONEnumالنوع المتوافق مع العنصر EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumالنوع المتوافق مع EquationFunctionArgumentSeparator العنصر.
EQUATION_SYMBOLEnumالنوع المتوافق مع العنصر EquationSymbol.
RICH_LINKEnumالنوع المتوافق مع العنصر RichLink.
FOOTER_SECTIONEnumالنوع المتوافق مع العنصر FooterSection.
FOOTNOTEEnumالنوع المتوافق مع العنصر Footnote.
FOOTNOTE_SECTIONEnumالنوع المتوافق مع العنصر FootnoteSection.
HEADER_SECTIONEnumالنوع المتوافق مع العنصر HeaderSection.
HORIZONTAL_RULEEnumالنوع المتوافق مع العنصر HorizontalRule.
INLINE_DRAWINGEnumالنوع المتوافق مع العنصر InlineDrawing.
INLINE_IMAGEEnumالنوع المتوافق مع العنصر InlineImage.
LIST_ITEMEnumالنوع المتوافق مع العنصر ListItem.
PAGE_BREAKEnumالنوع المتوافق مع العنصر PageBreak.
PARAGRAPHEnumالنوع المتوافق مع العنصر Paragraph.
PERSONEnumالنوع المتوافق مع العنصر Person.
TABLEEnumالنوع المتوافق مع العنصر Table.
TABLE_CELLEnumالنوع المتوافق مع العنصر TableCell.
TABLE_OF_CONTENTSEnumالنوع المتوافق مع العنصر TableOfContents.
TABLE_ROWEnumالنوع المتوافق مع العنصر TableRow.
TEXTEnumالنوع المتوافق مع Text العنصر.
UNSUPPORTEDEnumالنوع المتوافق مع UnsupportedElement.

Equation

الطُرق

الطريقةنوع الإرجاعوصف قصير
clear()Equationيؤدي إلى محو محتوى العنصر.
copy()Equationلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()Equationتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()Equationإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)Equationيعيّن سمات العنصر.
setLinkUrl(url)Equationلضبط عنوان URL للرابط.
setTextAlignment(textAlignment)Equationلضبط محاذاة النص.

EquationFunction

الطُرق

الطريقةنوع الإرجاعوصف قصير
clear()EquationFunctionيؤدي إلى محو محتوى العنصر.
copy()EquationFunctionلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getCode()Stringلاسترداد الرمز المقابل لدالة المعادلة.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()EquationFunctionتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()EquationFunctionإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)EquationFunctionيعيّن سمات العنصر.
setLinkUrl(url)EquationFunctionلضبط عنوان URL للرابط.
setTextAlignment(textAlignment)EquationFunctionلضبط محاذاة النص.

EquationFunctionArgumentSeparator

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()EquationFunctionArgumentSeparatorلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()EquationFunctionArgumentSeparatorتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()EquationFunctionArgumentSeparatorإزالة العنصر من عنصره الأساسي
setAttributes(attributes)EquationFunctionArgumentSeparatorيعيّن سمات العنصر.

EquationSymbol

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()EquationSymbolلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getCode()Stringلاسترداد الرمز المقابل لرمز المعادلة.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()EquationSymbolتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()EquationSymbolإزالة العنصر من عنصره الأساسي
setAttributes(attributes)EquationSymbolيعيّن سمات العنصر.

FontFamily

FooterSection

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendHorizontalRule()HorizontalRuleتنشئ سمة HorizontalRule جديدة وتلحقها
appendImage(image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
appendImage(image)InlineImageتُرفِق السمة InlineImage المحدّدة.
appendListItem(listItem)ListItemتُرفِق السمة ListItem المحدّدة.
appendListItem(text)ListItemتنشئ هذه السمة ListItem جديدًا وتلحقها به المحتوى النصي المحدّد.
appendParagraph(paragraph)Paragraphتُرفِق السمة Paragraph المحدّدة.
appendParagraph(text)Paragraphتنشئ هذه السمة Paragraph جديدًا وتلحقها به المحتوى النصي المحدّد.
appendTable()Tableتنشئ سمة Table جديدة وتلحقها
appendTable(cells)Tableلإلحاق Table جديد يحتوي على TableCell لكل قيمة سلسلة محددة.
appendTable(table)Tableتُرفِق السمة Table المحدّدة.
clear()FooterSectionيؤدي إلى محو محتوى العنصر.
copy()FooterSectionلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getImages()InlineImage[]لاسترداد كل InlineImages المضمَّنة في القسم
getListItems()ListItem[]لاسترداد كل ListItems المضمَّنة في القسم
getNumChildren()Integerلاسترداد عدد الأطفال.
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 جديدة في الفهرس المحدد، وتحتوي على المحددة المحتوى النصي.
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)FooterSectionإزالة العنصر الفرعي المحدد
removeFromParent()FooterSectionإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)FooterSectionيعيّن سمات العنصر.
setText(text)FooterSectionلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)FooterSectionلضبط محاذاة النص.

Footnote

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()Footnoteلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getFootnoteContents()FootnoteSectionلاسترداد محتوى عنصر الحاشية السفلية.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
removeFromParent()Footnoteإزالة العنصر من عنصره الأساسي
setAttributes(attributes)Footnoteيعيّن سمات العنصر.

FootnoteSection

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendParagraph(paragraph)Paragraphتُرفِق السمة Paragraph المحدّدة.
appendParagraph(text)Paragraphتنشئ هذه السمة Paragraph جديدًا وتلحقها به المحتوى النصي المحدّد.
clear()FootnoteSectionيؤدي إلى محو محتوى العنصر.
copy()FootnoteSectionلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParagraphs()Paragraph[]استرداد كل Paragraphs المضمَّنة في القسم (بما في ذلك ListItems).
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
insertParagraph(childIndex, paragraph)Paragraphإدراج Paragraph المحدّد في الفهرس المحدّد
insertParagraph(childIndex, text)Paragraphتنشئ وإدراج Paragraph جديدة في الفهرس المحدد، وتحتوي على المحددة المحتوى النصي.
removeChild(child)FootnoteSectionإزالة العنصر الفرعي المحدد
removeFromParent()FootnoteSectionإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)FootnoteSectionيعيّن سمات العنصر.
setText(text)FootnoteSectionلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)FootnoteSectionلضبط محاذاة النص.

GlyphType

أماكن إقامة

الموقعالنوعالوصف
BULLETEnumالرمز النقطي الافتراضي، دائري وممتلئ.
HOLLOW_BULLETEnumتعداد نقطي مجوف.
SQUARE_BULLETEnumرمز نقطي مربع.
NUMBEREnumرمز نقطي مستند إلى رقم
LATIN_UPPEREnumرمز نقطي بحروف لاتينية كبيرة.
LATIN_LOWEREnumرمز نقطي على شكل حرف لاتيني صغير
ROMAN_UPPEREnumرقم روماني، رمز نقطي على شكل حرف كبير.
ROMAN_LOWEREnumرقم روماني، رمز نقطي صغير.

HeaderSection

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendHorizontalRule()HorizontalRuleتنشئ سمة HorizontalRule جديدة وتلحقها
appendImage(image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
appendImage(image)InlineImageتُرفِق السمة InlineImage المحدّدة.
appendListItem(listItem)ListItemتُرفِق السمة ListItem المحدّدة.
appendListItem(text)ListItemتنشئ هذه السمة ListItem جديدًا وتلحقها به المحتوى النصي المحدّد.
appendParagraph(paragraph)Paragraphتُرفِق السمة Paragraph المحدّدة.
appendParagraph(text)Paragraphتنشئ هذه السمة Paragraph جديدًا وتلحقها به المحتوى النصي المحدّد.
appendTable()Tableتنشئ سمة Table جديدة وتلحقها
appendTable(cells)Tableلإلحاق Table جديد يحتوي على TableCell لكل قيمة سلسلة محددة.
appendTable(table)Tableتُرفِق السمة Table المحدّدة.
clear()HeaderSectionيؤدي إلى محو محتوى العنصر.
copy()HeaderSectionلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getImages()InlineImage[]لاسترداد كل InlineImages المضمَّنة في القسم
getListItems()ListItem[]لاسترداد كل ListItems المضمَّنة في القسم
getNumChildren()Integerلاسترداد عدد الأطفال.
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 جديدة في الفهرس المحدد، وتحتوي على المحددة المحتوى النصي.
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)HeaderSectionإزالة العنصر الفرعي المحدد
removeFromParent()HeaderSectionإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)HeaderSectionيعيّن سمات العنصر.
setText(text)HeaderSectionلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)HeaderSectionلضبط محاذاة النص.

HorizontalAlignment

أماكن إقامة

الموقعالنوعالوصف
LEFTEnumخيار المحاذاة لليسار.
CENTEREnumخيار المحاذاة للوسط.
RIGHTEnumخيار المحاذاة لليمين.
JUSTIFYEnumخيار ضبط المحاذاة.

HorizontalRule

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()HorizontalRuleلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
removeFromParent()HorizontalRuleإزالة العنصر من عنصره الأساسي
setAttributes(attributes)HorizontalRuleيعيّن سمات العنصر.

InlineDrawing

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()InlineDrawingلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAltDescription()Stringلعرض الوصف البديل للرسم.
getAltTitle()Stringلعرض العنوان البديل للرسم.
getAttributes()Objectيسترد سمات العنصر.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()InlineDrawingتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()InlineDrawingإزالة العنصر من عنصره الأساسي
setAltDescription(description)InlineDrawingلضبط الوصف البديل للرسم.
setAltTitle(title)InlineDrawingلضبط العنوان البديل للرسم.
setAttributes(attributes)InlineDrawingيعيّن سمات العنصر.

InlineImage

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()InlineImageلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAltDescription()Stringلعرض الوصف البديل للصورة.
getAltTitle()Stringتعرض العنوان البديل للصورة.
getAs(contentType)Blobعرض البيانات داخل هذا الكائن على شكل كائن ثنائي كبير تم تحويله إلى نوع المحتوى المحدّد.
getAttributes()Objectيسترد سمات العنصر.
getBlob()Blobعرض البيانات داخل هذا الكائن على شكل كائن ثنائي كبير.
getHeight()Integerاسترداد ارتفاع الصورة بالبكسل.
getLinkUrl()Stringلاسترداد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
getWidth()Integerاسترداد عرض الصورة بالبكسل.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()InlineImageتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()InlineImageإزالة العنصر من عنصره الأساسي
setAltDescription(description)InlineImageلضبط الوصف البديل للصورة.
setAltTitle(title)InlineImageلضبط العنوان البديل للصورة.
setAttributes(attributes)InlineImageيعيّن سمات العنصر.
setHeight(height)InlineImageلضبط ارتفاع الصورة بالبكسل.
setLinkUrl(url)InlineImageلضبط عنوان URL للرابط.
setWidth(width)InlineImageلضبط عرض الصورة بالبكسل.

ListItem

الطُرق

الطريقةنوع الإرجاعوصف قصير
addPositionedImage(image)PositionedImageلإنشاء PositionedImage جديد وإدراجه من الكائن الثنائي الكبير (blob) للصورة المحدد.
appendHorizontalRule()HorizontalRuleتنشئ سمة HorizontalRule جديدة وتلحقها
appendInlineImage(image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
appendInlineImage(image)InlineImageتُرفِق السمة InlineImage المحدّدة.
appendPageBreak()PageBreakتنشئ سمة PageBreak جديدة وتلحقها
appendPageBreak(pageBreak)PageBreakتُرفِق السمة PageBreak المحدّدة.
appendText(text)Textتنشئ هذه الطريقة عنصر Text جديدًا وتتضمّن المحتوى المحدّد وتُلحقه.
appendText(text)Textلإلحاق عنصر Text المحدّد
clear()ListItemيؤدي إلى محو محتوى العنصر.
copy()ListItemلعرض نسخة منفصلة عميقة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAlignment()HorizontalAlignmentلاسترداد HorizontalAlignment.
getAttributes()Objectيسترد سمات العنصر.
getChild(childIndex)Elementاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getGlyphType()GlyphTypeلاسترداد GlyphType لعنصر القائمة.
getHeading()ParagraphHeadingلاسترداد ParagraphHeading.
getIndentEnd()Numberلاسترداد المسافة البادئة للنهاية بالنقاط.
getIndentFirstLine()Numberلاسترداد المسافة البادئة للسطر الأول بالنقاط.
getIndentStart()Numberاسترداد المسافة البادئة للبدء.
getLineSpacing()Numberلاسترداد تباعد الأسطر بالنقاط.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getListId()Stringلاسترداد رقم تعريف القائمة.
getNestingLevel()Integerيسترد مستوى تداخل عنصر القائمة.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPositionedImage(id)PositionedImageالحصول على PositionedImage من رقم تعريف الصورة.
getPositionedImages()PositionedImage[]لتثبيت جميع كائنات PositionedImage في الفقرة
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getSpacingAfter()Numberاسترداد التباعد بعد العنصر، بالنقاط.
getSpacingBefore()Numberاسترداد التباعد قبل العنصر بالنقاط.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
insertHorizontalRule(childIndex)HorizontalRuleتنشئ السمة HorizontalRule وإدراجها في الفهرس المحدد.
insertInlineImage(childIndex, image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وإدراجه من الكائن الثنائي الكبير (blob) الخاص بالصورة المحدد، الفهرس.
insertInlineImage(childIndex, image)InlineImageإدراج InlineImage المحدّد في الفهرس المحدّد
insertPageBreak(childIndex)PageBreakتنشئ السمة PageBreak جديدة وإدراجها في الفهرس المحدّد.
insertPageBreak(childIndex, pageBreak)PageBreakإدراج PageBreak المحدّد في الفهرس المحدّد
insertText(childIndex, text)Textتنشئ عنصرًا نصيًا جديدًا وإدراجه في الفهرس المحدد.
insertText(childIndex, text)Textإدراج عنصر Text المحدد في الفهرس المحدد، مع النص المحدد المحتوى.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
isLeftToRight()Booleanيسترد الإعداد من اليسار إلى اليمين.
merge()ListItemتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeChild(child)ListItemإزالة العنصر الفرعي المحدد
removeFromParent()ListItemإزالة العنصر من عنصره الأساسي
removePositionedImage(id)Booleanستتم إزالة PositionedImage من خلال رقم تعريف الصورة.
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAlignment(alignment)ListItemلضبط HorizontalAlignment.
setAttributes(attributes)ListItemيعيّن سمات العنصر.
setGlyphType(glyphType)ListItemلضبط GlyphType لعنصر القائمة.
setHeading(heading)ListItemلضبط ParagraphHeading.
setIndentEnd(indentEnd)ListItemلتعيين المسافة البادئة للنهاية بالنقاط.
setIndentFirstLine(indentFirstLine)ListItemلضبط المسافة البادئة للسطر الأول بالنقاط.
setIndentStart(indentStart)ListItemلضبط المسافة البادئة للبداية بالنقاط.
setLeftToRight(leftToRight)ListItemلتعيين الإعداد من اليسار إلى اليمين.
setLineSpacing(multiplier)ListItemلضبط تباعد الأسطر، ككمية تشير إلى عدد الأسطر المستخدمة في التباعد.
setLinkUrl(url)ListItemلضبط عنوان URL للرابط.
setListId(listItem)ListItemلضبط رقم تعريف القائمة.
setNestingLevel(nestingLevel)ListItemيعيّن مستوى تداخل عنصر القائمة.
setSpacingAfter(spacingAfter)ListItemلضبط التباعد بعد العنصر بالنقاط.
setSpacingBefore(spacingBefore)ListItemلتعيين التباعد قبل العنصر، بالنقاط.
setText(text)voidلضبط محتوى عنصر القائمة كنص.
setTextAlignment(textAlignment)ListItemلضبط محاذاة النص.

NamedRange

الطُرق

الطريقةنوع الإرجاعوصف قصير
getId()Stringالحصول على معرّف "NamedRange" هذا
getName()Stringيحصل على اسم NamedRange.
getRange()Rangeتحصل على نطاق العناصر المرتبطة بـ NamedRange.
remove()voidستتم إزالة "NamedRange" من علامة التبويب.

PageBreak

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()PageBreakلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
removeFromParent()PageBreakإزالة العنصر من عنصره الأساسي
setAttributes(attributes)PageBreakيعيّن سمات العنصر.

Paragraph

الطُرق

الطريقةنوع الإرجاعوصف قصير
addPositionedImage(image)PositionedImageلإنشاء PositionedImage جديد وإدراجه من الكائن الثنائي الكبير (blob) للصورة المحدد.
appendHorizontalRule()HorizontalRuleتنشئ سمة HorizontalRule جديدة وتلحقها
appendInlineImage(image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
appendInlineImage(image)InlineImageتُرفِق السمة InlineImage المحدّدة.
appendPageBreak()PageBreakتنشئ سمة PageBreak جديدة وتلحقها
appendPageBreak(pageBreak)PageBreakتُرفِق السمة PageBreak المحدّدة.
appendText(text)Textتنشئ هذه الطريقة عنصر Text جديدًا وتتضمّن المحتوى المحدّد وتُلحقه.
appendText(text)Textلإلحاق عنصر Text المحدّد
clear()Paragraphيؤدي إلى محو محتوى العنصر.
copy()Paragraphلعرض نسخة منفصلة عميقة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAlignment()HorizontalAlignmentلاسترداد HorizontalAlignment.
getAttributes()Objectيسترد سمات العنصر.
getChild(childIndex)Elementاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getHeading()ParagraphHeadingلاسترداد ParagraphHeading.
getIndentEnd()Numberلاسترداد المسافة البادئة للنهاية بالنقاط.
getIndentFirstLine()Numberلاسترداد المسافة البادئة للسطر الأول بالنقاط.
getIndentStart()Numberاسترداد المسافة البادئة للبدء.
getLineSpacing()Numberلاسترداد تباعد الأسطر بالنقاط.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPositionedImage(id)PositionedImageالحصول على PositionedImage من رقم تعريف الصورة.
getPositionedImages()PositionedImage[]لتثبيت جميع كائنات PositionedImage في الفقرة
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getSpacingAfter()Numberاسترداد التباعد بعد العنصر، بالنقاط.
getSpacingBefore()Numberاسترداد التباعد قبل العنصر بالنقاط.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
insertHorizontalRule(childIndex)HorizontalRuleتنشئ السمة HorizontalRule وإدراجها في الفهرس المحدد.
insertInlineImage(childIndex, image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وإدراجه من الكائن الثنائي الكبير (blob) الخاص بالصورة المحدد، الفهرس.
insertInlineImage(childIndex, image)InlineImageإدراج InlineImage المحدّد في الفهرس المحدّد
insertPageBreak(childIndex)PageBreakتنشئ السمة PageBreak جديدة وإدراجها في الفهرس المحدّد.
insertPageBreak(childIndex, pageBreak)PageBreakإدراج PageBreak المحدّد في الفهرس المحدّد
insertText(childIndex, text)Textتنشئ عنصرًا نصيًا جديدًا وإدراجه في الفهرس المحدد.
insertText(childIndex, text)Textإدراج عنصر Text المحدد في الفهرس المحدد، مع النص المحدد المحتوى.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
isLeftToRight()Booleanيسترد الإعداد من اليسار إلى اليمين.
merge()Paragraphتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeChild(child)Paragraphإزالة العنصر الفرعي المحدد
removeFromParent()Paragraphإزالة العنصر من عنصره الأساسي
removePositionedImage(id)Booleanستتم إزالة PositionedImage من خلال رقم تعريف الصورة.
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAlignment(alignment)Paragraphلضبط HorizontalAlignment.
setAttributes(attributes)Paragraphيعيّن سمات العنصر.
setHeading(heading)Paragraphلضبط ParagraphHeading.
setIndentEnd(indentEnd)Paragraphلتعيين المسافة البادئة للنهاية بالنقاط.
setIndentFirstLine(indentFirstLine)Paragraphلضبط المسافة البادئة للسطر الأول بالنقاط.
setIndentStart(indentStart)Paragraphلضبط المسافة البادئة للبداية بالنقاط.
setLeftToRight(leftToRight)Paragraphلتعيين الإعداد من اليسار إلى اليمين.
setLineSpacing(multiplier)Paragraphلضبط تباعد الأسطر، ككمية تشير إلى عدد الأسطر المستخدمة في التباعد.
setLinkUrl(url)Paragraphلضبط عنوان URL للرابط.
setSpacingAfter(spacingAfter)Paragraphلضبط التباعد بعد العنصر بالنقاط.
setSpacingBefore(spacingBefore)Paragraphلتعيين التباعد قبل العنصر، بالنقاط.
setText(text)voidلتعيين محتوى الفقرة كنص.
setTextAlignment(textAlignment)Paragraphلضبط محاذاة النص.

ParagraphHeading

أماكن إقامة

الموقعالنوعالوصف
NORMALEnumخيار العنوان للنص العادي.
HEADING1Enumخيار العنوان الأعلى.
HEADING2Enumخيار العنوان الثاني.
HEADING3Enumخيار العنوان الثالث
HEADING4Enumخيار العنوان الرابع.
HEADING5Enumخيار العنوان الخامس.
HEADING6Enumخيار العنوان الأدنى.
TITLEEnumخيار عنوان العنوان.
SUBTITLEEnumخيار عنوان الترجمة.

Person

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()Personلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getEmail()Stringتعرض عنوان البريد الإلكتروني للمستخدم.
getName()Stringلعرض الاسم المعروض للشخص، إذا تم ضبطه.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()Personتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()Personإزالة العنصر من عنصره الأساسي
setAttributes(attributes)Personيعيّن سمات العنصر.

Position

الطُرق

الطريقةنوع الإرجاعوصف قصير
getElement()Elementللحصول على العنصر الذي يحتوي على Position.
getOffset()Integerالحصول على الموقع النسبي لـ Position داخل العنصر الذي يحتوي عليه.
getSurroundingText()Textتنشئ عنصر Text مصطنعًا يمثّل نص السمة وتنسيقها. Paragraph أو ListItem التي تحتوي على Position، إما مباشرةً أو من خلال سلسلة من العناصر الفرعية.
getSurroundingTextOffset()Integerللحصول على إزاحة هذا Position داخل العنصر Text الذي يعرضه getSurroundingText().
insertBookmark()Bookmarkإنشاء Bookmark جديد وإدراجه في Position
insertInlineImage(image)InlineImageإنشاء وإدراج InlineImage جديد في Position هذه من الصورة المحددة كائن ثنائي كبير (blob)
insertText(text)Textإدراج النص المحدَّد في Position

PositionedImage

الطُرق

الطريقةنوع الإرجاعوصف قصير
getAs(contentType)Blobعرض البيانات داخل هذا الكائن على شكل كائن ثنائي كبير تم تحويله إلى نوع المحتوى المحدّد.
getBlob()Blobعرض البيانات داخل هذا الكائن على شكل كائن ثنائي كبير.
getHeight()Integerاسترداد ارتفاع الصورة بالبكسل.
getId()Stringالحصول على رقم تعريف الصورة
getLayout()PositionedLayoutللحصول على قيمة تعداد تمثّل كيفية عرض الصورة.
getLeftOffset()Numberللحصول على إزاحة الصورة، بالنقاط، من يسار الفقرة.
getParagraph()Paragraphالحصول على Paragraph الذي تم تثبيت الصورة عليه
getTopOffset()Numberللحصول على إزاحة الصورة، بالنقاط، من أعلى الفقرة.
getWidth()Integerاسترداد عرض الصورة بالبكسل.
setHeight(height)PositionedImageلضبط ارتفاع الصورة بالبكسل.
setLayout(layout)PositionedImageلتعيين تعريف كيفية تخطيط الصورة.
setLeftOffset(offset)PositionedImageلتعيين إزاحة الصورة، بالنقاط، من يسار الفقرة.
setTopOffset(offset)PositionedImageلضبط إزاحة الصورة، في النقاط، من أعلى الفقرة.
setWidth(width)PositionedImageلضبط عرض الصورة بالبكسل.

PositionedLayout

أماكن إقامة

الموقعالنوعالوصف
ABOVE_TEXTEnumتم وضع الصورة فوق النص.
BREAK_BOTHEnumتقسم الصورة النص الذي يظهر على اليمين واليسار.
BREAK_LEFTEnumتقسم الصورة النص إلى اليسار.
BREAK_RIGHTEnumتقسّم الصورة النص الظاهر على اليمين.
WRAP_TEXTEnumيجب التفاف الصورة بنص.

Range

الطُرق

الطريقةنوع الإرجاعوصف قصير
getRangeElements()RangeElement[]للحصول على جميع العناصر في Range، بما في ذلك أي عناصر Text جزئية (على سبيل المثال، في الحالة تحديد يتضمن جزءًا فقط من عنصر Text).

RangeBuilder

الطُرق

الطريقةنوع الإرجاعوصف قصير
addElement(element)RangeBuilderلإضافة Element بالكامل إلى RangeBuilder
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderتتم إضافة عنصر Text جزئي إلى عنصر RangeBuilder هذا.
addElementsBetween(startElement, endElementInclusive)RangeBuilderتتم إضافة عنصرين كاملين وجميع العناصر بينهما إلى RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderتتم إضافة عنصري Text جزئيين وجميع العناصر بينهما إلى RangeBuilder.
addRange(range)RangeBuilderلإضافة محتوى Range آخر إلى RangeBuilder
build()Rangeتنشئ Range من الإعدادات المطبّقة على أداة الإنشاء.
getRangeElements()RangeElement[]للحصول على جميع العناصر في Range، بما في ذلك أي عناصر Text جزئية (على سبيل المثال، في الحالة تحديد يتضمن جزءًا فقط من عنصر Text).

RangeElement

الطُرق

الطريقةنوع الإرجاعوصف قصير
getElement()Elementالحصول على Element الذي يتوافق مع RangeElement
getEndOffsetInclusive()Integerللحصول على موضع نهاية نطاق جزئي داخل عنصر النطاق.
getStartOffset()Integerيحصل على موضع بداية نطاق جزئي داخل عنصر النطاق.
isPartial()Booleanتحدد ما إذا كان عنصر النطاق هذا يغطي العنصر بالكامل أم اختيارًا جزئيًا أحرف العنصر.

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()RichLinkلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getMimeType()Stringعرض نوع MIME الرابط، الذي يتوفر عندما يكون العنصر رابطًا إلى ملف Drive وnull وإلا.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getTitle()Stringيعرض العنوان المعروض للرابط.
getType()ElementTypeلاسترداد ElementType للعنصر.
getUrl()Stringتعرض عنوان URL للمورد.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()RichLinkتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()RichLinkإزالة العنصر من عنصره الأساسي
setAttributes(attributes)RichLinkيعيّن سمات العنصر.

Tab

الطُرق

الطريقةنوع الإرجاعوصف قصير
asDocumentTab()DocumentTabيسترد محتوى علامة التبويب على هيئة DocumentTab.
getChildTabs()Tab[]لاسترداد علامات التبويب الفرعية المضمَّنة في علامة التبويب هذه.
getId()Stringيسترد رقم تعريف علامة التبويب.
getIndex()Integerيسترد الفهرس المستند إلى القيمة 0 لعلامة التبويب داخل العنصر الرئيسي.
getTitle()Stringيسترجع عنوان علامة التبويب.
getType()TabTypeيسترد نوع علامة التبويب.

TabType

أماكن إقامة

الموقعالنوعالوصف
DOCUMENT_TABEnumالنوع المتوافق مع DocumentTab.

Table

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendTableRow()TableRowتنشئ سمة TableRow جديدة وتلحقها
appendTableRow(tableRow)TableRowتُرفِق السمة TableRow المحدّدة.
clear()Tableيؤدي إلى محو محتوى العنصر.
copy()Tableلعرض نسخة منفصلة عميقة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAttributes()Objectيسترد سمات العنصر.
getBorderColor()Stringلاسترداد لون الحد
getBorderWidth()Numberلاسترداد عرض الحدود بالنقاط.
getCell(rowIndex, cellIndex)TableCellلاسترداد TableCell في فهارس الصفوف والخلايا المحددة.
getChild(childIndex)Elementاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getColumnWidth(columnIndex)Numberلاسترداد عرض عمود الجدول المحدد بالنقاط.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getNumRows()Integerلاسترداد عدد TableRows.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getRow(rowIndex)TableRowاسترداد TableRow في فهرس الصف المحدّد.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
insertTableRow(childIndex)TableRowتنشئ السمة TableRow جديدة وإدراجها في الفهرس المحدّد.
insertTableRow(childIndex, tableRow)TableRowإدراج TableRow المحدّد في الفهرس المحدّد
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
removeChild(child)Tableإزالة العنصر الفرعي المحدد
removeFromParent()Tableإزالة العنصر من عنصره الأساسي
removeRow(rowIndex)TableRowإزالة TableRow في فهرس الصف المحدّد.
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)Tableيعيّن سمات العنصر.
setBorderColor(color)Tableلضبط لون الحدود.
setBorderWidth(width)Tableلضبط عرض الحدود بالنقاط.
setColumnWidth(columnIndex, width)Tableلضبط عرض العمود المحدد بالنقاط.
setLinkUrl(url)Tableلضبط عنوان URL للرابط.
setTextAlignment(textAlignment)Tableلضبط محاذاة النص.

TableCell

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendHorizontalRule()HorizontalRuleتنشئ سمة HorizontalRule جديدة وتلحقها
appendImage(image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
appendImage(image)InlineImageتُرفِق السمة InlineImage المحدّدة.
appendListItem(listItem)ListItemتُرفِق السمة ListItem المحدّدة.
appendListItem(text)ListItemتنشئ سمة ListItem جديدة وتلحقها
appendParagraph(paragraph)Paragraphتُرفِق السمة Paragraph المحدّدة.
appendParagraph(text)Paragraphتنشئ سمة Paragraph جديدة وتلحقها
appendTable()Tableتنشئ سمة Table جديدة وتلحقها
appendTable(cells)Tableلإلحاق Table جديدة تحتوي على الخلايا المحددة.
appendTable(table)Tableتُرفِق السمة Table المحدّدة.
clear()TableCellيؤدي إلى محو محتوى العنصر.
copy()TableCellلعرض نسخة منفصلة عميقة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAttributes()Objectيسترد سمات العنصر.
getBackgroundColor()Stringلاسترداد لون الخلفية.
getChild(childIndex)Elementاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getColSpan()Integerتسترد امتداد العمود، وهو عدد أعمدة خلايا الجدول التي تمتد هذه الخلية إليها.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getPaddingBottom()Numberلاسترداد المساحة المتروكة السفلية بالنقاط.
getPaddingLeft()Numberاسترداد المساحة المتروكة اليسرى بالنقاط.
getPaddingRight()Numberاسترداد المساحة المتروكة اليمنى بالنقاط.
getPaddingTop()Numberلاسترداد المساحة المتروكة العلوية بالنقاط.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getParentRow()TableRowلاسترداد TableRow الذي يحتوي على TableCell الحالي.
getParentTable()Tableلاسترداد Table الذي يحتوي على TableCell الحالي.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getRowSpan()Integerتسترد امتداد الصف، وهو عدد صفوف خلايا الجدول التي تمتد هذه الخلية إليها.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
getVerticalAlignment()VerticalAlignmentلاسترداد VerticalAlignment.
getWidth()Numberلاسترداد عرض العمود الذي يحتوي على الخلية، بالنقاط.
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 جديدة وإدراجها في الفهرس المحدّد.
insertParagraph(childIndex, paragraph)Paragraphإدراج Paragraph المحدّد في الفهرس المحدّد
insertParagraph(childIndex, text)Paragraphتنشئ السمة Paragraph جديدة وإدراجها في الفهرس المحدّد.
insertTable(childIndex)Tableتنشئ السمة Table جديدة وإدراجها في الفهرس المحدّد.
insertTable(childIndex, cells)Tableتنشئ وإدراج Table جديدة تحتوي على الخلايا المحددة، في الفهرس المحدد.
insertTable(childIndex, table)Tableإدراج Table المحدّد في الفهرس المحدّد
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()TableCellتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeChild(child)TableCellإزالة العنصر الفرعي المحدد
removeFromParent()TableCellإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)TableCellيعيّن سمات العنصر.
setBackgroundColor(color)TableCellلضبط لون الخلفية.
setLinkUrl(url)TableCellلضبط عنوان URL للرابط.
setPaddingBottom(paddingBottom)TableCellلضبط المساحة المتروكة السفلية بالنقاط.
setPaddingLeft(paddingLeft)TableCellلضبط المساحة المتروكة اليسرى بالنقاط.
setPaddingRight(paddingRight)TableCellلضبط المساحة المتروكة اليمنى بالنقاط.
setPaddingTop(paddingTop)TableCellلضبط المساحة المتروكة العلوية بالنقاط.
setText(text)TableCellلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)TableCellلضبط محاذاة النص.
setVerticalAlignment(alignment)TableCellلضبط المحاذاة العمودية.
setWidth(width)TableCellلضبط عرض العمود الذي يحتوي على الخلية الحالية بالنقاط.

TableOfContents

الطُرق

الطريقةنوع الإرجاعوصف قصير
clear()TableOfContentsيؤدي إلى محو محتوى العنصر.
copy()TableOfContentsلعرض نسخة منفصلة عميقة من العنصر الحالي.
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استرداد الفهرس الفرعي للعنصر الفرعي المحدد.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
removeFromParent()TableOfContentsإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)TableOfContentsيعيّن سمات العنصر.
setLinkUrl(url)TableOfContentsلضبط عنوان URL للرابط.
setTextAlignment(textAlignment)TableOfContentsلضبط محاذاة النص.

TableRow

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendTableCell()TableCellتنشئ سمة TableCell جديدة وتلحقها
appendTableCell(textContents)TableCellلإلحاق TableCell المحدَّد الذي يحتوي على النص المحدَّد
appendTableCell(tableCell)TableCellتُرفِق السمة TableCell المحدّدة.
clear()TableRowيؤدي إلى محو محتوى العنصر.
copy()TableRowلعرض نسخة منفصلة عميقة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAttributes()Objectيسترد سمات العنصر.
getCell(cellIndex)TableCellيسترد TableCell في فهرس الخلايا المحدد.
getChild(childIndex)Elementاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getMinimumHeight()Numberلاسترداد الحد الأدنى للارتفاع بالنقاط.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getNumCells()Integerلاسترداد عدد الخلايا في الصف.
getNumChildren()Integerلاسترداد عدد الأطفال.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getParentTable()Tableاسترداد Table الذي يحتوي على الصف الحالي
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeلاسترداد ElementType للعنصر.
insertTableCell(childIndex)TableCellتنشئ السمة TableCell جديدة وإدراجها في الفهرس المحدّد.
insertTableCell(childIndex, textContents)TableCellإدراج TableCell المحدّد في الفهرس المحدّد، الذي يحتوي على النص المعنيّ
insertTableCell(childIndex, tableCell)TableCellإدراج TableCell المحدّد في الفهرس المحدّد
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()TableRowتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeCell(cellIndex)TableCellإزالة TableCell في فهرس الخلية المحدد.
removeChild(child)TableRowإزالة العنصر الفرعي المحدد
removeFromParent()TableRowإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)TableRowيعيّن سمات العنصر.
setLinkUrl(url)TableRowلضبط عنوان URL للرابط.
setMinimumHeight(minHeight)TableRowلضبط الحد الأدنى للارتفاع بالنقاط.
setTextAlignment(textAlignment)TableRowلضبط محاذاة النص.

Text

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendText(text)Textلإضافة النص المحدَّد إلى نهاية منطقة النص هذه
copy()Textلعرض نسخة منفصلة عميقة من العنصر الحالي.
deleteText(startOffset, endOffsetInclusive)Textحذف نطاق النص
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAttributes()Objectيسترد سمات العنصر.
getAttributes(offset)Objectيسترد السمات حسب إزاحة الأحرف المحددة.
getBackgroundColor()Stringلاسترداد إعدادات لون الخلفية.
getBackgroundColor(offset)Stringيسترد لون الخلفية حسب إزاحة الأحرف المحددة.
getFontFamily()Stringلاسترداد إعداد مجموعة الخطوط.
getFontFamily(offset)Stringلاسترداد مجموعة الخطوط استنادًا إلى إزاحة الأحرف المحددة.
getFontSize()Numberلاسترداد إعدادات حجم الخط.
getFontSize(offset)Numberيسترد حجم الخط وفقًا لإزاحة الأحرف المحددة.
getForegroundColor()Stringيسترد إعدادات لون المقدّمة.
getForegroundColor(offset)Stringيسترد لون المقدمة حسب إزاحة الأحرف المحددة.
getLinkUrl()Stringيسترد عنوان URL للرابط.
getLinkUrl(offset)Stringيسترد عنوان URL للرابط حسب إزاحة الأحرف المحددة.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getText()Stringلاسترداد محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getTextAlignment(offset)TextAlignmentالحصول على محاذاة النص لحرف واحد
getTextAttributeIndices()Integer[]استرداد مجموعة الفهارس النصية التي تتجاوب مع بداية تنسيق النص المميز يركض.
getType()ElementTypeلاسترداد ElementType للعنصر.
insertText(offset, text)Textإدراج النص المحدد عند إزاحة الحرف المحددة.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
isBold()Booleanيسترد الإعداد الغامق.
isBold(offset)Booleanيسترد الإعداد الغامق حسب إزاحة الأحرف المحددة.
isItalic()Booleanيسترد الإعداد المائل.
isItalic(offset)Booleanاسترداد الإعداد المائل حسب إزاحة الأحرف المحددة.
isStrikethrough()Booleanيسترد إعداد النص الذي يتوسطه خط.
isStrikethrough(offset)Booleanيسترد إعداد النص الذي يتوسطه خط عند إزاحة الأحرف المحددة.
isUnderline()Booleanيسترد إعداد التسطير.
isUnderline(offset)Booleanاسترداد إعداد التسطير حسب إزاحة الأحرف المحددة.
merge()Textتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()Textإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(startOffset, endOffsetInclusive, attributes)Textيتيح هذا الخيار تطبيق السمات المحدّدة على نطاق الأحرف المحدّد.
setAttributes(attributes)Textيعيّن سمات العنصر.
setBackgroundColor(startOffset, endOffsetInclusive, color)Textلضبط لون الخلفية لنطاق الأحرف المحدّد.
setBackgroundColor(color)Textلضبط لون الخلفية.
setBold(bold)Textلضبط الإعداد الغامق.
setBold(startOffset, endOffsetInclusive, bold)Textلضبط الإعداد الغامق لنطاق الأحرف المحدّد.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)Textلضبط مجموعة الخطوط لنطاق الأحرف المحدّد.
setFontFamily(fontFamilyName)Textلتعيين مجموعة الخطوط.
setFontSize(startOffset, endOffsetInclusive, size)Textلضبط حجم الخط لنطاق الأحرف المحدّد.
setFontSize(size)Textلضبط حجم الخط.
setForegroundColor(startOffset, endOffsetInclusive, color)Textلضبط لون المقدّمة لنطاق الأحرف المحدّد.
setForegroundColor(color)Textلضبط لون المقدّمة.
setItalic(italic)Textلضبط الإعداد المائل.
setItalic(startOffset, endOffsetInclusive, italic)Textلضبط الإعداد المائل لنطاق الأحرف المحدّد.
setLinkUrl(startOffset, endOffsetInclusive, url)Textلضبط عنوان URL للرابط لنطاق الأحرف المحدّد.
setLinkUrl(url)Textلضبط عنوان URL للرابط.
setStrikethrough(strikethrough)Textلضبط إعداد النص الذي يتوسطه خط.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)Textلضبط إعداد النص الذي يتوسطه خط لنطاق الأحرف المحدّد.
setText(text)Textلضبط محتوى النص.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)Textلتعيين محاذاة النص لنطاق أحرف معين.
setTextAlignment(textAlignment)Textلضبط محاذاة النص.
setUnderline(underline)Textلضبط إعدادات التسطير.
setUnderline(startOffset, endOffsetInclusive, underline)Textلضبط إعداد التسطير لنطاق الأحرف المحدَّد.

TextAlignment

أماكن إقامة

الموقعالنوعالوصف
NORMALEnumمحاذاة النص العادية.
SUPERSCRIPTEnumمحاذاة النص المرتفع.
SUBSCRIPTEnumمحاذاة النص لأسفل.

UnsupportedElement

الطُرق

الطريقةنوع الإرجاعوصف قصير
copy()UnsupportedElementلعرض نسخة منفصلة عميقة من العنصر الحالي.
getAttributes()Objectيسترد سمات العنصر.
getNextSibling()Elementلاسترداد العنصر الشقيق التالي للعنصر.
getParent()ContainerElementاسترداد العنصر الأصلي للعنصر.
getPreviousSibling()Elementلاسترداد العنصر الشقيق السابق للعنصر.
getType()ElementTypeلاسترداد ElementType للعنصر.
isAtDocumentEnd()Booleanوتحدِّد ما إذا كان العنصر في نهاية Document.
merge()UnsupportedElementتدمج العنصر مع العنصر التابع السابق من النوع نفسه.
removeFromParent()UnsupportedElementإزالة العنصر من عنصره الأساسي
setAttributes(attributes)UnsupportedElementيعيّن سمات العنصر.

VerticalAlignment

أماكن إقامة

الموقعالنوعالوصف
BOTTOMEnumخيار المحاذاة السفلي.
CENTEREnumخيار المحاذاة للوسط.
TOPEnumخيار المحاذاة العلوي