Interface Item

Elemento

Un elemento de formulario genérico que contiene propiedades comunes a todos los elementos, como el título y el texto de ayuda. Se puede acceder a los elementos o crearlos desde un Form.

Para operar en propiedades específicas de un tipo, usa getType() para verificar el ItemType del elemento y, luego, transmite el elemento al clase adecuada con un método como 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);
}

Cómo implementar clases

NombreDescripción breve

Métodos

MétodoTipo de datos que se muestraDescripción breve
asCheckboxGridItem()CheckboxGridItemMuestra el elemento como un elemento de la cuadrícula de casilla de verificación.
asCheckboxItem()CheckboxItemDevuelve el elemento como un elemento de casilla de verificación.
asDateItem()DateItemDevuelve el elemento como un elemento de fecha.
asDateTimeItem()DateTimeItemMuestra el elemento como un elemento de fecha y hora.
asDurationItem()DurationItemMuestra el elemento como elemento de duración.
asGridItem()GridItemMuestra el elemento como un elemento de cuadrícula.
asImageItem()ImageItemDevuelve el elemento como un elemento de imagen.
asListItem()ListItemMuestra el elemento como un elemento de lista.
asMultipleChoiceItem()MultipleChoiceItemDevuelve el elemento como un elemento de opción múltiple.
asPageBreakItem()PageBreakItemDevuelve el elemento como un elemento de salto de página.
asParagraphTextItem()ParagraphTextItemMuestra el elemento como un elemento de texto de párrafo.
asScaleItem()ScaleItemMuestra el elemento como un elemento de escala.
asSectionHeaderItem()SectionHeaderItemDevuelve el elemento como un elemento de encabezado de sección.
asTextItem()TextItemMuestra el elemento como un elemento de texto.
asTimeItem()TimeItemDevuelve el elemento como un elemento de tiempo.
asVideoItem()VideoItemDevuelve el elemento como uno de video.
duplicate()ItemCrea una copia de este elemento y la agrega al final del formulario.
getHelpText()StringObtiene el texto de ayuda del elemento (a veces llamado texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).
getId()IntegerObtiene el identificador único del elemento.
getIndex()IntegerObtiene el índice del elemento entre todos los elementos del formulario.
getTitle()StringObtiene el título del elemento (a veces llamado texto de encabezado, en el caso de un SectionHeaderItem).
getType()ItemTypeObtiene el tipo del elemento, representado como un ItemType.
setHelpText(text)ItemEstablece el texto de ayuda del elemento (a veces llamado texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).
setTitle(title)ItemEstablece el título del elemento (a veces llamado texto de encabezado, en el caso de un SectionHeaderItem).

Documentación detallada

asCheckboxGridItem()

Muestra el elemento como un elemento de la cuadrícula de casilla de verificación. Muestra una excepción de secuencia de comandos si ItemType todavía no era CHECKBOX_GRID.

Volver

CheckboxGridItem: Es el elemento de cuadrícula de la casilla de verificación.

Arroja

Error: Si el elemento no es un elemento de cuadrícula de la casilla de verificación

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asCheckboxItem()

Devuelve el elemento como un elemento de casilla de verificación. Muestra una excepción de secuencia de comandos si ItemType todavía no era CHECKBOX.

Volver

CheckboxItem: Es el elemento de la casilla de verificación.

Arroja

Error: Si el elemento no es un elemento de casilla de verificación.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asDateItem()

Devuelve el elemento como un elemento de fecha. Muestra una excepción de secuencia de comandos si ItemType todavía no era DATE.

Volver

DateItem: Es el elemento de fecha.

Arroja

Error: Si el elemento no es un elemento de fecha.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asDateTimeItem()

Muestra el elemento como un elemento de fecha y hora. Muestra una excepción de secuencia de comandos si ItemType todavía no era DATETIME.

Volver

DateTimeItem: Es el elemento de fecha y hora.

Arroja

Error: Si el elemento no es un elemento de fecha y hora

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asDurationItem()

Muestra el elemento como elemento de duración. Muestra una excepción de secuencia de comandos si ItemType todavía no era DURATION.

Volver

DurationItem: Es el elemento de duración.

Arroja

Error: Si el elemento no es un elemento de duración.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asGridItem()

Muestra el elemento como un elemento de cuadrícula. Muestra una excepción de secuencia de comandos si ItemType todavía no era GRID.

Volver

GridItem: Es el elemento de cuadrícula.

Arroja

Error: Si el elemento no es un elemento de cuadrícula

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asImageItem()

Devuelve el elemento como un elemento de imagen. Muestra una excepción de secuencia de comandos si ItemType todavía no era IMAGE.

Volver

ImageItem: Es el elemento de imagen.

Arroja

Error: Si el elemento no es un elemento de imagen.


asListItem()

Muestra el elemento como un elemento de lista. Muestra una excepción de secuencia de comandos si ItemType todavía no era LIST.

Volver

ListItem: Es el elemento de la lista.

Arroja

Error: Si el elemento no es un elemento de lista

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asMultipleChoiceItem()

Devuelve el elemento como un elemento de opción múltiple. Muestra una excepción de secuencia de comandos si ItemType todavía no era MULTIPLE_CHOICE.

Volver

MultipleChoiceItem: Es el elemento de opción múltiple.

Arroja

Error: Si el elemento no es de opción múltiple

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asPageBreakItem()

Devuelve el elemento como un elemento de salto de página. Muestra una excepción de secuencia de comandos si ItemType todavía no era PAGE_BREAK.

Volver

PageBreakItem: Es el elemento de salto de página.

Arroja

Error: Si el elemento no es un elemento de salto de página.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asParagraphTextItem()

Muestra el elemento como un elemento de texto de párrafo. Muestra una excepción de secuencia de comandos si ItemType todavía no era PARAGRAPH_TEXT.

Volver

ParagraphTextItem: Es el elemento de texto de párrafo.

Arroja

Error: Si el elemento no es un elemento de texto de un párrafo.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asScaleItem()

Muestra el elemento como un elemento de escala. Muestra una excepción de secuencia de comandos si ItemType todavía no era SCALE.

Volver

ScaleItem: Es el elemento de escala.

Arroja

Error: Si el elemento no es un elemento de escala

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asSectionHeaderItem()

Devuelve el elemento como un elemento de encabezado de sección. Muestra una excepción de secuencia de comandos si ItemType todavía no era SECTION_HEADER.

Volver

SectionHeaderItem: Es el elemento de encabezado de la sección.

Arroja

Error: Si el elemento no es un elemento de encabezado de sección

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asTextItem()

Muestra el elemento como un elemento de texto. Muestra una excepción de secuencia de comandos si ItemType todavía no era TEXT.

Volver

TextItem: Es el elemento de texto.

Arroja

Error: Si el elemento no es un elemento de texto.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asTimeItem()

Devuelve el elemento como un elemento de tiempo. Muestra una excepción de secuencia de comandos si ItemType todavía no era TIME.

Volver

TimeItem: Es el elemento de tiempo.

Arroja

Error: Si el elemento no es un elemento de tiempo

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

asVideoItem()

Devuelve el elemento como uno de video. Muestra una excepción de secuencia de comandos si ItemType todavía no era VIDEO.

Volver

VideoItem: Es el elemento de video.

Arroja

Error: Si el elemento no es un elemento de video


duplicate()

Crea una copia de este elemento y la agrega al final del formulario.

Volver

Item: Es un duplicado de este Item, para el encadenamiento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getHelpText()

Obtiene el texto de ayuda del elemento (a veces llamado texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).

Volver

String: Es el texto de ayuda o descripción del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getId()

Obtiene el identificador único del elemento.

Volver

Integer: Es el ID del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getIndex()

Obtiene el índice del elemento entre todos los elementos del formulario.

Volver

Integer: Es el índice del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getTitle()

Obtiene el título del elemento (a veces llamado texto de encabezado, en el caso de un SectionHeaderItem).

Volver

String: Es el título o texto del encabezado del elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

getType()

Obtiene el tipo del elemento, representado como un ItemType.

Volver

ItemType: Es el tipo de elemento.

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setHelpText(text)

Establece el texto de ayuda del elemento (a veces llamado texto de descripción para elementos de diseño como ImageItems, PageBreakItems y SectionHeaderItems).

Parámetros

NombreTipoDescripción
textStringel nuevo texto de ayuda

Volver

Item: este Item, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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

setTitle(title)

Establece el título del elemento (a veces llamado texto de encabezado, en el caso de un SectionHeaderItem).

Parámetros

NombreTipoDescripción
titleStringel nuevo título o texto del encabezado

Volver

Item: este Item, para encadenamiento

Autorización

Las secuencias de comandos que usan este método requieren autorización con uno o más de los siguientes alcances:

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