Questa pagina è stata tradotta dall'API Cloud Translation.

Class Ui

Un'istanza dell'ambiente di interfaccia utente per un'app Google che consente allo script di aggiungere come menu, finestre di dialogo e barre laterali. Uno script può interagire con l'interfaccia utente solo attuale di un editor aperto e solo se lo script è associato a un container all'editor.

// Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The
// user can also close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response.getSelectedButton() == ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() == ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Proprietà

Proprietà	Tipo	Descrizione
`Button`	`Button`	Un'enumerazione che rappresenta i pulsanti di dialogo localizzati e predeterminati restituiti da un avviso oppure `PromptResponse.getSelectedButton()` per indicare il pulsante in una finestra di dialogo su cui l'utente ha fatto clic.
`ButtonSet`	`ButtonSet`	Un'enumerazione che rappresenta insiemi predeterminati e localizzati di uno o più pulsanti di dialogo che possono essere a un avviso o a una richiesta di conferma.

Metodi

Metodo	Tipo restituito	Breve descrizione
`alert(prompt)`	`Button`	Apre una finestra di dialogo nell'editor dell'utente con il messaggio specificato e un "OK" .
`alert(prompt, buttons)`	`Button`	Apre una finestra di dialogo nell'editor dell'utente con il messaggio e la serie di pulsanti specificati.
`alert(title, prompt, buttons)`	`Button`	Apre una finestra di dialogo nell'editor dell'utente con il titolo, il messaggio e la serie di pulsanti specificati.
`createAddonMenu()`	`Menu`	Crea uno strumento di creazione utilizzabile per inserire un sottomenu nel menu Estensioni dell'editor.
`createMenu(caption)`	`Menu`	Crea un builder da utilizzare per aggiungere un menu all'interfaccia utente dell'editor.
`prompt(prompt)`	`PromptResponse`	Apre una finestra di dialogo di immissione nell'editor dell'utente con il messaggio specificato e un "OK" .
`prompt(prompt, buttons)`	`PromptResponse`	Apre una finestra di dialogo di immissione nell'editor dell'utente con il messaggio e la serie di pulsanti specificati.
`prompt(title, prompt, buttons)`	`PromptResponse`	Apre una finestra di dialogo di inserimento nell'editor dell'utente con il titolo, il messaggio e l'insieme specificati pulsanti.
`showModalDialog(userInterface, title)`	`void`	Apre una finestra di dialogo modale nell'editor dell'utente con contenuti lato client personalizzati.
`showModelessDialog(userInterface, title)`	`void`	Apre una finestra di dialogo non modale nell'editor dell'utente con contenuti lato client personalizzati.
`showSidebar(userInterface)`	`void`	Apre una barra laterale nell'editor dell'utente con contenuti lato client personalizzati.

Metodi deprecati

Metodo	Tipo restituito	Breve descrizione
`showDialog(userInterface)`	`void`	Apre una finestra di dialogo nell'editor dell'utente con contenuti lato client personalizzati.

Documentazione dettagliata

`alert(prompt)`

Apre una finestra di dialogo nell'editor dell'utente con il messaggio specificato e un "OK" . Questo metodo sospende lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo che l'utente chiude la finestra di dialogo, ma Jdbc e LockService blocchi non per tutta la durata della sospensione. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e alle barre laterali.

// Display "Hello, world" in a dialog box with an "OK" button. The user can also close the
// dialog by clicking the close button in its title bar.
SpreadsheetApp.getUi().alert('Hello, world');

Parametri

Nome	Tipo	Descrizione
`prompt`	`String`	Il messaggio da visualizzare nella finestra di dialogo.

Invio

Button: il pulsante su cui l'utente ha fatto clic.

`alert(prompt, buttons)`

Apre una finestra di dialogo nell'editor dell'utente con il messaggio e la serie di pulsanti specificati. Questo metodo sospende lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo che l'utente chiude la finestra di dialogo, ma Jdbc e LockService blocchi non per tutta la durata della sospensione. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e alle barre laterali.

// Display a dialog box with a message and "Yes" and "No" buttons. The user can also close the
// dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.alert('Are you sure you want to continue?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response == ui.Button.YES) {
  Logger.log('The user clicked "Yes."');
} else {
  Logger.log('The user clicked "No" or the close button in the dialog\'s title bar.');
}

Parametri

Nome	Tipo	Descrizione
`prompt`	`String`	Il messaggio da visualizzare nella finestra di dialogo.
`buttons`	`ButtonSet`	Il pulsante è stato impostato per essere visualizzato nella finestra di dialogo.

Invio

Button: il pulsante su cui l'utente ha fatto clic.

`alert(title, prompt, buttons)`

Apre una finestra di dialogo nell'editor dell'utente con il titolo, il messaggio e la serie di pulsanti specificati. Questo sospende lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo l'utente chiude la finestra di dialogo, ma Jdbc e LockService blocchi non per tutta la durata della sospensione. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e alle barre laterali.

// Display a dialog box with a title, message, and "Yes" and "No" buttons. The user can also
// close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.alert('Confirm', 'Are you sure you want to continue?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response == ui.Button.YES) {
  Logger.log('The user clicked "Yes."');
} else {
  Logger.log('The user clicked "No" or the close button in the dialog\'s title bar.');
}

Parametri

Nome	Tipo	Descrizione
`title`	`String`	Il titolo da visualizzare sopra la finestra di dialogo.
`prompt`	`String`	Il messaggio da visualizzare nella finestra di dialogo.
`buttons`	`ButtonSet`	Il pulsante è stato impostato per essere visualizzato nella finestra di dialogo.

Invio

Button: il pulsante su cui l'utente ha fatto clic.

`createAddonMenu()`

Crea uno strumento di creazione utilizzabile per inserire un sottomenu nel menu Estensioni dell'editor. La menu non viene effettivamente aggiornato finché non viene chiamato Menu.addToUi(). Se lo script è in esecuzione come componente aggiuntivo, il nome del sottomenu corrisponde al nome del componente aggiuntivo nel Web Store. Se lo script è associato direttamente al documento, il nome del sottomenu corrisponde al nome dello script. Per ulteriori informazioni, consulta la guida ai menu.

// Add an item to the Add-on menu, under a sub-menu whose name is set automatically.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createAddonMenu()
      .addItem('Show', 'showSidebar')
      .addToUi();
}

Invio

Menu: il nuovo generatore di menu.

`createMenu(caption)`

Crea un builder da utilizzare per aggiungere un menu all'interfaccia utente dell'editor. Il menu non è da aggiungere fino a quando non viene chiamato Menu.addToUi(). Per ulteriori informazioni, consulta la guida ai menu. L'etichetta di un menu di primo livello deve essere nel titolo (tutte le parole principali in maiuscolo), anche se l'etichetta di un sottomenu dovrebbe essere maiuscola (solo la prima parola in maiuscolo). Se lo script viene pubblicato come componente aggiuntivo, il parametro caption viene ignorato e il parametro viene aggiunto come sottomenu del menu Estensioni, equivalente a createAddonMenu().

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

Parametri

Nome	Tipo	Descrizione
`caption`	`String`	L'etichetta del menu, con tutte le parole principali in maiuscolo per un menu di primo livello, o solo la prima parola in maiuscolo per un sottomenu.

Invio

Menu: il nuovo generatore di menu.

`prompt(prompt)`

Apre una finestra di dialogo di immissione nell'editor dell'utente con il messaggio specificato e un "OK" . Questo sospende lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo l'utente chiude la finestra di dialogo, ma Jdbc e LockService blocchi non per tutta la durata della sospensione. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e alle barre laterali.

// Display a dialog box with a message, input field, and an "OK" button. The user can also
// close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('Enter your name:');

// Process the user's response.
if (response.getSelectedButton() == ui.Button.OK) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Parametri

Nome	Tipo	Descrizione
`prompt`	`String`	Il messaggio da visualizzare nella finestra di dialogo.

Invio

PromptResponse: una rappresentazione della risposta dell'utente.

`prompt(prompt, buttons)`

Apre una finestra di dialogo di immissione nell'editor dell'utente con il messaggio e la serie di pulsanti specificati. Questo sospende lo script lato server mentre la finestra di dialogo è aperta. Lo script riprende dopo l'utente chiude la finestra di dialogo, ma Jdbc e LockService blocchi non per tutta la durata della sospensione. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e alle barre laterali.

// Display a dialog box with a message, input field, and "Yes" and "No" buttons. The user can
// also close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('May I know your name?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response.getSelectedButton() == ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() == ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Parametri

Nome	Tipo	Descrizione
`prompt`	`String`	Il messaggio da visualizzare nella finestra di dialogo.
`buttons`	`ButtonSet`	Il pulsante è stato impostato per essere visualizzato nella finestra di dialogo.

Invio

PromptResponse: una rappresentazione della risposta dell'utente.

`prompt(title, prompt, buttons)`

Apre una finestra di dialogo di inserimento nell'editor dell'utente con il titolo, il messaggio e l'insieme specificati pulsanti. Questo metodo sospende lo script lato server quando la finestra di dialogo è aperta. Lo script riprende dopo che l'utente chiude la finestra di dialogo, ma Jdbc connessioni e LockService blocchi non vengono mantenuti in tutta la finestra sospensione. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e barre laterali.

// Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The
// user can also close the dialog by clicking the close button in its title bar.
var ui = SpreadsheetApp.getUi();
var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO);

// Process the user's response.
if (response.getSelectedButton() == ui.Button.YES) {
  Logger.log('The user\'s name is %s.', response.getResponseText());
} else if (response.getSelectedButton() == ui.Button.NO) {
  Logger.log('The user didn\'t want to provide a name.');
} else {
  Logger.log('The user clicked the close button in the dialog\'s title bar.');
}

Parametri

Nome	Tipo	Descrizione
`title`	`String`	Il titolo da visualizzare sopra la finestra di dialogo.
`prompt`	`String`	Il messaggio da visualizzare nella finestra di dialogo.
`buttons`	`ButtonSet`	Il pulsante è stato impostato per essere visualizzato nella finestra di dialogo.

Invio

PromptResponse: una rappresentazione della risposta dell'utente.

`showModalDialog(userInterface, title)`

Apre una finestra di dialogo modale nell'editor dell'utente con contenuti lato client personalizzati. Questo metodo non sospendere lo script lato server mentre la finestra di dialogo è aperta. Per comunicare con script lato server, il componente lato client deve effettuare callback asincroni utilizzando l'API google.script per HtmlService. Per chiudere la finestra di dialogo in modo programmatico, chiama google.script.host.close() sul lato client di un sito web HtmlService dell'app. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e barre laterali.

Le finestre di dialogo modali impediscono all'utente di interagire con elementi diversi dalla finestra di dialogo. Di il contrasto, le finestre di dialogo senza modalità e le barre laterali consentono all'utente di interagire con l'editor. In quasi tutti i casi, finestra di dialogo modale o barra laterale è una scelta migliore rispetto a una finestra di dialogo non modale.

// Display a modal dialog box with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setWidth(250)
    .setHeight(300);
SpreadsheetApp.getUi().showModalDialog(htmlOutput, 'My add-on');

Parametri

Nome	Tipo	Descrizione
`userInterface`	`Object`	`HtmlOutput` che rappresenta l'interfaccia da visualizzare.
`title`	`String`	Il titolo della finestra di dialogo; sostituisce qualsiasi titolo impostato chiamando `setTitle()` su l'oggetto `userInterface`.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

https://www.googleapis.com/auth/script.container.ui

`showModelessDialog(userInterface, title)`

Apre una finestra di dialogo non modale nell'editor dell'utente con contenuti lato client personalizzati. Questo metodo non sospende lo script lato server mentre la finestra di dialogo è aperta. Per comunicare con lo script lato server, il componente lato client deve effettuare callback asincroni utilizzando l'API google.script per HtmlService. Per chiudere la finestra di dialogo in modo programmatico, chiama google.script.host.close() sul lato client di un sito web HtmlService dell'app. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e barre laterali.

Le finestre di dialogo non modali consentono all'utente di interagire con l'editor dietro la finestra di dialogo. Al contrario, finestre di dialogo modali. In quasi tutti i casi, un modello una finestra di dialogo o una barra laterale è una scelta migliore rispetto a una finestra di dialogo non modale.

// Display a modeless dialog box with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setWidth(250)
    .setHeight(300);
SpreadsheetApp.getUi().showModelessDialog(htmlOutput, 'My add-on');

Parametri

Nome	Tipo	Descrizione
`userInterface`	`Object`	`HtmlOutput` che rappresenta l'interfaccia da visualizzare.
`title`	`String`	Il titolo della finestra di dialogo; sostituisce qualsiasi titolo impostato chiamando `setTitle()` su l'oggetto `userInterface`.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

https://www.googleapis.com/auth/script.container.ui

`showSidebar(userInterface)`

Apre una barra laterale nell'editor dell'utente con contenuti lato client personalizzati. Questo metodo non sospendere lo script lato server mentre la barra laterale è aperta. Per comunicare con script lato server, il componente lato client deve effettuare callback asincroni utilizzando l'API google.script per HtmlService. Per chiudere la barra laterale in modo programmatico, chiama google.script.host.close() sul lato client di un sito web HtmlService dell'app. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e barre laterali.

La barra laterale viene visualizzata sul lato destro dell'editor per gli utenti i cui ambienti utilizzano un lingua da sinistra a destra e sul lato sinistro dell'editor per le lingue da destra a sinistra. Tutti le barre laterali mostrate dagli script hanno una larghezza di 300 pixel.

// Display a sidebar with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My add-on');
SpreadsheetApp.getUi().showSidebar(htmlOutput);

Parametri

Nome	Tipo	Descrizione
`userInterface`	`Object`	`HtmlOutput` che rappresenta l'interfaccia da visualizzare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

https://www.googleapis.com/auth/script.container.ui

Metodi deprecati

`showDialog(userInterface)`

Obsoleta. A partire da marzo 2014, questo metodo è stato ritirato. La sostituzione diretta è showModelessDialog(userInterface, title), ma showModalDialog(userInterface, title) è un è la scelta migliore in quasi tutti i casi.

Apre una finestra di dialogo nell'editor dell'utente con contenuti lato client personalizzati. Questo metodo non sospendere lo script lato server mentre la finestra di dialogo è aperta. Per comunicare con script lato server, il componente lato client deve effettuare callback asincroni utilizzando l'API google.script per HtmlService. Per chiudere la finestra di dialogo in modo programmatico, chiama google.script.host.close() sul lato client di un sito web HtmlService dell'app. Per ulteriori informazioni, consulta la guida alle finestre di dialogo e barre laterali.

// Display a dialog box with custom HtmlService content.
var htmlOutput = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My add-on')
    .setWidth(250)
    .setHeight(300);
SpreadsheetApp.getUi().showDialog(htmlOutput);

Parametri

Nome	Tipo	Descrizione
`userInterface`	`Object`	`HtmlOutput` che rappresenta l'interfaccia da visualizzare.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

https://www.googleapis.com/auth/script.container.ui