Bu sayfa, Cloud Translation API ile çevrilmiştir.

Class Ui

Komut dosyasının Google Uygulaması için kullanıcı arayüzü ortamına ait bir örneği özellikler (ör. menüler, iletişim kutuları ve kenar çubukları) Bir komut dosyası yalnızca açık bir düzenleyicinin geçerli örneğini ve yalnızca komut dosyası düzenleyiciye kapsayıcıya bağlı olması durumunda.

// 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.');
}

Özellikler

Özellik	Tür	Açıklama
`Button`	`Button`	Bir uyarı veya `PromptResponse.getSelectedButton()` tarafından döndürülen, önceden belirlenmiş, yerelleştirilmiş iletişim düğmelerini temsil eden bir sıralama Kullanıcının iletişim kutusundaki hangi düğmeyi tıkladığı.
`ButtonSet`	`ButtonSet`	Yayınlayabileceğiniz önceden belirlenmiş, yerelleştirilmiş bir veya daha fazla iletişim düğmesi grubunu temsil eden bir sıralama uyarıya veya isteme eklenmiş olması.

Yöntemler

Yöntem	Dönüş türü	Kısa açıklama
`alert(prompt)`	`Button`	Kullanıcının düzenleyicisinde, belirtilen mesajın ve "Tamam" ifadesinin yer aldığı bir iletişim kutusu açar düğmesini tıklayın.
`alert(prompt, buttons)`	`Button`	Kullanıcının düzenleyicisinde, verilen iletiyi ve düğme grubunu içeren bir iletişim kutusu açar.
`alert(title, prompt, buttons)`	`Button`	Kullanıcının düzenleyicisinde belirtilen başlık, ileti ve düğme grubunu içeren bir iletişim kutusu açar.
`createAddonMenu()`	`Menu`	Düzenleyicinin Uzantılar menüsüne alt menü eklemek için kullanılabilecek bir oluşturucu oluşturur.
`createMenu(caption)`	`Menu`	Düzenleyicinin kullanıcı arayüzüne menü eklemek için kullanılabilecek bir oluşturucu oluşturur.
`prompt(prompt)`	`PromptResponse`	Kullanıcının düzenleyicisinde, verilen mesajı ve "Tamam"ı içeren bir giriş iletişim kutusu açar düğmesini tıklayın.
`prompt(prompt, buttons)`	`PromptResponse`	Kullanıcının düzenleyicisinde, verilen iletiyi ve düğme grubunu içeren bir giriş iletişim kutusu açar.
`prompt(title, prompt, buttons)`	`PromptResponse`	Kullanıcının düzenleyicisinde belirtilen başlık, ileti ve kümeyi içeren bir giriş iletişim kutusu açar düğmelerini kullanın.
`showModalDialog(userInterface, title)`	`void`	Kullanıcının düzenleyicisinde, istemci tarafı özel içerikle kalıcı bir iletişim kutusu açar.
`showModelessDialog(userInterface, title)`	`void`	Kullanıcının düzenleyicisinde, özel istemci tarafı içerikle modsuz bir iletişim kutusu açar.
`showSidebar(userInterface)`	`void`	Kullanıcının düzenleyicisinde, istemci tarafı özel içerikle bir kenar çubuğu açar.

Desteği sonlandırılan yöntemler

Yöntem	Dönüş türü	Kısa açıklama
`showDialog(userInterface)`	`void`	Kullanıcının düzenleyicisinde, özel istemci tarafı içerikle bir iletişim kutusu açar.

Ayrıntılı belgeler

`alert(prompt)`

Kullanıcının düzenleyicisinde, belirtilen mesajın ve "Tamam" ifadesinin yer aldığı bir iletişim kutusu açar düğmesini tıklayın. Bu yöntem iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Komut dosyası, kullanıcı sonrasında devam ettirilir iletişim kutusunu kapatır, ancak Jdbc bağlantılarına ve LockService kilidine askıya alınma durumunda kalır. Daha fazla bilgi için iletişim kutusu ve kenar çubuğu rehberine bakın.

// 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');

Parametreler

Ad	Tür	Açıklama
`prompt`	`String`	İletişim kutusunda gösterilecek mesaj.

Return

Button - Kullanıcının tıkladığı düğme.

`alert(prompt, buttons)`

Kullanıcının düzenleyicisinde, verilen iletiyi ve düğme grubunu içeren bir iletişim kutusu açar. Bu yöntem iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Komut dosyası, kullanıcı sonrasında devam ettirilir iletişim kutusunu kapatır, ancak Jdbc bağlantılarına ve LockService kilidine askıya alınma durumunda kalır. Daha fazla bilgi için iletişim kutusu ve kenar çubuğu rehberine bakın.

// 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.');
}

Parametreler

Ad	Tür	Açıklama
`prompt`	`String`	İletişim kutusunda gösterilecek mesaj.
`buttons`	`ButtonSet`	Düğme, iletişim kutusunda görüntülenecek şekilde ayarlanmıştır.

Return

Button - Kullanıcının tıkladığı düğme.

`alert(title, prompt, buttons)`

Kullanıcının düzenleyicisinde belirtilen başlık, ileti ve düğme grubunu içeren bir iletişim kutusu açar. Bu yöntemi, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Komut dosyası, kullanıcı iletişim kutusunu kapatır, ancak Jdbc bağlantılarına ve LockService kilidine askıya alınma durumunda kalır. Daha fazla bilgi için iletişim kutusu ve kenar çubuğu rehberine bakın.

// 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.');
}

Parametreler

Ad	Tür	Açıklama
`title`	`String`	İletişim kutusunun üzerinde görüntülenecek başlık.
`prompt`	`String`	İletişim kutusunda gösterilecek mesaj.
`buttons`	`ButtonSet`	Düğme, iletişim kutusunda görüntülenecek şekilde ayarlanmıştır.

Return

Button - Kullanıcının tıkladığı düğme.

`createAddonMenu()`

Düzenleyicinin Uzantılar menüsüne alt menü eklemek için kullanılabilecek bir oluşturucu oluşturur. İlgili içeriği oluşturmak için kullanılan menü, Menu.addToUi() çağrılana kadar güncellenmez. Komut dosyası çalışıyorsa alt menü adı, eklentinin web mağazasındaki adıyla eşleşir; Komut dosyası doğrudan dokümana bağlıysa alt menü adı komut dosyasının adıyla eşleşir. Daha fazla bilgi için menü rehberine bakın.

// 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();
}

Return

Menu: Yeni menü oluşturucu.

`createMenu(caption)`

Düzenleyicinin kullanıcı arayüzüne menü eklemek için kullanılabilecek bir oluşturucu oluşturur. Menü aslında Menu.addToUi() çağrılana kadar eklenmelidir. Daha fazla bilgi için menü rehberine bakın. Üst düzey menü etiketi bir alt menünün etiketi Normal tümce düzeni (yalnızca ilk kelime büyük harfle yazılmalıdır). Komut dosyası bir eklenti olarak yayınlanırsa caption parametresi yoksayılır ve menüsü, Uzantılar menüsünün alt menüsü olarak eklenir (createAddonMenu() eşdeğeri).

// 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();
}

Parametreler

Ad	Tür	Açıklama
`caption`	`String`	Üst düzey bir menü için tüm önemli kelimelerin büyük harfle yazıldığı menü etiketi, veya yalnızca ilk kelimenin ilk harfi büyük yazılır.

Return

Menu: Yeni menü oluşturucu.

`prompt(prompt)`

Kullanıcının düzenleyicisinde, verilen mesajı ve "Tamam"ı içeren bir giriş iletişim kutusu açar düğmesini tıklayın. Bu yöntemi, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Komut dosyası, kullanıcı iletişim kutusunu kapatır, ancak Jdbc bağlantılarına ve LockService kilidine askıya alınma durumunda kalır. Daha fazla bilgi için iletişim kutusu ve kenar çubuğu rehberine bakın.

// 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.');
}

Parametreler

Ad	Tür	Açıklama
`prompt`	`String`	İletişim kutusunda gösterilecek mesaj.

Return

PromptResponse: Kullanıcının yanıtının temsilidir.

`prompt(prompt, buttons)`

Kullanıcının düzenleyicisinde, verilen iletiyi ve düğme grubunu içeren bir giriş iletişim kutusu açar. Bu yöntemi, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Komut dosyası, kullanıcı iletişim kutusunu kapatır, ancak Jdbc bağlantılarına ve LockService kilidine askıya alınma durumunda kalır. Daha fazla bilgi için iletişim kutusu ve kenar çubuğu rehberine bakın.

// 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.');
}

Parametreler

Ad	Tür	Açıklama
`prompt`	`String`	İletişim kutusunda gösterilecek mesaj.
`buttons`	`ButtonSet`	Düğme, iletişim kutusunda görüntülenecek şekilde ayarlanmıştır.

Return

PromptResponse: Kullanıcının yanıtının temsilidir.

`prompt(title, prompt, buttons)`

Kullanıcının düzenleyicisinde belirtilen başlık, ileti ve kümeyi içeren bir giriş iletişim kutusu açar düğmelerini kullanın. Bu yöntem, iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya alır. Komut dosyası kullanıcı iletişim kutusunu kapattıktan sonra devam eder, ancak Jdbc bağlantıları ve LockService kilitleri askıya alınır. Daha fazla bilgi için kılavuzu iletişim kutuları ve kenar çubukları'nı tıklayın.

// 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.');
}

Parametreler

Ad	Tür	Açıklama
`title`	`String`	İletişim kutusunun üzerinde görüntülenecek başlık.
`prompt`	`String`	İletişim kutusunda gösterilecek mesaj.
`buttons`	`ButtonSet`	Düğme, iletişim kutusunda görüntülenecek şekilde ayarlanmıştır.

Return

PromptResponse: Kullanıcının yanıtının temsilidir.

`showModalDialog(userInterface, title)`

Kullanıcının düzenleyicisinde, istemci tarafı özel içerikle kalıcı bir iletişim kutusu açar. Bu yöntem askıya almama. Müşteriyle iletişim kurmak için komut dosyası kullanıyorsanız, istemci tarafı bileşeninin HtmlService için google.script API'sini kullanarak eşzamansız geri çağırmalar yapması gerekir. İletişim kutusunu kapatmak için programatik olarak, şunu çağırın: HtmlService web'in istemci tarafında google.script.host.close() uygulamasını indirin. Daha fazla bilgi için bkz. iletişim kutuları rehberi ve kenar çubukları.

Kalıcı iletişim kutuları, kullanıcının iletişim kutusu dışında herhangi bir şeyle etkileşim kurmasını engeller. Ölçüt kontrast, modsuz iletişim kutuları ve kenar çubukları, kullanıcının düzenleyiciyle etkileşimde bulunmasını sağlar. Neredeyse her senaryoda kalıcı iletişim kutusu veya kenar çubuğu, modsuz iletişim kutusundan daha iyi bir seçenektir.

// 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');

Parametreler

Ad	Tür	Açıklama
`userInterface`	`Object`	`HtmlOutput` temsil eder.
`title`	`String`	İletişimin başlığı; şurada `setTitle()` çağrısı yapıldığında ayarlanan herhangi bir başlığı geçersiz kılar: `userInterface` nesnesini tanımlayın.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

`showModelessDialog(userInterface, title)`

Kullanıcının düzenleyicisinde, özel istemci tarafı içerikle modsuz bir iletişim kutusu açar. Bu yöntem iletişim kutusu açıkken sunucu tarafı komut dosyasını askıya almaz. Müşteriyle iletişim kurmak için komut dosyası kullanıyorsanız, istemci tarafı bileşeninin HtmlService için google.script API'sini kullanarak eşzamansız geri çağırmalar yapması gerekir. İletişim kutusunu kapatmak için programatik olarak, şunu çağırın: HtmlService web'in istemci tarafında google.script.host.close() uygulamasını indirin. Daha fazla bilgi için bkz. iletişim kutuları rehberi ve kenar çubukları.

Modsuz iletişim kutuları, kullanıcının iletişim kutusunun arkasındaki düzenleyiciyle etkileşimde bulunmasına olanak tanır. Buna karşılık, modal iletişim kutuları için bu geçerli değildir. Neredeyse her senaryoda, iletişim kutusu veya kenar çubuğu, modsuz iletişim kutusundan daha iyi bir seçenektir.

// 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');

Parametreler

Ad	Tür	Açıklama
`userInterface`	`Object`	`HtmlOutput` temsil eder.
`title`	`String`	İletişimin başlığı; şurada `setTitle()` çağrısı yapıldığında ayarlanan herhangi bir başlığı geçersiz kılar: `userInterface` nesnesini tanımlayın.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

`showSidebar(userInterface)`

Kullanıcının düzenleyicisinde, istemci tarafı özel içerikle bir kenar çubuğu açar. Bu yöntem Kenar çubuğu açıkken sunucu tarafı komut dosyasını askıya almayın. Müşteriyle iletişim kurmak için komut dosyası kullanıyorsanız, istemci tarafı bileşeninin HtmlService için google.script API'sini kullanarak eşzamansız geri çağırmalar yapması gerekir. Kenar çubuğunu kapatmak için programatik olarak, şunu çağırın: HtmlService web'in istemci tarafında google.script.host.close() uygulamasını indirin. Daha fazla bilgi için bkz. iletişim kutuları rehberi ve kenar çubukları.

Kenar çubuğu, ortamlarında bir uzantı kullanan kullanıcılar için düzenleyicinin sağ tarafında soldan sağa ve sağdan sola diller için düzenleyicinin sol tarafında yer alır. Tümü komut dosyaları tarafından gösterilen kenar çubukları 300 piksel genişliğindedir.

// 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);

Parametreler

Ad	Tür	Açıklama
`userInterface`	`Object`	`HtmlOutput` temsil eder.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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

Desteği sonlandırılan yöntemler

`showDialog(userInterface)`

Kullanımdan kaldırıldı. Mart 2014 itibarıyla bu yöntem kullanımdan kaldırılmıştır. Doğrudan değişim fiyatı: showModelessDialog(userInterface, title), ancak showModalDialog(userInterface, title) bir neredeyse her durumda daha iyi bir seçimdir.

Kullanıcının düzenleyicisinde, özel istemci tarafı içerikle bir iletişim kutusu açar. Bu yöntem askıya almama. Müşteriyle iletişim kurmak için komut dosyası kullanıyorsanız, istemci tarafı bileşeninin HtmlService için google.script API'sini kullanarak eşzamansız geri çağırmalar yapması gerekir. İletişim kutusunu kapatmak için programatik olarak, şunu çağırın: HtmlService web'in istemci tarafında google.script.host.close() uygulamasını indirin. Daha fazla bilgi için bkz. iletişim kutuları rehberi ve kenar çubukları.

// 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);

Parametreler

Ad	Tür	Açıklama
`userInterface`	`Object`	`HtmlOutput` temsil eder.

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir veya daha fazlasıyla yetkilendirme gerektirir:

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