Class Selection

الاختيار

الوصول إلى التحديد النشط الحالي في الورقة النشطة. التحديد هو مجموعة الخلايا التي قام المستخدم بتمييزها في الورقة، والتي يمكن أن تكون نطاقات غير مجاورة. إحدى الخلايا في التحديد هي الخلية الحالية، حيث يكون التركيز الحالي للمستخدم. تم تمييز الخلية الحالية بحد أغمق في واجهة مستخدم "جداول بيانات Google".

var activeSheet = SpreadsheetApp.getActiveSheet();
var rangeList = activeSheet.getRangeList(['A1:B4', 'D1:E4']);
rangeList.activate();

var selection = activeSheet.getSelection();
// Current Cell: D1
console.log('Current Cell: ' + selection.getCurrentCell().getA1Notation());
// Active Range: D1:E4
console.log('Active Range: ' + selection.getActiveRange().getA1Notation());
// Active Ranges: A1:B4, D1:E4
var ranges =  selection.getActiveRangeList().getRanges();
for (var i = 0; i < ranges.length; i++) {
  console.log('Active Ranges: ' + ranges[i].getA1Notation());
}
console.log('Active Sheet: ' + selection.getActiveSheet().getName());

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
getActiveRange()Rangeيتم عرض النطاق المحدد في الورقة النشطة، أو عرض null إذا لم يكن هناك نطاق نشط.
getActiveRangeList()RangeListعرض قائمة النطاقات النشطة في الورقة النشطة أو عرض null في حال عدم توفّر نطاقات نشطة.
getActiveSheet()Sheetتعرض الورقة النشطة في جدول البيانات.
getCurrentCell()Rangeتعرض الخلية الحالية (المميزة) التي تم تحديدها في أحد النطاقات النشطة أو تعرض null إذا لم تكن هناك خلية حالية.
getNextDataRange(direction)Rangeبدءًا من current cell وactive range والتحرك في الاتجاه المحدد، يتم عرض نطاق معدل تم فيه إزاحة الحافة المناسبة للنطاق لتغطية next data cell مع الاستمرار في تغطية الخلية الحالية.

الوثائق التفصيلية

getActiveRange()

يتم عرض النطاق المحدد في الورقة النشطة، أو عرض null إذا لم يكن هناك نطاق نشط. في حالة تحديد نطاقات متعددة، تعرض هذه الطريقة آخر نطاق محدد فقط.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeRange = selection.getActiveRange();

استرجاع الكرة

Range — النطاق النشط

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

getActiveRangeList()

عرض قائمة النطاقات النشطة في الورقة النشطة أو عرض null في حال عدم توفّر نطاقات نشطة.

إذا كان هناك نطاق واحد محدد، يعمل هذا كاستدعاء getActiveRange().

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

استرجاع الكرة

RangeList - قائمة النطاقات النشطة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

getActiveSheet()

تعرض الورقة النشطة في جدول البيانات.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var activeSheet = selection.getActiveSheet();

استرجاع الكرة

Sheet — الورقة النشطة في جدول البيانات

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

getCurrentCell()

تعرض الخلية الحالية (المميزة) التي تم تحديدها في أحد النطاقات النشطة أو تعرض null إذا لم تكن هناك خلية حالية.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = selection.getCurrentCell();

استرجاع الكرة

Range - الخلية الحالية

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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

getNextDataRange(direction)

بدءًا من current cell وactive range والتحرك في الاتجاه المحدد، يتم عرض نطاق معدل تم فيه إزاحة الحافة المناسبة للنطاق لتغطية next data cell مع الاستمرار في تغطية الخلية الحالية. إذا كان النطاق النشط غير محدود بطول dimension للاتجاه، يتم عرض النطاق النشط الأصلي. إذا لم تكن هناك خلية حالية أو نطاق نشط ، يتم عرض null. يعادل ذلك تحديد نطاق في المحرر والنقر على Ctrl+Shift+[arrow key].

// Assume the active spreadsheet is blank.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Makes C3 the current cell and C3:E5 the active range.
sheet.getRange('C3:E5').activate();
// Logs 'C1:E3'
console.log(SpreadsheetApp.getSelection()
                          .getNextDataRange(SpreadsheetApp.Direction.UP)
                          .getA1Notation());

المَعلمات

الاسمTypeالوصف
directionDirectionالاتجاه الذي يمكن العثور فيه على خلية حافة منطقة البيانات التالية.

استرجاع الكرة

Range: النطاق المعدَّل الذي يتضمّن خلية البيانات، أو null في حال عدم اختيار

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:

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