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

المعلّمات

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

رحلة العودة

Range — النطاق المعدّل الذي يحتوي على خلية البيانات، أو null في حال عدم التحديد.

التفويض

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

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