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

Class PageBreakItem

Élément de mise en page qui marque le début d'une page. Vous pouvez accéder aux éléments ou en créer à partir d'un Form.

// Create a form and add three page-break items.
const form = FormApp.create('Form Name');
const pageTwo = form.addPageBreakItem().setTitle('Page Two');
const pageThree = form.addPageBreakItem().setTitle('Page Three');

// Make the first two pages navigate elsewhere upon completion.
pageTwo.setGoToPage(
    pageThree);  // At end of page one (start of page two), jump to page three
pageThree.setGoToPage(
    FormApp.PageNavigationType.RESTART);  // At end of page two, restart form

Méthodes

Méthode	Type renvoyé	Brève description
`duplicate()`	`PageBreakItem`	Crée une copie de cet élément et l'ajoute à la fin du formulaire.
`getGoToPage()`	`PageBreakItem`	Récupère l'`PageBreakItem` vers lequel le formulaire sautera après avoir terminé la page avant ce saut de page (c'est-à-dire, en atteignant ce saut de page par progression linéaire normale dans le 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.
`getPageNavigationType()`	`PageNavigationType`	Récupère le type de navigation de page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque vous atteignez ce saut de page par une progression linéaire normale dans le 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`.
`setGoToPage(goToPageItem)`	`PageBreakItem`	Définit la page à laquelle accéder après avoir terminé la page précédant ce saut de page (c'est-à-dire, lorsque vous atteignez ce saut de page par progression linéaire normale dans le formulaire).
`setGoToPage(navigationType)`	`PageBreakItem`	Définit le type de navigation de page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque vous atteignez ce saut de page par progression linéaire normale dans le formulaire).
`setHelpText(text)`	`PageBreakItem`	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)`	`PageBreakItem`	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

`duplicate()`

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

Renvois

PageBreakItem : double de cet élément PageBreakItem, 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

`getGoToPage()`

Récupère l'PageBreakItem vers laquelle le formulaire sautera après avoir terminé la page avant cette page de rupture (c'est-à-dire, en atteignant cette page de rupture par une progression linéaire normale dans le formulaire).

Renvois

PageBreakItem : saut de page vers lequel accéder après avoir terminé la page précédant ce saut de page, ou null si aucun n'est défini

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

`getPageNavigationType()`

Récupère le type de navigation de page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque vous atteignez ce saut de page par une progression linéaire normale dans le formulaire).

Renvois

PageNavigationType : action de navigation à effectuer après avoir terminé la page avant ce 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

`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

`setGoToPage(goToPageItem)`

Définit la page à laquelle accéder après avoir terminé la page précédant ce saut de page (c'est-à-dire, lorsque vous atteignez ce saut de page par progression linéaire normale dans le formulaire). Si la page précédente contenait un MultipleChoiceItem ou un ListItem avec une option de navigation, cette navigation remplace cette navigation.

Paramètres

Nom	Type	Description
`goToPageItem`	`PageBreakItem`	le saut de page vers lequel vous devez accéder après avoir terminé la page précédant ce saut de page

Renvois

PageBreakItem : PageBreakItem, 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

`setGoToPage(navigationType)`

Définit le type de navigation de page qui se produit après avoir terminé la page avant ce saut de page (c'est-à-dire lorsque vous atteignez ce saut de page par progression linéaire normale dans le formulaire). Si la page contenait un MultipleChoiceItem ou un ListItem avec une option de navigation, cette navigation remplace cette navigation.

Paramètres

Nom	Type	Description
`navigationType`	`PageNavigationType`	l'action de navigation à effectuer après avoir terminé la page avant ce saut de page ;

Renvois

PageBreakItem : PageBreakItem, 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

`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

PageBreakItem : PageBreakItem, 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

PageBreakItem : PageBreakItem, 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