Class PageBreakItem

PageBreakItem

ページの始点を示すレイアウト アイテム。アイテムは Form からアクセスまたは作成できます。

// Create a form and add three page-break items.
var form = FormApp.create('Form Name');
var pageTwo = form.addPageBreakItem().setTitle('Page Two');
var 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

Methods

メソッド戻り値の型概要
duplicate()PageBreakItemこのアイテムのコピーを作成して、フォームの末尾に追加します。
getGoToPage()PageBreakItem改ページの前にページを完了した後(つまり、フォームでの通常の線形進行によってこの改ページに到達したとき)にフォームがジャンプする PageBreakItem を取得します。
getHelpText()Stringアイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を取得します。
getId()Integerアイテムの一意の識別子を取得します。
getIndex()Integerフォーム内のすべてのアイテムの中でアイテムのインデックスを取得します。
getPageNavigationType()PageNavigationType改ページの前にページを完了した後(つまり、フォームからの通常の直線的な進行によってこの改ページに到達したとき)に発生したページ ナビゲーションのタイプを取得します。
getTitle()Stringアイテムのタイトル(SectionHeaderItem の場合にヘッダー テキストとも呼ばれます)を取得します。
getType()ItemTypeItemType で表されるアイテムのタイプを取得します。
setGoToPage(goToPageItem)PageBreakItem改ページの前に(つまり、フォームでの通常の直線的な進行でこのページ区切りに達したときに)改ページした後にジャンプするページを設定します。
setGoToPage(navigationType)PageBreakItem改ページの前にページを完了した後(つまり、フォームからの通常の直線的な進行でこのページ区切りに達したとき)に行われるページ ナビゲーションのタイプを設定します。
setHelpText(text)PageBreakItemアイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を設定します。
setTitle(title)PageBreakItemアイテムのタイトル(SectionHeaderItem ではヘッダー テキストとも呼ばれます)を設定します。

詳細なドキュメント

duplicate()

このアイテムのコピーを作成して、フォームの末尾に追加します。

リターン

PageBreakItem - この PageBreakItem の重複(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getGoToPage()

改ページの前にページを完了した後(つまり、フォームでの通常の線形進行によってこの改ページに到達したとき)にフォームがジャンプする PageBreakItem を取得します。

リターン

PageBreakItem - 改ページの前にページを完了した後に移動する改ページ。何も設定されていない場合は null

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getHelpText()

アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を取得します。

リターン

String - アイテムのヘルプテキストまたは説明テキスト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getId()

アイテムの一意の識別子を取得します。

リターン

Integer - 商品アイテムの ID

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getIndex()

フォーム内のすべてのアイテムの中でアイテムのインデックスを取得します。

リターン

Integer - アイテムのインデックス

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getPageNavigationType()

改ページの前にページを完了した後(つまり、フォームからの通常の直線的な進行によってこの改ページに到達したとき)に発生したページ ナビゲーションのタイプを取得します。

リターン

PageNavigationType - ページの読み込み完了後にこの改ページの前に実行するナビゲーション アクション

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getTitle()

アイテムのタイトル(SectionHeaderItem の場合にヘッダー テキストとも呼ばれます)を取得します。

リターン

String - アイテムのタイトルまたはヘッダー テキスト

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

getType()

ItemType で表されるアイテムのタイプを取得します。

リターン

ItemType - アイテムのタイプ

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setGoToPage(goToPageItem)

改ページの前に(つまり、フォームでの通常の直線的な進行でこのページ区切りに達したときに)改ページした後にジャンプするページを設定します。前のページにナビゲーション オプション付き MultipleChoiceItem または ListItem が含まれていた場合、そのナビゲーションがこのナビゲーションよりも優先されます。

パラメータ

名前説明
goToPageItemPageBreakItem改ページする前にページ完了後にジャンプする改ページ

リターン

PageBreakItem - この PageBreakItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setGoToPage(navigationType)

改ページの前にページを完了した後(つまり、フォームからの通常の直線的な進行でこのページ区切りに達したとき)に行われるページ ナビゲーションのタイプを設定します。ページにナビゲーション オプション付きの MultipleChoiceItem または ListItem が含まれている場合、そのナビゲーションがこのナビゲーションよりも優先されます。

パラメータ

名前説明
navigationTypePageNavigationTypeページを完成した後、この改ページの前に実行するナビゲーション アクション

リターン

PageBreakItem - この PageBreakItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setHelpText(text)

アイテムのヘルプテキスト(ImageItemsPageBreakItemsSectionHeaderItems などのレイアウト アイテムの説明テキスト)を設定します。

パラメータ

名前説明
textString新しいヘルプテキスト

リターン

PageBreakItem - この PageBreakItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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

setTitle(title)

アイテムのタイトル(SectionHeaderItem ではヘッダー テキストとも呼ばれます)を設定します。

パラメータ

名前説明
titleString新しいタイトルまたはヘッダー テキスト

リターン

PageBreakItem - この PageBreakItem(チェーン用)

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

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