Interface Item

مورد

یک مورد فرم عمومی که حاوی ویژگی‌های مشترک برای همه موارد است، مانند عنوان و متن راهنما. آیتم ها را می توان از یک Form مشاهده کرد یا ایجاد کرد.

برای کار بر روی خصوصیات نوع خاص، از getType() برای بررسی ItemType مورد استفاده کنید، سپس با استفاده از روشی مانند asCheckboxItem() مورد را به کلاس مناسب ارسال کنید. 

// Create a new form and add a text item.
var form = FormApp.create('Form Name');
form.addTextItem();

// Access the text item as a generic item.
var items = form.getItems();
var item = items[0];

// Cast the generic item to the text-item class.
if (item.getType() == 'TEXT') {
  var textItem = item.asTextItem();
  textItem.setRequired(false);
}

اجرای کلاس ها

نام شرح مختصر

روش ها

روش نوع برگشت شرح مختصر
asCheckboxGridItem() CheckboxGridItem مورد را به عنوان یک مورد شبکه چک باکس برمی‌گرداند.
asCheckboxItem() CheckboxItem مورد را به عنوان یک مورد چک باکس برمی گرداند.
asDateItem() DateItem مورد را به عنوان یک مورد تاریخ برمی‌گرداند.
asDateTimeItem() DateTimeItem مورد را به عنوان یک مورد تاریخ-زمان برمی‌گرداند.
asDurationItem() DurationItem مورد را به عنوان یک مورد مدت زمان برمی‌گرداند.
asGridItem() GridItem مورد را به عنوان یک مورد شبکه برمی گرداند.
asImageItem() ImageItem مورد را به عنوان یک آیتم تصویر برمی گرداند.
asListItem() ListItem مورد را به عنوان یک مورد لیست برمی گرداند.
asMultipleChoiceItem() MultipleChoiceItem مورد را به عنوان یک مورد چند گزینه ای برمی گرداند.
asPageBreakItem() PageBreakItem مورد را به عنوان یک مورد شکستگی صفحه برمی گرداند.
asParagraphTextItem() ParagraphTextItem مورد را به عنوان یک پاراگراف-متن مورد برمی‌گرداند.
asScaleItem() ScaleItem مورد را به عنوان یک مورد مقیاس برمی گرداند.
asSectionHeaderItem() SectionHeaderItem مورد را به عنوان یک مورد سرفصل بخش برمی‌گرداند.
asTextItem() TextItem مورد را به عنوان یک مورد متنی برمی گرداند.
asTimeItem() TimeItem مورد را به عنوان آیتم زمانی برمی گرداند.
asVideoItem() VideoItem مورد را به عنوان یک مورد ویدیویی برمی گرداند.
duplicate() Item یک کپی از این مورد ایجاد می کند و آن را به انتهای فرم اضافه می کند.
getHelpText() String متن راهنمای مورد را دریافت می‌کند (گاهی اوقات متن توضیحات برای موارد طرح‌بندی مانند ImageItems ، PageBreakItems و SectionHeaderItems نامیده می‌شود).
getId() Integer شناسه منحصر به فرد مورد را دریافت می کند.
getIndex() Integer نمایه مورد را از بین تمام موارد موجود در فرم دریافت می کند.
getTitle() String عنوان مورد را دریافت می کند (گاهی اوقات به آن متن سرصفحه می گویند، در مورد SectionHeaderItem ).
getType() ItemType نوع مورد را دریافت می کند که به صورت ItemType نمایش داده می شود.
setHelpText(text) Item متن راهنمای مورد را تنظیم می‌کند (گاهی اوقات متن توضیحات برای موارد طرح‌بندی مانند ImageItems ، PageBreakItems و SectionHeaderItems نامیده می‌شود).
setTitle(title) Item عنوان مورد را تنظیم می کند (گاهی اوقات به آن متن سرصفحه می گویند، در مورد SectionHeaderItem ).

مستندات دقیق

asCheckboxGridItem()

مورد را به عنوان یک مورد شبکه چک باکس برمی‌گرداند. در صورتی که ItemType قبلاً CHECKBOX_GRID نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

CheckboxGridItem - مورد شبکه چک باکس

پرتاب می کند

Error - اگر مورد یک مورد شبکه چک باکس نباشد

مجوز

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

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

asCheckboxItem()

مورد را به عنوان یک مورد چک باکس برمی گرداند. در صورتی که ItemType قبلاً CHECKBOX نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

CheckboxItem - مورد چک باکس

پرتاب می کند

Error - اگر مورد یک مورد چک باکس نباشد

مجوز

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

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

asDateItem()

مورد را به عنوان یک مورد تاریخ برمی‌گرداند. در صورتی که ItemType قبلاً DATE نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

DateItem - مورد تاریخ

پرتاب می کند

Error - اگر مورد مورد تاریخ نباشد

مجوز

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

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

asDateTimeItem()

مورد را به عنوان یک مورد تاریخ-زمان برمی‌گرداند. در صورتی که ItemType قبلاً DATETIME نبوده باشد، یک استثناء اسکریپت ایجاد می کند.

بازگشت

DateTimeItem - مورد تاریخ-زمان

پرتاب می کند

Error - اگر مورد یک مورد تاریخ-زمان نباشد

مجوز

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

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

asDurationItem()

مورد را به عنوان یک مورد مدت زمان برمی‌گرداند. در صورتی که ItemType قبلاً DURATION نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

DurationItem - مورد مدت

پرتاب می کند

Error - اگر مورد مورد مدت زمان نباشد

مجوز

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

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

asGridItem()

مورد را به عنوان یک مورد شبکه برمی گرداند. در صورتی که ItemType قبلا GRID نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

GridItem - مورد شبکه

پرتاب می کند

Error - اگر مورد یک مورد شبکه نیست

مجوز

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

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

asImageItem()

مورد را به عنوان یک آیتم تصویر برمی گرداند. در صورتی که ItemType قبلاً IMAGE نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

ImageItem - مورد تصویر

پرتاب می کند

Error - اگر مورد یک آیتم تصویری نباشد

asListItem()

مورد را به عنوان یک مورد لیست برمی گرداند. در صورتی که ItemType قبلاً LIST نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

ListItem - مورد فهرست

پرتاب می کند

Error - اگر مورد یک مورد فهرست نباشد

مجوز

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

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

asMultipleChoiceItem()

مورد را به عنوان یک مورد چند گزینه ای برمی گرداند. در صورتی که ItemType قبلاً MULTIPLE_CHOICE نبوده است، یک استثنای اسکریپت ایجاد می‌کند.

بازگشت

MultipleChoiceItem - مورد چند گزینه ای

پرتاب می کند

Error - اگر مورد یک مورد چند گزینه ای نباشد

مجوز

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

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

asPageBreakItem()

مورد را به عنوان یک مورد شکستگی صفحه برمی گرداند. در صورتی که ItemType قبلاً PAGE_BREAK نبوده است، یک استثنای اسکریپت ایجاد می کند.

بازگشت

PageBreakItem - مورد شکستن صفحه

پرتاب می کند

Error - اگر مورد مورد شکست صفحه نباشد

مجوز

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

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

asParagraphTextItem()

مورد را به عنوان یک پاراگراف-متن مورد برمی‌گرداند. در صورتی که ItemType قبلاً PARAGRAPH_TEXT نبوده است، یک استثنای اسکریپت ایجاد می کند.

بازگشت

ParagraphTextItem - مورد پاراگراف-متن

پرتاب می کند

Error - اگر مورد یک مورد متنی پاراگراف نباشد

مجوز

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

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

asScaleItem()

مورد را به عنوان یک مورد مقیاس برمی گرداند. در صورتی که ItemType قبلاً SCALE نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

ScaleItem - مورد مقیاس

پرتاب می کند

Error - اگر مورد یک مورد مقیاس نباشد

مجوز

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

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

asSectionHeaderItem()

مورد را به عنوان یک مورد سرفصل بخش برمی‌گرداند. در صورتی که ItemType قبلاً SECTION_HEADER نبوده است، یک استثناء اسکریپت ایجاد می‌کند.

بازگشت

SectionHeaderItem - مورد سرفصل بخش

پرتاب می کند

Error - اگر مورد یک مورد سرصفحه بخش نباشد

مجوز

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

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

asTextItem()

مورد را به عنوان یک مورد متنی برمی گرداند. در صورتی که ItemType قبلا TEXT نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

TextItem - مورد متنی

پرتاب می کند

Error - اگر مورد یک مورد متنی نباشد

مجوز

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

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

asTimeItem()

مورد را به عنوان آیتم زمانی برمی گرداند. در صورتی که ItemType قبلاً TIME نبوده است، یک استثناء اسکریپت ایجاد می کند.

بازگشت

TimeItem - آیتم زمان

پرتاب می کند

Error - اگر مورد مورد زمان نباشد

مجوز

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

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

asVideoItem()

مورد را به عنوان یک مورد ویدیویی برمی گرداند. در صورتی که ItemType قبلا VIDEO نبوده است، یک استثنای اسکریپت ایجاد می کند.

بازگشت

VideoItem - مورد ویدیویی

پرتاب می کند

Error - اگر مورد یک مورد ویدیویی نباشد

duplicate()

یک کپی از این مورد ایجاد می کند و آن را به انتهای فرم اضافه می کند.

بازگشت

Item - تکراری از این Item ، برای زنجیر کردن

مجوز

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

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

getHelpText()

متن راهنمای مورد را دریافت می‌کند (گاهی اوقات متن توضیحات برای موارد طرح‌بندی مانند ImageItems ، PageBreakItems و SectionHeaderItems نامیده می‌شود).

بازگشت

String - متن راهنمای مورد یا متن توضیحات

مجوز

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

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

getId()

شناسه منحصر به فرد مورد را دریافت می کند.

بازگشت

Integer - شناسه مورد

مجوز

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

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

getIndex()

نمایه مورد را از بین تمام موارد موجود در فرم دریافت می کند.

بازگشت

Integer - شاخص مورد

مجوز

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

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

getTitle()

عنوان مورد را دریافت می کند (گاهی اوقات به آن متن سرصفحه می گویند، در مورد SectionHeaderItem ).

بازگشت

String - عنوان یا متن سرصفحه مورد

مجوز

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

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

getType()

نوع مورد را دریافت می کند که به صورت ItemType نمایش داده می شود.

بازگشت

ItemType - نوع مورد

مجوز

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

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

setHelpText(text)

متن راهنمای مورد را تنظیم می‌کند (گاهی اوقات متن توضیحات برای موارد طرح‌بندی مانند ImageItems ، PageBreakItems و SectionHeaderItems نامیده می‌شود).

پارامترها

نام تایپ کنید توضیحات
text String متن راهنما جدید

بازگشت

Item - این Item ، برای زنجیر کردن

مجوز

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

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

setTitle(title)

عنوان مورد را تنظیم می کند (گاهی اوقات به آن متن سرصفحه می گویند، در مورد SectionHeaderItem ).

پارامترها

نام تایپ کنید توضیحات
title String عنوان یا متن سرصفحه جدید

بازگشت

Item - این Item ، برای زنجیر کردن

مجوز

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

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