Class Ui

Ui

একটি Google অ্যাপের জন্য ব্যবহারকারী-ইন্টারফেস পরিবেশের একটি উদাহরণ যা স্ক্রিপ্টকে মেনু, ডায়ালগ এবং সাইডবারগুলির মতো বৈশিষ্ট্যগুলি যোগ করার অনুমতি দেয়৷ একটি স্ক্রিপ্ট শুধুমাত্র একটি খোলা সম্পাদকের বর্তমান উদাহরণের জন্য UI এর সাথে ইন্টারঅ্যাক্ট করতে পারে, এবং শুধুমাত্র যদি স্ক্রিপ্টটি সম্পাদকের সাথে ধারক-আবদ্ধ থাকে। 

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

বৈশিষ্ট্য

সম্পত্তি টাইপ বর্ণনা
Button Button পূর্বনির্ধারিত, স্থানীয়করণকৃত ডায়ালগ বোতামের প্রতিনিধিত্বকারী একটি enum একটি সতর্কতা বা PromptResponse.getSelectedButton() দ্বারা প্রত্যাবর্তনকারী ডায়ালগের কোন বোতামটি ব্যবহারকারী ক্লিক করেছে তা নির্দেশ করতে।
ButtonSet ButtonSet একটি enum প্রতিনিধিত্ব করে পূর্বনির্ধারিত, এক বা একাধিক ডায়ালগ বোতামের স্থানীয় সেট যা একটি সতর্কতা বা একটি প্রম্পটে যোগ করা যেতে পারে।

পদ্ধতি

পদ্ধতি রিটার্ন টাইপ সংক্ষিপ্ত বিবরণ
alert(prompt) Button প্রদত্ত বার্তা এবং একটি "ঠিক আছে" বোতাম সহ ব্যবহারকারীর সম্পাদকে একটি ডায়ালগ বক্স খোলে৷
alert(prompt, buttons) Button প্রদত্ত বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ডায়ালগ বক্স খোলে৷
alert(title, prompt, buttons) Button প্রদত্ত শিরোনাম, বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ডায়ালগ বাক্স খোলে।
createAddonMenu() Menu একটি নির্মাতা তৈরি করে যা সম্পাদকের এক্সটেনশন মেনুতে একটি সাব-মেনু সন্নিবেশ করতে ব্যবহার করা যেতে পারে।
createMenu(caption) Menu একটি নির্মাতা তৈরি করে যা সম্পাদকের ব্যবহারকারী ইন্টারফেসে একটি মেনু যোগ করতে ব্যবহার করা যেতে পারে।
prompt(prompt) PromptResponse প্রদত্ত বার্তা এবং একটি "ঠিক আছে" বোতাম সহ ব্যবহারকারীর সম্পাদকে একটি ইনপুট ডায়ালগ বক্স খোলে৷
prompt(prompt, buttons) PromptResponse প্রদত্ত বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ইনপুট ডায়ালগ বক্স খোলে৷
prompt(title, prompt, buttons) PromptResponse প্রদত্ত শিরোনাম, বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ইনপুট ডায়ালগ বক্স খোলে৷
showModalDialog(userInterface, title) void কাস্টম ক্লায়েন্ট-সাইড সামগ্রী সহ ব্যবহারকারীর সম্পাদকে একটি মডেল ডায়ালগ বক্স খোলে৷
showModelessDialog(userInterface, title) void কাস্টম ক্লায়েন্ট-সাইড সামগ্রী সহ ব্যবহারকারীর সম্পাদকে একটি মডেলহীন ডায়ালগ বক্স খোলে৷
showSidebar(userInterface) void কাস্টম ক্লায়েন্ট-সাইড সামগ্রী সহ ব্যবহারকারীর সম্পাদকে একটি সাইডবার খোলে৷

বিস্তারিত ডকুমেন্টেশন

alert(prompt)

প্রদত্ত বার্তা এবং একটি "ঠিক আছে" বোতাম সহ ব্যবহারকারীর সম্পাদকে একটি ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে। ব্যবহারকারী ডায়ালগটি খারিজ করার পরে স্ক্রিপ্টটি পুনরায় শুরু হয়, তবে Jdbc সংযোগ এবং LockService লকগুলি সাসপেনশন জুড়ে থাকে না। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন। 

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

পরামিতি

নাম টাইপ বর্ণনা
prompt String ডায়ালগ বক্সে প্রদর্শিত বার্তা।

প্রত্যাবর্তন

Button - ব্যবহারকারী যে বোতামটি ক্লিক করেছেন।

alert(prompt, buttons)

প্রদত্ত বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে। ব্যবহারকারী ডায়ালগটি খারিজ করার পরে স্ক্রিপ্টটি পুনরায় শুরু হয়, তবে Jdbc সংযোগ এবং LockService লকগুলি সাসপেনশন জুড়ে থাকে না। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন। 

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

পরামিতি

নাম টাইপ বর্ণনা
prompt String ডায়ালগ বক্সে প্রদর্শিত বার্তা।
buttons ButtonSet ডায়ালগ বক্সে প্রদর্শিত বোতাম সেট।

প্রত্যাবর্তন

Button - ব্যবহারকারী যে বোতামটি ক্লিক করেছেন।

alert(title, prompt, buttons)

প্রদত্ত শিরোনাম, বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ডায়ালগ বাক্স খোলে। ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে। ব্যবহারকারী ডায়ালগটি খারিজ করার পরে স্ক্রিপ্টটি পুনরায় শুরু হয়, তবে Jdbc সংযোগ এবং LockService লকগুলি সাসপেনশন জুড়ে থাকে না। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন। 

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

পরামিতি

নাম টাইপ বর্ণনা
title String ডায়ালগ বক্সের উপরে প্রদর্শিত শিরোনাম।
prompt String ডায়ালগ বক্সে প্রদর্শিত বার্তা।
buttons ButtonSet ডায়ালগ বক্সে প্রদর্শিত বোতাম সেট।

প্রত্যাবর্তন

Button - ব্যবহারকারী যে বোতামটি ক্লিক করেছেন।

createAddonMenu()

একটি নির্মাতা তৈরি করে যা সম্পাদকের এক্সটেনশন মেনুতে একটি সাব-মেনু সন্নিবেশ করতে ব্যবহার করা যেতে পারে। Menu.addToUi() কল না করা পর্যন্ত মেনুটি আসলে আপডেট করা হয় না। যদি স্ক্রিপ্টটি অ্যাড-অন হিসাবে চলছে, সাব-মেনু নামটি ওয়েব স্টোরের অ্যাড-অনের নামের সাথে মেলে; যদি স্ক্রিপ্টটি সরাসরি নথিতে আবদ্ধ হয়, তাহলে সাব-মেনু নামটি স্ক্রিপ্টের নামের সাথে মেলে। আরও তথ্যের জন্য, মেনুগুলির নির্দেশিকা দেখুন। 

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

প্রত্যাবর্তন

Menu — নতুন মেনু নির্মাতা।

createMenu(caption)

একটি নির্মাতা তৈরি করে যা সম্পাদকের ব্যবহারকারী ইন্টারফেসে একটি মেনু যোগ করতে ব্যবহার করা যেতে পারে। Menu.addToUi() কল না করা পর্যন্ত মেনু আসলে যোগ করা হয় না। আরও তথ্যের জন্য, মেনুগুলির নির্দেশিকা দেখুন। একটি শীর্ষ-স্তরের মেনুর জন্য লেবেলটি শিরোনামের ক্ষেত্রে হওয়া উচিত (সকল প্রধান শব্দ বড় করা), যদিও একটি সাব-মেনুর জন্য লেবেলটি বাক্যের ক্ষেত্রে হওয়া উচিত (শুধুমাত্র প্রথম শব্দ বড় করা)। যদি স্ক্রিপ্ট একটি অ্যাড-অন হিসাবে প্রকাশিত হয়, তাহলে caption প্যারামিটার উপেক্ষা করা হয় এবং মেনুটিকে এক্সটেনশন মেনুর একটি সাব-মেনু হিসাবে যোগ করা হয়, যা 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();
}

পরামিতি

নাম টাইপ বর্ণনা
caption String মেনুর জন্য লেবেল, একটি শীর্ষ-স্তরের মেনুর জন্য বড় বড় সমস্ত শব্দ সহ, অথবা শুধুমাত্র একটি সাব-মেনুর জন্য বড় করা প্রথম শব্দ।

প্রত্যাবর্তন

Menu — নতুন মেনু নির্মাতা।

prompt(prompt)

প্রদত্ত বার্তা এবং একটি "ঠিক আছে" বোতাম সহ ব্যবহারকারীর সম্পাদকে একটি ইনপুট ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে। ব্যবহারকারী ডায়ালগটি খারিজ করার পরে স্ক্রিপ্টটি পুনরায় শুরু হয়, তবে Jdbc সংযোগ এবং LockService লকগুলি সাসপেনশন জুড়ে থাকে না। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন। 

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

পরামিতি

নাম টাইপ বর্ণনা
prompt String ডায়ালগ বক্সে প্রদর্শিত বার্তা।

প্রত্যাবর্তন

PromptResponse — ব্যবহারকারীর প্রতিক্রিয়ার একটি উপস্থাপনা।

prompt(prompt, buttons)

প্রদত্ত বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ইনপুট ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে। ব্যবহারকারী ডায়ালগটি খারিজ করার পরে স্ক্রিপ্টটি পুনরায় শুরু হয়, তবে Jdbc সংযোগ এবং LockService লকগুলি সাসপেনশন জুড়ে থাকে না। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন। 

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

পরামিতি

নাম টাইপ বর্ণনা
prompt String ডায়ালগ বক্সে প্রদর্শিত বার্তা।
buttons ButtonSet ডায়ালগ বক্সে প্রদর্শিত বোতাম সেট।

প্রত্যাবর্তন

PromptResponse — ব্যবহারকারীর প্রতিক্রিয়ার একটি উপস্থাপনা।

prompt(title, prompt, buttons)

প্রদত্ত শিরোনাম, বার্তা এবং বোতামগুলির সেট সহ ব্যবহারকারীর সম্পাদকে একটি ইনপুট ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে। ব্যবহারকারী ডায়ালগটি খারিজ করার পরে স্ক্রিপ্টটি পুনরায় শুরু হয়, তবে Jdbc সংযোগ এবং LockService লকগুলি সাসপেনশন জুড়ে থাকে না। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন। 

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

পরামিতি

নাম টাইপ বর্ণনা
title String ডায়ালগ বক্সের উপরে প্রদর্শিত শিরোনাম।
prompt String ডায়ালগ বক্সে প্রদর্শিত বার্তা।
buttons ButtonSet ডায়ালগ বক্সে প্রদর্শিত বোতাম সেট।

প্রত্যাবর্তন

PromptResponse — ব্যবহারকারীর প্রতিক্রিয়ার একটি উপস্থাপনা।

showModalDialog(userInterface, title)

কাস্টম ক্লায়েন্ট-সাইড সামগ্রী সহ ব্যবহারকারীর সম্পাদকে একটি মডেল ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে না । সার্ভার-সাইড স্ক্রিপ্টের সাথে যোগাযোগ করতে, ক্লায়েন্ট-সাইড কম্পোনেন্টকে অবশ্যই HtmlService এর জন্য google.script API ব্যবহার করে অ্যাসিঙ্ক্রোনাস কলব্যাক করতে হবে। ডায়ালগটি প্রোগ্রাম্যাটিকভাবে বন্ধ করতে, একটি HtmlService ওয়েব অ্যাপের ক্লায়েন্ট সাইডে google.script.host.close() কল করুন। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন।

মডেল ডায়ালগ ব্যবহারকারীকে ডায়ালগ ছাড়া অন্য কিছুর সাথে ইন্টারঅ্যাক্ট করতে বাধা দেয়। বিপরীতে, মডেলহীন ডায়ালগ এবং সাইডবার ব্যবহারকারীকে সম্পাদকের সাথে যোগাযোগ করতে দেয়। প্রায় সব ক্ষেত্রে, একটি মডেলহীন ডায়ালগ থেকে একটি মডেল ডায়ালগ বা সাইডবার একটি ভাল পছন্দ। 

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

পরামিতি

নাম টাইপ বর্ণনা
userInterface Object প্রদর্শনের জন্য ইন্টারফেসের প্রতিনিধিত্ব করে একটি HtmlOutput ।
title String ডায়ালগের শিরোনাম; userInterface অবজেক্টে setTitle() কল করে যে কোনো শিরোনাম সেট ওভাররাইড করে।

অনুমোদন

যে স্ক্রিপ্টগুলি এই পদ্ধতিটি ব্যবহার করে তাদের নিম্নলিখিত এক বা একাধিক সুযোগের সাথে অনুমোদনের প্রয়োজন হয়:

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

showModelessDialog(userInterface, title)

কাস্টম ক্লায়েন্ট-সাইড সামগ্রী সহ ব্যবহারকারীর সম্পাদকে একটি মডেলহীন ডায়ালগ বক্স খোলে৷ ডায়ালগ খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে না । সার্ভার-সাইড স্ক্রিপ্টের সাথে যোগাযোগ করতে, ক্লায়েন্ট-সাইড কম্পোনেন্টকে অবশ্যই HtmlService এর জন্য google.script API ব্যবহার করে অ্যাসিঙ্ক্রোনাস কলব্যাক করতে হবে। ডায়ালগটি প্রোগ্রাম্যাটিকভাবে বন্ধ করতে, একটি HtmlService ওয়েব অ্যাপের ক্লায়েন্ট সাইডে google.script.host.close() কল করুন। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন।

মডেলহীন ডায়ালগ ব্যবহারকারীকে ডায়ালগের পিছনে সম্পাদকের সাথে যোগাযোগ করতে দেয়। বিপরীতে, মডেল ডায়ালগ হয় না। প্রায় সব ক্ষেত্রে, একটি মডেলহীন ডায়ালগ থেকে একটি মডেল ডায়ালগ বা সাইডবার একটি ভাল পছন্দ। 

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

পরামিতি

নাম টাইপ বর্ণনা
userInterface Object প্রদর্শনের জন্য ইন্টারফেসের প্রতিনিধিত্ব করে একটি HtmlOutput ।
title String ডায়ালগের শিরোনাম; userInterface অবজেক্টে setTitle() কল করে যে কোনো শিরোনাম সেট ওভাররাইড করে।

অনুমোদন

যে স্ক্রিপ্টগুলি এই পদ্ধতিটি ব্যবহার করে তাদের নিম্নলিখিত এক বা একাধিক সুযোগের সাথে অনুমোদনের প্রয়োজন হয়:

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

showSidebar(userInterface)

কাস্টম ক্লায়েন্ট-সাইড সামগ্রী সহ ব্যবহারকারীর সম্পাদকে একটি সাইডবার খোলে৷ সাইডবার খোলা থাকা অবস্থায় এই পদ্ধতি সার্ভার-সাইড স্ক্রিপ্ট স্থগিত করে না । সার্ভার-সাইড স্ক্রিপ্টের সাথে যোগাযোগ করতে, ক্লায়েন্ট-সাইড কম্পোনেন্টকে অবশ্যই HtmlService এর জন্য google.script API ব্যবহার করে অ্যাসিঙ্ক্রোনাস কলব্যাক করতে হবে। সাইডবারটি প্রোগ্রামগতভাবে বন্ধ করতে, একটি HtmlService ওয়েব অ্যাপের ক্লায়েন্ট সাইডে google.script.host.close() কল করুন। আরও তথ্যের জন্য, ডায়ালগ এবং সাইডবারগুলির নির্দেশিকা দেখুন।

যে ব্যবহারকারীদের পরিবেশ বাম থেকে ডান ভাষা ব্যবহার করে এবং ডান থেকে বাম ভাষার জন্য সম্পাদকের বাম দিকে সাইডবার প্রদর্শন করে। স্ক্রিপ্ট দ্বারা দেখানো সমস্ত সাইডবার 300 পিক্সেল চওড়া। 

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

পরামিতি

নাম টাইপ বর্ণনা
userInterface Object প্রদর্শনের জন্য ইন্টারফেসের প্রতিনিধিত্ব করে একটি HtmlOutput ।

অনুমোদন

যে স্ক্রিপ্টগুলি এই পদ্ধতিটি ব্যবহার করে তাদের নিম্নলিখিত এক বা একাধিক সুযোগের সাথে অনুমোদনের প্রয়োজন হয়:

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

অপ্রচলিত পদ্ধতি