Class Table

جدول

يشير ذلك المصطلح إلى عنصر يمثّل جدولاً. يمكن أن يحتوي Table على عناصر TableRow فقط. بالنسبة مزيد من المعلومات حول بنية المستند، راجع دليل توسيع نطاق مستندات Google.

عند إنشاء Table يحتوي على عدد كبير من الصفوف أو الخلايا، ننصحك بإنشاء من صفيف سلسلة، كما هو موضح في المثال التالي. 

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Create a two-dimensional array containing the cell contents.
var cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2']
];

// Build a table from the array.
body.appendTable(cells);

الطُرق

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

الوثائق التفصيلية

appendTableRow()

تنشئ سمة TableRow جديدة وتلحقها

الإرجاع

TableRow: عنصر الصف الجديد في الجدول

التفويض

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

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

appendTableRow(tableRow)

تُرفِق السمة TableRow المحدّدة. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table in the tab and copies the second row.
const table = body.getTables()[0];
const row = table.getChild(1).copy();

// Adds the copied row to the bottom of the table.
const tableRow = table.appendTableRow(row);

المعلمات

الاسمالنوعالوصف
tableRowTableRowصف الجدول المطلوب إلحاقه.

الإرجاع

TableRow: عنصر الصفّ في الجدول الملحق

التفويض

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

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

clear()

يؤدي إلى محو محتوى العنصر.

الإرجاع

Table — العنصر الحالي

copy()

لعرض نسخة منفصلة عميقة من العنصر الحالي.

ويتم أيضًا نسخ أي عناصر فرعية موجودة في العنصر. لا يحتوي العنصر الجديد على أحد الوالدين.

الإرجاع

Table: النسخة الجديدة

التفويض

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

  • 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)

يبحث في محتوى العنصر عن تابع من النوع المحدد.

المعلمات

الاسمالنوعالوصف
elementTypeElementTypeنوع العنصر المطلوب البحث عنه.

الإرجاع

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;
  }
}

المعلمات

الاسمالنوعالوصف
elementTypeElementTypeنوع العنصر المطلوب البحث عنه.
fromRangeElementنتيجة البحث المطلوب البحث منها.

الإرجاع

RangeElement - نتيجة بحث تشير إلى الموضع التالي لعنصر البحث.

التفويض

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

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

findText(searchPattern)

للبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.

هناك مجموعة فرعية من ميزات التعبير العادي في JavaScript غير متوافقة بالكامل، مثل التقاط المجموعات ومعدِّلات الأوضاع.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.

المعلمات

الاسمالنوعالوصف
searchPatternStringالنمط للبحث عن

الإرجاع

RangeElement — نتيجة بحث تشير إلى موضع نص البحث أو "فارغ" إذا لم يكن هناك مطابقة

التفويض

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

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

findText(searchPattern, from)

يبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.

هناك مجموعة فرعية من ميزات التعبير العادي في JavaScript غير متوافقة بالكامل، مثل التقاط المجموعات ومعدِّلات الأوضاع.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كل جزء نصي الموجودة في العنصر الحالي.

المعلمات

الاسمالنوعالوصف
searchPatternStringالنمط للبحث عن
fromRangeElementنتيجة البحث للبحث منها

الإرجاع

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

getBorderColor()

لاسترداد لون الحد 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the border color of the first table.
table.setBorderColor('#00FF00');

// Logs the border color of the first table to the console.
console.log(table.getBorderColor());

الإرجاع

String - لون الحدود، من خلال ترميز CSS (مثل '#ffffff')

التفويض

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

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

getBorderWidth()

لاسترداد عرض الحدود بالنقاط. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the border width of the first table.
table.setBorderWidth(20);

// Logs the border width of the first table.
console.log(table.getBorderWidth());

الإرجاع

Number — عرض الحدود بالنقاط.

التفويض

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

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

getCell(rowIndex, cellIndex)

لاسترداد TableCell في فهارس الصفوف والخلايا المحددة. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Gets the cell of the table's third row and second column.
const cell = table.getCell(2, 1);

// Logs the cell text to the console.
console.log(cell.getText());

المعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس الصف الذي يحتوي على الخلية المراد استردادها.
cellIndexIntegerفهرس الخلية المطلوب استرداده.

الإرجاع

TableCell : خلية الجدول

التفويض

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

  • 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.");
}

المعلمات

الاسمالنوعالوصف
childIndexIntegerفهرس العنصر الفرعي المطلوب استرداده.

الإرجاع

Element — العنصر الثانوي في الفهرس المحدد.

التفويض

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

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

getChildIndex(child)

استرداد الفهرس الفرعي للعنصر الفرعي المحدد.

المعلمات

الاسمالنوعالوصف
childElementالعنصر الفرعي المطلوب استرداد الفهرس له.

الإرجاع

Integer — الفهرس الفرعي

التفويض

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

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

getColumnWidth(columnIndex)

لاسترداد عرض عمود الجدول المحدد بالنقاط. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the width of the second column to 100 points.
const columnWidth = table.setColumnWidth(1, 100);

// Gets the width of the second column and logs it to the console.
console.log(columnWidth.getColumnWidth(1));

المعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس العمود.

الإرجاع

Number — عرض العمود بالنقاط

التفويض

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

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

getLinkUrl()

يسترد عنوان URL للرابط.

الإرجاع

String: عنوان URL للرابط أو قيمة فارغة إذا كان العنصر يحتوي على قيم متعددة لهذه السمة

التفويض

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

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

getNextSibling()

لاسترداد العنصر الشقيق التالي للعنصر.

عنصر الشقيق التالي له نفس الأصل ويتبع العنصر الحالي.

الإرجاع

Element — العنصر الشقيق التالي

التفويض

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

  • 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

getNumRows()

لاسترداد عدد TableRows. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Logs the number of rows of the first table to the console.
console.log(table.getNumRows());

الإرجاع

Integer - عدد صفوف الجدول

التفويض

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

  • 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

getPreviousSibling()

لاسترداد العنصر الشقيق السابق للعنصر.

العنصر الشقيق السابق له نفس العنصر الرئيسي ويسبق العنصر الحالي.

الإرجاع

Element — العنصر الشقيق السابق

التفويض

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

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

getRow(rowIndex)

استرداد TableRow في فهرس الصف المحدّد. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table and logs the text of first row to the console.
const table = body.getTables()[0];
console.log(table.getRow(0).getText());

المعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس الصف المطلوب استرداده.

الإرجاع

TableRow: صف الجدول

التفويض

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

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

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

insertTableRow(childIndex)

تنشئ السمة TableRow جديدة وإدراجها في الفهرس المحدّد.

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي يتم عنده إدراج العنصر

الإرجاع

TableRow — العنصر الحالي

التفويض

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

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

insertTableRow(childIndex, tableRow)

إدراج TableRow المحدّد في الفهرس المحدّد

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي يتم عنده إدراج العنصر
tableRowTableRowصف الجدول لإدراج

الإرجاع

TableRow: عنصر الصف المدرَج في الجدول

التفويض

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

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

isAtDocumentEnd()

وتحدِّد ما إذا كان العنصر في نهاية Document.

الإرجاع

Boolean: ما إذا كان العنصر في نهاية علامة التبويب.

التفويض

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

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

removeChild(child)

إزالة العنصر الفرعي المحدد 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Finds the first table row and removes it.
const element = table.findElement(DocumentApp.ElementType.TABLE_ROW);
table.removeChild(element.getElement());

المعلمات

الاسمالنوعالوصف
childElementالعنصر الثانوي المطلوب إزالته.

الإرجاع

Table — العنصر الحالي

التفويض

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

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

removeFromParent()

إزالة العنصر من عنصره الأساسي 

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

الإرجاع

Table — العنصر الذي تمت إزالته

التفويض

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

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

removeRow(rowIndex)

إزالة TableRow في فهرس الصف المحدّد. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table and removes its second row.
const table = body.getTables()[0];
table.removeRow(1);

المعلمات

الاسمالنوعالوصف
rowIndexIntegerفهرس الصف المطلوب إزالته.

الإرجاع

TableRow — الصف الذي تمت إزالته.

التفويض

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

  • 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");

المعلمات

الاسمالنوعالوصف
searchPatternStringنمط التعبير العادي للبحث عن
replacementStringالنص المطلوب استخدامه كبديل

الإرجاع

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

المعلمات

الاسمالنوعالوصف
attributesObjectسمات العنصر.

الإرجاع

Table — العنصر الحالي

التفويض

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

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

setBorderColor(color)

لضبط لون الحدود. 

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the border color of the table to green.
table.setBorderColor('#00FF00');

المعلمات

الاسمالنوعالوصف
colorStringلون الحدود، من خلال ترميز CSS (مثل '#ffffff').

الإرجاع

Table — العنصر الحالي

التفويض

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

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

setBorderWidth(width)

لضبط عرض الحدود بالنقاط.

المعلمات

الاسمالنوعالوصف
widthNumberعرض الحدود بالنقاط

الإرجاع

Table — العنصر الحالي

التفويض

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

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

setColumnWidth(columnIndex, width)

لضبط عرض العمود المحدد بالنقاط.

المعلمات

الاسمالنوعالوصف
columnIndexIntegerفهرس العمود
widthNumberعرض الحدود بالنقاط

الإرجاع

Table — العنصر الحالي

التفويض

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

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

setLinkUrl(url)

لضبط عنوان URL للرابط.

المعلمات

الاسمالنوعالوصف
urlStringعنوان URL للرابط

الإرجاع

Table — العنصر الحالي

التفويض

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

  • 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);

المعلمات

الاسمالنوعالوصف
textAlignmentTextAlignmentنوع محاذاة النص لتطبيقه

الإرجاع

Table — العنصر الحالي

التفويض

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

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