Class NamedRange

NamedRange

나중에 검색할 수 있도록 이름과 ID가 있는 Range입니다. 이름은 반드시 고유하지는 않습니다. HTML의 클래스와 마찬가지로 동일한 탭에 있는 여러 범위가 동일한 이름을 공유할 수 있습니다. 반대로 ID는 HTML의 ID와 마찬가지로 탭 내에서 고유합니다. NamedRange가 탭에 추가되면 수정할 수 없고 삭제만 가능합니다.

NamedRange는 탭에 액세스하는 모든 스크립트에서 액세스할 수 있습니다. 스크립트 간의 의도하지 않은 충돌을 방지하려면 범위 이름에 고유한 문자열을 접두사로 추가하는 것이 좋습니다. 

// Create a named range that includes every table in the active tab.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
documentTab.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());

메서드

메서드반환 유형간략한 설명
getId()String이 NamedRange의 ID를 가져옵니다.
getName()String이 NamedRange의 이름을 가져옵니다.
getRange()Range이 NamedRange와 연결된 요소의 범위를 가져옵니다.
remove()void탭에서 이 NamedRange를 삭제합니다.

자세한 문서

getId()

이 NamedRange의 ID를 가져옵니다. ID는 탭 내에서 고유합니다.

리턴

String — 탭 내에서 고유한 범위의 ID입니다.

getName()

이 NamedRange의 이름을 가져옵니다. 이름은 반드시 고유하지는 않습니다.

리턴

String — 반드시 고유하지는 않은 범위의 이름입니다.

승인

이 메서드를 사용하는 스크립트는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

getRange()

이 NamedRange와 연결된 요소의 범위를 가져옵니다.

리턴

Range — 이름 및 ID와 연결된 요소의 범위입니다.

승인

이 메서드를 사용하는 스크립트는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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

remove()

탭에서 이 NamedRange를 삭제합니다. 이 메서드는 범위의 콘텐츠를 삭제하지 않고 참조만 삭제합니다. 이미 삭제된 NamedRange에서 이 메서드를 호출해도 아무런 효과가 없습니다.

승인

이 메서드를 사용하는 스크립트는 다음 범위 중 하나 이상으로 승인이 필요합니다.

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