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

Class InlineImage

عنصری که یک تصویر جاسازی شده را نشان می دهد. یک Inline Image می توان در یک List Item یا Paragraph قرار داد، مگر اینکه آیتم یا Paragraph List Item در یک Footnote Section باشد. یک Inline Image خود نمی تواند حاوی هیچ عنصر دیگری باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.

روش ها

روش	نوع برگشت	شرح مختصر
`copy()`	`Inline Image`	یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
`get Alt Description()`	`String`	توضیحات جایگزین تصویر را برمی گرداند.
`get Alt Title()`	`String`	عنوان جایگزین تصویر را برمی‌گرداند.
`get As(contentType)`	`Blob`	داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید.
`get Attributes()`	`Object`	ویژگی های عنصر را بازیابی می کند.
`get Blob()`	`Blob`	داده های داخل این شی را به صورت حباب برگردانید.
`get Height()`	`Integer`	ارتفاع تصویر را بر حسب پیکسل بازیابی می کند.
`get Link Url()`	`String`	URL پیوند را بازیابی می کند.
`get Next Sibling()`	`Element`	عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
`get Parent()`	`Container Element`	عنصر والد عنصر را بازیابی می کند.
`get Previous Sibling()`	`Element`	عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
`get Type()`	`Element Type`	`Element Type` عنصر را بازیابی می کند.
`get Width()`	`Integer`	عرض تصویر را بر حسب پیکسل بازیابی می کند.
`is At Document End()`	`Boolean`	تعیین می کند که آیا عنصر در انتهای `Document` قرار دارد یا خیر.
`merge()`	`Inline Image`	عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
`remove From Parent()`	`Inline Image`	عنصر را از والد خود حذف می کند.
`set Alt Description(description)`	`Inline Image`	توضیحات جایگزین تصویر را تنظیم می کند.
`set Alt Title(title)`	`Inline Image`	عنوان جایگزین تصویر را تنظیم می کند.
`set Attributes(attributes)`	`Inline Image`	ویژگی های عنصر را تنظیم می کند.
`set Height(height)`	`Inline Image`	ارتفاع تصویر را بر حسب پیکسل تنظیم می کند.
`set Link Url(url)`	`Inline Image`	URL پیوند را تنظیم می کند.
`set Width(width)`	`Inline Image`	عرض تصویر را بر حسب پیکسل تنظیم می کند.

مستندات دقیق

`copy()`

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

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

بازگشت

Inline Image - کپی جدید.

مجوز

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

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

`get Alt Description()`

توضیحات جایگزین تصویر را برمی گرداند.

بازگشت

String - عنوان جایگزین یا null اگر عنصر عنوان جایگزین نداشته باشد

مجوز

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

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

`get Alt Title()`

عنوان جایگزین تصویر را برمی‌گرداند.

بازگشت

String - عنوان جایگزین یا null اگر عنصر عنوان جایگزین نداشته باشد

مجوز

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

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

`get As(contentType)`

داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. این روش پسوند مناسب را به نام فایل اضافه می کند - به عنوان مثال، "myfile.pdf". با این حال، فرض می‌کند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل می شود.

برای مشاهده سهمیه های روزانه برای تبدیل، به سهمیه خدمات Google مراجعه کنید. دامنه‌های جدید Google Workspace ممکن است به طور موقت مشمول سهمیه‌های سخت‌گیرانه‌تر شوند.

پارامترها

نام	تایپ کنید	توضیحات
`content Type`	`String`	نوع MIME برای تبدیل. برای اکثر حباب‌ها، `'application/pdf'` تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از `'image/bmp'` ، `'image/gif'` ، `'image/jpeg'` یا `'image/png'` نیز معتبر هستند. برای سند Google Docs، `'text/markdown'` نیز معتبر است.

بازگشت

Blob - داده ها به عنوان یک لکه.

`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 Blob()`

داده های داخل این شی را به صورت حباب برگردانید.

بازگشت

Blob - داده ها به عنوان یک لکه.

`get Height()`

ارتفاع تصویر را بر حسب پیکسل بازیابی می کند.

بازگشت

Integer - ارتفاع تصویر، بر حسب پیکسل

مجوز

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

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

`get Link Url()`

URL پیوند را بازیابی می کند.

بازگشت

String - URL پیوند، یا اگر عنصر حاوی مقادیر متعددی برای این ویژگی باشد، null .

مجوز

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

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 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 Width()`

عرض تصویر را بر حسب پیکسل بازیابی می کند.

بازگشت

Integer - عرض تصویر، بر حسب پیکسل

مجوز

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

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

بازگشت

Inline Image - عنصر ادغام شده.

مجوز

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

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

بازگشت

Inline Image - عنصر حذف شده.

مجوز

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

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

`set Alt Description(description)`

توضیحات جایگزین تصویر را تنظیم می کند. اگر عنوان داده شده null باشد، توضیحات را روی رشته خالی تنظیم می کند.

پارامترها

نام	تایپ کنید	توضیحات
`description`	`String`	عنوان جایگزین

بازگشت

Inline Image - شی فعلی

مجوز

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

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

`set Alt Title(title)`

عنوان جایگزین تصویر را تنظیم می کند. اگر عنوان داده شده null باشد، عنوان را روی رشته خالی قرار می دهد.

پارامترها

نام	تایپ کنید	توضیحات
`title`	`String`	عنوان جایگزین

بازگشت

Inline Image - شی فعلی

مجوز

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

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`	ویژگی های عنصر

بازگشت

Inline Image - عنصر فعلی.

مجوز

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

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

`set Height(height)`

ارتفاع تصویر را بر حسب پیکسل تنظیم می کند.

پارامترها

نام	تایپ کنید	توضیحات
`height`	`Integer`	ارتفاع تصویر بر حسب پیکسل

بازگشت

Inline Image - شی فعلی

مجوز

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

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

`set Link Url(url)`

URL پیوند را تنظیم می کند. اگر URL داده شده null یا یک رشته خالی باشد، این روش پیوندی با URL خالی ایجاد می کند که ممکن است به عنوان "پیوند نامعتبر" در Google Docs نمایش داده شود.

پارامترها

نام	تایپ کنید	توضیحات
`url`	`String`	آدرس لینک

بازگشت

Inline Image - شی فعلی

مجوز

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

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

`set Width(width)`

عرض تصویر را بر حسب پیکسل تنظیم می کند.

پارامترها

نام	تایپ کنید	توضیحات
`width`	`Integer`	عرض تصویر بر حسب پیکسل

بازگشت

Inline Image - شی فعلی

مجوز

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

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