वर्कशीट प्राप्त करना

इस लेख में Office Scripts का उपयोग करके किसी खास वर्कशीट को प्राप्त करने का तरीका सैंपल कोड के साथ समझाया गया है।

नाम बताकर प्राप्त करना

सबसे पहले, सबसे ज़्यादा इस्तेमाल होने वाला तरीका देखते हैं, जिसमें शीट का नाम बताकर वर्कशीट प्राप्त की जाती है।

इस्तेमाल होने वाला मेथड

Workbook ऑब्जेक्ट में मौजूद getWorksheet मेथड का उपयोग करें।

ExcelScript.Workbook.getWorksheet(key: string): Worksheet | undefined;

आर्ग्युमेंट में शीट का नाम (या वर्कशीट का ID) दें। अगर बताई गई वर्कशीट मौजूद न हो, तो undefined लौटाया जाता है, इसलिए इस्तेमाल करने से पहले जाँच लें कि वर्कशीट मिली है या नहीं।

सैंपल कोड

function main(workbook: ExcelScript.Workbook) {
  /** लक्षित शीट का नाम */
  const sheetname = 'Sheet1';

  /** लक्षित वर्कशीट */
  const sheet = workbook.getWorksheet(sheetname);

  if (!sheet) {
    throw `${sheetname} नाम की कोई वर्कशीट मौजूद नहीं है`;
  }
}

इंडेक्स से प्राप्त करना

यह तरीका तब काम आता है, जब n-वीं शीट बताकर उसे प्राप्त करना हो।

इस्तेमाल होने वाला मेथड

Workbook ऑब्जेक्ट में मौजूद getWorksheets मेथड का उपयोग करें।

ExcelScript.Workbook.getWorksheets(): Worksheet[];

यह वर्कबुक की सभी वर्कशीट ऐरे के रूप में लौटाता है, इसलिए इंडेक्स (0 से शुरू) बताकर वर्कशीट प्राप्त करें।

सैंपल कोड

function main(workbook: ExcelScript.Workbook) {
  /** वर्कबुक की सभी वर्कशीट */
  const sheets = workbook.getWorksheets();

  /** वर्कबुक की दूसरी शीट */
  const secondSheet = sheets[1];
}

पहली और आख़िरी शीट प्राप्त करना

ऊपर बताए गए इंडेक्स वाले तरीके से भी यह किया जा सकता है, लेकिन यहाँ पहली और आख़िरी शीट प्राप्त करने का तरीका बताया गया है।

इस्तेमाल होने वाले मेथड

Workbook ऑब्जेक्ट में मौजूद getFirstWorksheet और getLastWorksheet मेथड का उपयोग करें।

ExcelScript.Workbook.getFirstWorksheet(visibleOnly?: boolean): Worksheet;

ExcelScript.Workbook.getLastWorksheet(visibleOnly?: boolean): Worksheet;

दोनों मेथड में एक वैकल्पिक आर्ग्युमेंट होता है। इसमें true देने पर, छिपी हुई वर्कशीट को छोड़कर बाकी में से पहली या आख़िरी शीट लौटाई जाती है।

सैंपल कोड

function main(workbook: ExcelScript.Workbook) {
  /** वर्कबुक की पहली वर्कशीट */
  const firstSheet = workbook.getFirstWorksheet();

  /** वर्कबुक में दिखाई देने वाली वर्कशीट में से आख़िरी वर्कशीट */
  const lastSheet = workbook.getLastWorksheet(true);
}