این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class RichLink

عنصری که پیوندی به یک منبع Google را نشان می دهد، مانند یک فایل Drive یا یک ویدیوی YouTube.

روش ها

روش	نوع برگشت	شرح مختصر
`copy()`	`Rich Link`	یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
`get Attributes()`	`Object`	ویژگی های عنصر را بازیابی می کند.
`get Mime Type()`	`String`	نوع MIME پیوند را برمی‌گرداند، که وقتی مورد پیوندی به فایل Drive باشد در دسترس است و در غیر این صورت `null` .
`get Next Sibling()`	`Element`	عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
`get Parent()`	`Container Element`	عنصر والد عنصر را بازیابی می کند.
`get Previous Sibling()`	`Element`	عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
`get Title()`	`String`	عنوان نمایش داده شده پیوند را برمی گرداند.
`get Type()`	`Element Type`	`Element Type` عنصر را بازیابی می کند.
`get Url()`	`String`	URL منبع را برمی گرداند.
`is At Document End()`	`Boolean`	تعیین می کند که آیا عنصر در انتهای `Document` قرار دارد یا خیر.
`merge()`	`Rich Link`	عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
`remove From Parent()`	`Rich Link`	عنصر را از والد خود حذف می کند.
`set Attributes(attributes)`	`Rich Link`	ویژگی های عنصر را تنظیم می کند.

مستندات دقیق

`copy()`

یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.

هر عنصر فرزند موجود در عنصر نیز کپی می شود. عنصر جدید والد ندارد.

بازگشت

Rich Link - نسخه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Attributes()`

ویژگی های عنصر را بازیابی می کند.

نتیجه یک شی حاوی یک ویژگی برای هر ویژگی عنصر معتبر است که در آن نام هر ویژگی با یک مورد در شمارش Document App.Attribute مطابقت دارد.

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

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

بازگشت

Object - ویژگی های عنصر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Mime Type()`

نوع MIME پیوند را برمی‌گرداند، که وقتی مورد پیوندی به فایل Drive باشد در دسترس است و در غیر این صورت null .

برای مثال، اگر پیوند به یک فایل Google Docs اشاره کند، رشته application/vnd.google-apps.document را برمی‌گرداند.

بازگشت

String - نوع MIME پیوند، در صورت وجود.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Next Sibling()`

عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.

خواهر و برادر بعدی همان والد را دارد و از عنصر فعلی پیروی می کند.

بازگشت

Element - عنصر خواهر و برادر بعدی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Parent()`

عنصر والد عنصر را بازیابی می کند.

عنصر والد حاوی عنصر فعلی است.

بازگشت

Container Element - عنصر والد.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Previous Sibling()`

عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.

خواهر و برادر قبلی والد مشابهی دارد و مقدم بر عنصر فعلی است.

بازگشت

Element - عنصر خواهر و برادر قبلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Title()`

عنوان نمایش داده شده پیوند را برمی گرداند. این عنوان با عنوان منبع پیوندی در زمان درج یا آخرین به روز رسانی پیوند مطابقت دارد. برای مثال، اگر این پیوند به سند Google Docs با عنوان "Analysis" اشاره کند، آن را Analysis .

بازگشت

String - عنوان نمایش پیوند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Type()`

Element Type عنصر را بازیابی می کند.

از get Type() برای تعیین نوع دقیق یک عنصر استفاده کنید.

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

// Obtain the first element in the active tab's body.

const 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.');
}

بازگشت

Element Type - نوع عنصر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`get Url()`

URL منبع را برمی گرداند.

بازگشت

String - URL منبع.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`is At Document End()`

تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر.

بازگشت

Boolean - اینکه آیا عنصر در انتهای برگه است.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`merge()`

عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.

فقط عناصری از همان Element Type را می توان ادغام کرد. هر عنصر فرزند موجود در عنصر فعلی به عنصر خواهر و برادر قبلی منتقل می شود.

عنصر فعلی از سند حذف می شود.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

بازگشت

Rich Link - عنصر ادغام شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`remove From Parent()`

عنصر را از والد خود حذف می کند.

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

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

بازگشت

Rich Link - عنصر حذف شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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

`set Attributes(attributes)`

ویژگی های عنصر را تنظیم می کند.

پارامتر مشخصه مشخص شده باید یک شی باشد که در آن نام هر ویژگی یک آیتم در شمارش Document App.Attribute باشد و هر مقدار ویژگی مقدار جدیدی است که باید اعمال شود.

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

// Define a custom paragraph style.
const 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.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

پارامترها

نام	تایپ کنید	توضیحات
`attributes`	`Object`	ویژگی های عنصر

بازگشت

Rich Link - عنصر فعلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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