Interface Item

Élément

Élément de formulaire générique contenant des propriétés communes à tous les éléments, telles que le titre et le texte d'aide. Les éléments sont accessibles et accessibles depuis un Form.

Pour effectuer des opérations sur des propriétés spécifiques au type, utilisez getType() pour vérifier le ItemType de l'élément, puis castez celui-ci dans la 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 forme de grille à cases à cocher.
asCheckboxItem()CheckboxItemRenvoie l'élément sous la forme d'une case à cocher.
asDateItem()DateItemRenvoie l'élément en tant qu'élément de date.
asDateTimeItem()DateTimeItemRenvoie l'élément en tant qu'élément date-heure.
asDurationItem()DurationItemRenvoie l'élément en tant qu'é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 en tant qu'élément de liste.
asMultipleChoiceItem()MultipleChoiceItemRenvoie l'article en tant qu'article à choix multiples.
asPageBreakItem()PageBreakItemRenvoie l'élément en tant qu'élément de saut de page.
asParagraphTextItem()ParagraphTextItemRenvoie l'élément sous forme de paragraphe.
asScaleItem()ScaleItemRenvoie l'élément en tant qu'élément de mise à l'échelle.
asSectionHeaderItem()SectionHeaderItemRenvoie l'élément en tant qu'élément d'en-tête de section.
asTextItem()TextItemRenvoie l'élément en tant qu'élément textuel.
asTimeItem()TimeItemRenvoie l'élément en tant qu'élément de temps.
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'élément.
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 d'é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 propriété SectionHeaderItem).

Documentation détaillée

asCheckboxGridItem()

Renvoie l'élément sous forme de grille à cases à cocher. La fonction renvoie une exception de script si ItemType n'était pas déjà CHECKBOX_GRID.

Renvois

CheckboxGridItem : élément de grille à cases à 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 correspondant à 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 sous la forme d'une case à cocher. La fonction renvoie 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 une case à cocher

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 en tant qu'élément de date. La fonction renvoie 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 correspondant à 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. La fonction renvoie une exception de script si ItemType n'était pas déjà DATETIME.

Renvois

DateTimeItem : élément de date et heure

Génère

Error : si l'élément n'est pas un élément de type date/heure.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 en tant qu'élément de durée. La fonction renvoie 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 un élément de durée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. La fonction renvoie 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 correspondant à 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. La fonction renvoie 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 en tant qu'élément de liste. La fonction renvoie une exception de script si ItemType n'était pas déjà LIST.

Renvois

ListItem : élément de 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 correspondant à un ou plusieurs des champs d'application suivants:

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

asMultipleChoiceItem()

Renvoie l'article en tant qu'article à choix multiples. La fonction renvoie une exception de script si ItemType n'était pas déjà MULTIPLE_CHOICE.

Renvois

MultipleChoiceItem : élément à choix multiples

Génère

Error : si l'élément n'est pas un élément à choix multiples

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. La fonction renvoie 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 : si l'élément n'est pas un élément de saut de page

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 de paragraphe. La fonction renvoie 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 correspondant à 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 mise à l'échelle. La fonction renvoie 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 correspondant à 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 en tant qu'élément d'en-tête de section. La fonction renvoie une exception de script si ItemType n'était pas déjà SECTION_HEADER.

Renvois

SectionHeaderItem : élément d'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 correspondant à 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 en tant qu'élément textuel. La fonction renvoie 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 correspondant à 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 de temps. La fonction renvoie une exception de script si ItemType n'était pas déjà TIME.

Renvois

TimeItem : élément de temps

Génère

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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. La fonction renvoie 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 Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à 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'élément.

Renvois

Integer : ID de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 correspondant à 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 correspondant à 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 d'é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 correspondant à 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 : Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 propriété SectionHeaderItem).

Paramètres

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

Renvois

Item : Item, pour le chaînage

Autorisation

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

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