Cette page a été traduite par l'API Cloud Translation.

Interface Item

É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 à partir d'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 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.
const form = FormApp.create('Form Name');
form.addTextItem();

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

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

Implémenter des classes

Nom	Brève description

Méthodes

Méthode	Type renvoyé	Brève description
`asCheckboxGridItem()`	`CheckboxGridItem`	Renvoie l'élément sous forme d'élément de grille de case à cocher.
`asCheckboxItem()`	`CheckboxItem`	Renvoie l'élément sous forme de case à cocher.
`asDateItem()`	`DateItem`	Renvoie l'élément en tant qu'élément de date.
`asDateTimeItem()`	`DateTimeItem`	Renvoie l'élément sous la forme d'un élément de date et d'heure.
`asDurationItem()`	`DurationItem`	Renvoie l'élément en tant qu'élément de durée.
`asGridItem()`	`GridItem`	Renvoie l'élément en tant qu'élément de grille.
`asImageItem()`	`ImageItem`	Renvoie l'élément en tant qu'élément image.
`asListItem()`	`ListItem`	Renvoie l'élément sous forme d'élément de liste.
`asMultipleChoiceItem()`	`MultipleChoiceItem`	Renvoie l'élément sous forme de question à choix multiples.
`asPageBreakItem()`	`PageBreakItem`	Renvoie l'élément en tant qu'élément de page de rupture.
`asParagraphTextItem()`	`ParagraphTextItem`	Renvoie l'élément sous forme de texte de paragraphe.
`asScaleItem()`	`ScaleItem`	Renvoie l'élément en tant qu'élément de mise à l'échelle.
`asSectionHeaderItem()`	`SectionHeaderItem`	Renvoie l'élément en tant qu'élément de titre de section.
`asTextItem()`	`TextItem`	Renvoie l'élément sous forme d'élément textuel.
`asTimeItem()`	`TimeItem`	Renvoie l'élément sous la forme d'un élément temporel.
`asVideoItem()`	`VideoItem`	Renvoie l'élément en tant qu'élément vidéo.
`duplicate()`	`Item`	Crée une copie de cet élément et l'ajoute à la fin du formulaire.
`getHelpText()`	`String`	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`).
`getId()`	`Integer`	Récupère l'identifiant unique de l'élément.
`getIndex()`	`Integer`	Récupère l'indice de l'élément parmi tous les éléments du formulaire.
`getTitle()`	`String`	Récupère le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un `SectionHeaderItem`).
`getType()`	`ItemType`	Récupère le type de l'élément, représenté par un `ItemType`.
`setHelpText(text)`	`Item`	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`).
`setTitle(title)`	`Item`	Définit le titre de l'élément (parfois appelé "texte d'en-tête", dans le cas d'un `SectionHeaderItem`).

Documentation détaillée

`asCheckboxGridItem()`

Renvoie l'élément sous forme d'élément de grille de 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 cases à cocher

Génère

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 forme de case à cocher. Génère une exception de script si l'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 avec 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. Génère une exception de script si l'ItemType n'était pas déjà DATE.

Renvois

DateItem : élément de date

Génère

Error : si l'élément n'est pas une date

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 sous la forme d'un élément de date et d'heure. Génère une exception de script si l'ItemType n'était pas déjà DATETIME.

Renvois

DateTimeItem : élément date et heure

Génère

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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. Génère une exception de script si l'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 avec 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 en tant qu'élément de grille. Génère une exception de script si l'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 avec 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 l'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 forme d'élément de liste. Génère une exception de script si l'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 avec 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 sous forme de question à choix multiples. Génère une exception de script si l'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 avec 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 page de rupture. Génère une exception de script si l'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 avec 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 l'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 avec 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. Génère une exception de script si l'ItemType n'était pas déjà SCALE.

Renvois

ScaleItem : élément d'échelle

Génère

Error : si l'élément n'est pas une échelle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 de titre de section. Génère une exception de script si ItemType n'était pas déjà SECTION_HEADER.

Renvois

SectionHeaderItem : élément "section-header"

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 avec 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 l'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 de texte

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 sous la forme d'un élément temporel. Génère une exception de script si l'ItemType n'était pas déjà TIME.

Renvois

TimeItem : élément d'heure

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 avec 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 l'ItemType n'était pas déjà VIDEO.

Renvois

VideoItem : élément vidéo

Génère

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

`duplicate()`

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

Renvois

Item : double de cet élément Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 de description de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'article

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'indice 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 avec 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'un SectionHeaderItem).

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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 un ItemType.

Renvois

ItemType : type de l'élément

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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

Nom	Type	Description
`text`	`String`	le nouveau texte d'aide ;

Renvois

Item : Item, pour le chaînage

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec 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'un SectionHeaderItem).

Paramètres

Nom	Type	Description
`title`	`String`	le nouveau titre ou le nouveau texte de l'en-tête ;

Renvois

Item : Item, pour le chaînage

Autorisation

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

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