Class InlineImage

تصویر درون خطی

عنصری که یک تصویر جاسازی شده را نشان می دهد. یک InlineImage را می توان در یک ListItem یا Paragraph قرار داد، مگر اینکه ListItem یا Paragraph در یک FootnoteSection باشد. یک InlineImage خود نمی تواند حاوی هیچ عنصر دیگری باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.

روش ها

روش نوع برگشت شرح مختصر
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 عرض تصویر را بر حسب پیکسل تنظیم می کند.

مستندات دقیق

copy()

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

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

بازگشت

InlineImage - کپی جدید.

مجوز

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

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

getAltDescription()

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

بازگشت

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

مجوز

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

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

getAltTitle()

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

بازگشت

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

مجوز

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

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

getAs(contentType)

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

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

پارامترها

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

بازگشت

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

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

getBlob()

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

بازگشت

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

getHeight()

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

بازگشت

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

مجوز

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

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

getLinkUrl()

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

بازگشت

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

مجوز

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

  • 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

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

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

getWidth()

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

بازگشت

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

مجوز

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

  • 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

merge()

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

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

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

بازگشت

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

مجوز

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

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

بازگشت

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

مجوز

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

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

setAltDescription(description)

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

پارامترها

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

بازگشت

InlineImage - شی فعلی

مجوز

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

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

setAltTitle(title)

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

پارامترها

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

بازگشت

InlineImage - شی فعلی

مجوز

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

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

setAttributes(attributes)

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

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

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

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

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

پارامترها

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

بازگشت

InlineImage - عنصر فعلی.

مجوز

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

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

setHeight(height)

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

پارامترها

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

بازگشت

InlineImage - شی فعلی

مجوز

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

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

setLinkUrl(url)

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

پارامترها

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

بازگشت

InlineImage - شی فعلی

مجوز

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

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

setWidth(width)

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

پارامترها

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

بازگشت

InlineImage - شی فعلی

مجوز

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

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