Class TextFinder

TextFinder

ค้นหาหรือแทนที่ข้อความภายในช่วง ชีต หรือสเปรดชีต นอกจากนี้ยังระบุตัวเลือกการค้นหาได้ด้วย

เมธอด

วิธีการประเภทการแสดงผลรายละเอียดแบบย่อ
findAll()Range[]แสดงผลเซลล์ทั้งหมดที่ตรงกับเกณฑ์การค้นหา
findNext()Rangeแสดงผลเซลล์ถัดไปที่ตรงกับเกณฑ์การค้นหา
findPrevious()Rangeแสดงผลเซลล์ก่อนหน้าซึ่งตรงกับเกณฑ์การค้นหา
getCurrentMatch()Rangeแสดงผลเซลล์ปัจจุบันที่ตรงกับเกณฑ์การค้นหา
ignoreDiacritics(ignoreDiacritics)TextFinderหาก true จะกำหนดค่าการค้นหาให้ไม่สนใจเครื่องหมายกำกับเสียงขณะจับคู่ มิฉะนั้นการค้นหา จะจับคู่เครื่องหมายกำกับเสียง
matchCase(matchCase)TextFinderหาก true จะกำหนดค่าการค้นหาให้ตรงกับตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ของข้อความค้นหาอย่างแน่นอน ไม่เช่นนั้น การค้นหาจะใช้การจับคู่แบบไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่โดยค่าเริ่มต้น
matchEntireCell(matchEntireCell)TextFinderหาก true จะกำหนดค่าการค้นหาให้ตรงกับเนื้อหาทั้งหมดของเซลล์ มิฉะนั้นการค้นหาจะใช้การจับคู่บางส่วนเป็นค่าเริ่มต้น
matchFormulaText(matchFormulaText)TextFinderหาก true จะกำหนดค่าการค้นหาให้แสดงผลรายการที่ตรงกันซึ่งปรากฏในข้อความสูตร มิฉะนั้น ระบบจะพิจารณาเซลล์ที่มีสูตรตามค่าที่แสดง
replaceAllWith(replaceText)Integerแทนที่รายการที่ตรงกันทั้งหมดด้วยข้อความที่ระบุ
replaceWith(replaceText)Integerแทนที่ข้อความค้นหาในเซลล์ที่ตรงกันในปัจจุบันด้วยข้อความที่ระบุ และแสดงผล จำนวนครั้งที่แทนที่
startFrom(startRange)TextFinderกำหนดค่าการค้นหาให้เริ่มค้นหาทันทีหลังจากช่วงเซลล์ที่ระบุ
useRegularExpression(useRegEx)TextFinderหากเป็น true จะกำหนดค่าการค้นหาให้ตีความสตริงการค้นหาเป็นนิพจน์ทั่วไป ไม่เช่นนั้น การค้นหาจะตีความสตริงการค้นหาเป็นข้อความปกติ

เอกสารโดยละเอียด

findAll()

แสดงผลเซลล์ทั้งหมดที่ตรงกับเกณฑ์การค้นหา

รีเทิร์น

Range[] — เซลล์ที่ตรงกันทั้งหมด

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

findNext()

แสดงผลเซลล์ถัดไปที่ตรงกับเกณฑ์การค้นหา

รีเทิร์น

Range — เซลล์ถัดไปที่ตรงกัน หรือ null หากไม่มีเซลล์ก่อนหน้าที่ตรงกัน

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

findPrevious()

แสดงผลเซลล์ก่อนหน้าซึ่งตรงกับเกณฑ์การค้นหา

รีเทิร์น

Range — เซลล์ที่ตรงกันก่อนหน้า หรือ null หากไม่มีรายการที่ตรงกันก่อนหน้า

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

getCurrentMatch()

แสดงผลเซลล์ปัจจุบันที่ตรงกับเกณฑ์การค้นหา

รีเทิร์น

Range — เซลล์ที่ตรงกันในปัจจุบัน หรือ null หากไม่มีรายการที่ตรงกันอีก

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

ignoreDiacritics(ignoreDiacritics)

หาก true จะกำหนดค่าการค้นหาให้ไม่สนใจเครื่องหมายกำกับเสียงขณะจับคู่ มิฉะนั้นการค้นหา จะจับคู่เครื่องหมายกำกับเสียง เครื่องหมายแสดงการออกเสียงคือเครื่องหมาย เช่น เครื่องหมายเน้นเสียงหรือเซดิลลา ซึ่งเมื่อเขียนไว้เหนือหรือใต้ตัวอักษรจะแสดงถึงความแตกต่างในการออกเสียงจากตัวอักษรเดียวกันเมื่อไม่มีเครื่องหมายหรือมีเครื่องหมายต่างกัน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
ignoreDiacriticsBooleanการค้นหาพิจารณาเครื่องหมายกำกับเสียงหรือไม่

รีเทิร์น

TextFinder — เครื่องมือค้นหาข้อความนี้สำหรับการเชื่อมโยง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

matchCase(matchCase)

หาก true จะกำหนดค่าการค้นหาให้ตรงกับตัวพิมพ์เล็กและตัวพิมพ์ใหญ่ของข้อความค้นหาอย่างแน่นอน ไม่เช่นนั้น การค้นหาจะใช้การจับคู่แบบไม่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่โดยค่าเริ่มต้น

พารามิเตอร์

ชื่อประเภทคำอธิบาย
matchCaseBooleanการจับคู่คำนึงถึงตัวพิมพ์เล็กและตัวพิมพ์ใหญ่หรือไม่

รีเทิร์น

TextFinder — เครื่องมือค้นหาข้อความนี้สำหรับการเชื่อมโยง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

matchEntireCell(matchEntireCell)

หาก true จะกำหนดค่าการค้นหาให้ตรงกับเนื้อหาทั้งหมดของเซลล์ มิฉะนั้นการค้นหาจะใช้การจับคู่บางส่วนเป็นค่าเริ่มต้น

พารามิเตอร์

ชื่อประเภทคำอธิบาย
matchEntireCellBooleanจับคู่ทั้งเซลล์หรือไม่

รีเทิร์น

TextFinder — เครื่องมือค้นหาข้อความนี้สำหรับการเชื่อมโยง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

matchFormulaText(matchFormulaText)

หาก true จะกำหนดค่าการค้นหาให้แสดงผลรายการที่ตรงกันซึ่งปรากฏในข้อความสูตร มิฉะนั้น ระบบจะพิจารณาเซลล์ที่มีสูตรตามค่าที่แสดง

พารามิเตอร์

ชื่อประเภทคำอธิบาย
matchFormulaTextBooleanการค้นหาจะตรวจสอบข้อความสูตรหรือไม่

รีเทิร์น

TextFinder — เครื่องมือค้นหาข้อความนี้สำหรับการเชื่อมโยง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

replaceAllWith(replaceText)

แทนที่รายการที่ตรงกันทั้งหมดด้วยข้อความที่ระบุ แสดงผลจำนวนครั้งที่แทนที่ ซึ่งอาจแตกต่างจากจำนวนเซลล์ที่ตรงกัน

พารามิเตอร์

ชื่อประเภทคำอธิบาย
replaceTextStringข้อความที่จะแทนที่ข้อความในเซลล์ที่ตรงกัน

รีเทิร์น

Integer — จำนวนการเกิดเหตุการณ์ที่ถูกแทนที่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

replaceWith(replaceText)

แทนที่ข้อความค้นหาในเซลล์ที่ตรงกันในปัจจุบันด้วยข้อความที่ระบุ และแสดงผล จำนวนครั้งที่แทนที่

พารามิเตอร์

ชื่อประเภทคำอธิบาย
replaceTextStringข้อความที่จะแทนที่เนื้อหาในเซลล์ที่ตรงกันในปัจจุบัน

รีเทิร์น

Integer — จำนวนการเกิดเหตุการณ์ที่ถูกแทนที่

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

startFrom(startRange)

กำหนดค่าการค้นหาให้เริ่มค้นหาทันทีหลังจากช่วงเซลล์ที่ระบุ

พารามิเตอร์

ชื่อประเภทคำอธิบาย
startRangeRangeช่วงเซลล์ที่ควรเริ่มการค้นหา

รีเทิร์น

TextFinder — เครื่องมือค้นหาข้อความนี้สำหรับการเชื่อมโยง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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

useRegularExpression(useRegEx)

หากเป็น true จะกำหนดค่าการค้นหาให้ตีความสตริงการค้นหาเป็นนิพจน์ทั่วไป ไม่เช่นนั้น การค้นหาจะตีความสตริงการค้นหาเป็นข้อความปกติ ดูรายละเอียดเพิ่มเติมเกี่ยวกับวิธีใช้ นิพจน์ทั่วไปได้ที่ หน้าสนับสนุนการค้นหาและแทนที่

พารามิเตอร์

ชื่อประเภทคำอธิบาย
useRegExBooleanจะตีความสตริงการค้นหาเป็นนิพจน์ทั่วไปหรือไม่

รีเทิร์น

TextFinder — เครื่องมือค้นหาข้อความนี้สำหรับการเชื่อมโยง

การให้สิทธิ์

สคริปต์ที่ใช้วิธีนี้ต้องมีการให้สิทธิ์ที่มีขอบเขตต่อไปนี้อย่างน้อย 1 รายการ

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