Interface Item

Élément

Élément de formulaire générique contenant des propriétés communes à tous les éléments, comme le titre et le texte d'aide. Vous pouvez accéder aux éléments ou en créer depuis une Form.

Pour effectuer des opérations sur des propriétés spécifiques au type, utilisez getType() pour vérifier la ItemType de l'élément, puis castez l'élément dans la classe appropriée à l'aide d'une méthode telle que 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);
}

Implémenter des classes

NomBrève description

Méthodes

MéthodeType renvoyéBrève description
asCheckboxGridItem()CheckboxGridItemRenvoie l'élément sous la forme d'un élément de grille de type case à cocher.
asCheckboxItem()CheckboxItemRenvoie l'élément en tant qu'élément de case à cocher.
asDateItem()DateItemRenvoie l'élément sous forme d'élément de date.
asDateTimeItem()DateTimeItemRenvoie l'élément en tant qu'élément date/heure.
asDurationItem()DurationItemRenvoie l'élément sous forme d'élément de durée.
asGridItem()GridItemRenvoie l'élément sous forme d'élément de grille.
asImageItem()ImageItemRenvoie l'élément en tant qu'élément image.
asListItem()ListItemRenvoie l'élément sous la forme d'un élément de liste.
asMultipleChoiceItem()MultipleChoiceItemRenvoie l'élément en tant qu'élément à choix multiples.
asPageBreakItem()PageBreakItemRenvoie l'élément en tant qu'élément de saut de page.
asParagraphTextItem()ParagraphTextItemRenvoie l'élément sous forme d'élément de texte de paragraphe.
asScaleItem()ScaleItemRenvoie l'élément en tant qu'élément de scaling.
asSectionHeaderItem()SectionHeaderItemRenvoie l'élément sous la forme d'un élément d'en-tête de section.
asTextItem()TextItemRenvoie l'élément sous forme d'élément textuel.
asTimeItem()TimeItemRenvoie l'élément en tant qu'élément temporel.
asVideoItem()VideoItemRenvoie l'élément en tant qu'élément vidéo.
duplicate()ItemCrée une copie de cet élément et l'ajoute à la fin du formulaire.
getHelpText()StringRécupère le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
getId()IntegerRécupère l'identifiant unique de l'article.
getIndex()IntegerRécupère l'index de l'élément parmi tous les éléments du formulaire.
getTitle()StringRécupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).
getType()ItemTypeRécupère le type de l'élément, représenté par ItemType.
setHelpText(text)ItemDéfinit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).
setTitle(title)ItemDéfinit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

Documentation détaillée

asCheckboxGridItem()

Renvoie l'élément sous la forme d'un élément de grille de type case à cocher. Génère une exception de script si ItemType n'était pas déjà CHECKBOX_GRID.

Renvois

CheckboxGridItem : élément de grille de type case à cocher

Génère

Error : si l'élément n'est pas un élément de grille à cases à cocher

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asCheckboxItem()

Renvoie l'élément en tant qu'élément de case à cocher. Génère une exception de script si ItemType n'était pas déjà CHECKBOX.

Renvois

CheckboxItem : élément de la case à cocher

Génère

Error : si l'élément n'est pas un élément de case à cocher

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asDateItem()

Renvoie l'élément sous forme d'élément de date. Génère une exception de script si ItemType n'était pas déjà DATE.

Renvois

DateItem : élément de date

Génère

Error : si l'élément n'est pas un élément de date

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asDateTimeItem()

Renvoie l'élément en tant qu'élément date/heure. Génère une exception de script si ItemType n'était pas déjà DATETIME.

Renvois

DateTimeItem : élément de date et d'heure

Génère

Error : s'il ne s'agit pas d'un élément de type date/heure

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asDurationItem()

Renvoie l'élément sous forme d'élément de durée. Génère une exception de script si ItemType n'était pas déjà DURATION.

Renvois

DurationItem : élément de durée

Génère

Error : si l'élément n'est pas de durée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asGridItem()

Renvoie l'élément sous forme d'élément de grille. Génère une exception de script si ItemType n'était pas déjà GRID.

Renvois

GridItem : élément de grille

Génère

Error : si l'élément n'est pas un élément de grille

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asImageItem()

Renvoie l'élément en tant qu'élément image. Génère une exception de script si ItemType n'était pas déjà IMAGE.

Renvois

ImageItem : élément image

Génère

Error : si l'élément n'est pas un élément image


asListItem()

Renvoie l'élément sous la forme d'un élément de liste. Génère une exception de script si ItemType n'était pas déjà LIST.

Renvois

ListItem : élément de la liste

Génère

Error : si l'élément n'est pas un élément de liste

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asMultipleChoiceItem()

Renvoie l'élément en tant qu'élément à choix multiples. Génère une exception de script si ItemType n'était pas déjà MULTIPLE_CHOICE.

Renvois

MultipleChoiceItem : question à choix multiples

Génère

Error : s'il ne s'agit pas d'un élément à choix multiples

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asPageBreakItem()

Renvoie l'élément en tant qu'élément de saut de page. Génère une exception de script si ItemType n'était pas déjà PAGE_BREAK.

Renvois

PageBreakItem : élément de saut de page

Génère

Error : s'il ne s'agit pas d'un saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asParagraphTextItem()

Renvoie l'élément sous forme d'élément de texte de paragraphe. Génère une exception de script si ItemType n'était pas déjà PARAGRAPH_TEXT.

Renvois

ParagraphTextItem : élément de texte de paragraphe

Génère

Error : si l'élément n'est pas un élément de texte de paragraphe

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asScaleItem()

Renvoie l'élément en tant qu'élément de scaling. Génère une exception de script si ItemType n'était pas déjà SCALE.

Renvois

ScaleItem : élément de mise à l'échelle

Génère

Error : si l'élément n'est pas un élément de mise à l'échelle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asSectionHeaderItem()

Renvoie l'élément sous la forme d'un élément d'en-tête de section. Génère une exception de script si ItemType n'était pas déjà SECTION_HEADER.

Renvois

SectionHeaderItem : élément de l'en-tête de section

Génère

Error : si l'élément n'est pas un élément d'en-tête de section

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asTextItem()

Renvoie l'élément sous forme d'élément textuel. Génère une exception de script si ItemType n'était pas déjà TEXT.

Renvois

TextItem : élément textuel

Génère

Error : si l'élément n'est pas un élément textuel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asTimeItem()

Renvoie l'élément en tant qu'élément temporel. Génère une exception de script si ItemType n'était pas déjà TIME.

Renvois

TimeItem : élément temporel

Génère

Error : si l'élément n'est pas un élément temporel

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

asVideoItem()

Renvoie l'élément en tant qu'élément vidéo. Génère une exception de script si ItemType n'était pas déjà VIDEO.

Renvois

VideoItem : élément vidéo

Génère

Error : si l'élément n'est pas un élément vidéo


duplicate()

Crée une copie de cet élément et l'ajoute à la fin du formulaire.

Renvois

Item : doublon de ce Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getHelpText()

Récupère le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Renvois

String : texte d'aide ou description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getId()

Récupère l'identifiant unique de l'article.

Renvois

Integer : ID de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getIndex()

Récupère l'index de l'élément parmi tous les éléments du formulaire.

Renvois

Integer : index de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getTitle()

Récupère le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

Renvois

String : titre ou texte d'en-tête de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

getType()

Récupère le type de l'élément, représenté par ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setHelpText(text)

Définit le texte d'aide de l'élément (parfois appelé texte de description pour les éléments de mise en page tels que ImageItems, PageBreakItems et SectionHeaderItems).

Paramètres

NomTypeDescription
textStringle nouveau texte d'aide

Renvois

Item : cette Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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

setTitle(title)

Définit le titre de l'élément (parfois appelé texte d'en-tête, dans le cas d'une SectionHeaderItem).

Paramètres

NomTypeDescription
titleStringle nouveau titre ou texte de l'en-tête

Renvois

Item : cette Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à un ou plusieurs des champs d'application suivants:

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