Class ImageItem

  • An ImageItem is a layout item within Google Forms that displays an image, accessible and modifiable through Apps Script.

  • You can programmatically add an ImageItem to a form, setting its title, help text, and image using the addImageItem() method and associated properties.

  • ImageItem provides various methods to manipulate its properties such as alignment, help text, image source, title, and width, as well as methods to duplicate and access item details.

  • Each method and property of ImageItem requires specific authorization scopes, primarily https://www.googleapis.com/auth/forms.currentonly or https://www.googleapis.com/auth/forms, for scripts to execute successfully.
ImageItem

A layout item that displays an image. Items can be accessed or created from a Form . 

// Open a form by ID and add a new image item
constform=FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
constimg=UrlFetchApp.fetch('https://www.google.com/images/srpr/logo4w.png');
form.addImageItem()
.setTitle('Google')
.setHelpText('Google Logo')// The help text is the image description
.setImage(img);

Methods

MethodReturn typeBrief description
duplicate() ImageItem Creates a copy of this item and appends it to the end of the form.
getAlignment() Alignment Gets the image's horizontal alignment.
getHelpText() StringGets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ).
getId() IntegerGets the item's unique identifier.
getImage() Blob Gets the image that is currently assigned to the item.
getIndex() IntegerGets the index of the item among all the items in the form.
getTitle() StringGets the item's title (sometimes called header text, in the case of a SectionHeaderItem ).
getType() ItemType Gets the item's type, represented as an ItemType .
getWidth() IntegerGets the image's width in pixels.
setAlignment(alignment) ImageItem Sets the image's horizontal alignment.
setHelpText(text) ImageItem Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ).
setImage(image) ImageItem Sets the image itself.
setTitle(title) ImageItem Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ).
setWidth(width) ImageItem Sets the image's width in pixels.

Detailed documentation

duplicate()

Creates a copy of this item and appends it to the end of the form.

Return

ImageItem — a duplicate of this ImageItem , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getAlignment()

Gets the image's horizontal alignment.

Return

Alignment — the horizontal alignment

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getHelpText()

Gets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ).

Return

String — the item's help text or description text

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getId()

Gets the item's unique identifier.

Return

Integer — the item's ID

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getImage()

Gets the image that is currently assigned to the item.

Return

Blob — the image data

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getIndex()

Gets the index of the item among all the items in the form.

Return

Integer — the index of the item

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getTitle()

Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem ).

Return

String — the item's title or header text

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getType()

Gets the item's type, represented as an ItemType .

Return

ItemType — the item's type

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

getWidth()

Gets the image's width in pixels.

Return

Integer — the width in pixels

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setAlignment(alignment)

Sets the image's horizontal alignment.

Parameters

NameTypeDescription
alignmentAlignment the horizontal alignment

Return

ImageItem — this ImageItem , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setHelpText(text)

Sets the item's help text (sometimes called description text for layout items like ImageItems , PageBreakItems , and SectionHeaderItems ).

Parameters

NameTypeDescription
textStringthe new help text

Return

ImageItem — this ImageItem , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setImage(image)

Sets the image itself.

Parameters

NameTypeDescription
imageBlobSource the image data

Return

ImageItem — this ImageItem , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setTitle(title)

Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem ).

Parameters

NameTypeDescription
titleStringthe new title or header text

Return

ImageItem — this ImageItem , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

setWidth(width)

Sets the image's width in pixels. Only the image's width can be set. Height is set automatically to maintain the image's proportions.

Parameters

NameTypeDescription
widthIntegerthe width in pixels

Return

ImageItem — this ImageItem , for chaining

Authorization

Scripts that use this method require authorization with one or more of the following scopes:

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

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024年12月02日 UTC.