Word.Range

Word.Range은 Word 모듈(Office.word(iframe))의 객체 타입입니다. 메서드 50개.

Generated from the SDK type definitions

Word · 객체 타입 14개 · 메서드 259개 · 네임스페이스 Word. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.

비고

모듈: Word · Office.word(iframe) · 네임스페이스 Word
얻는 방법: Document.getRange(options), Document.getSelection(), Body.getRange(range), Body.insertHtml(html, options), Body.insertText(text, options), Body.search(query, options), Paragraph.getRange(startOffset, endOffset), Paragraph.insertText(text, options), Shape.getRange(), Image.getRange(), Bookmark.getRange(), Hyperlink.getRange()
모든 메서드는 Promise를 반환하며, 시그니처는 TypeScript 표기입니다.

메서드

메서드	설명
`acceptChangeTrackings()`	이 범위와 겹치는 모든 변경 추적 항목을 수락한다.
`clearFormat()`	범위의 글자 서식과 단락 서식을 초기화한다.
`clearList()`	범위에 걸친 단락들의 목록을 해제한다.
`copyFormatTo(targetRange)`	이 범위 시작 위치의 스타일과 서식(글자+단락)을 대상 범위에 복사해 적용한다.
`delete()`	범위의 텍스트를 삭제한다.
`getBookmarks()`	범위 안에 마커가 놓인 책갈피 목록을 반환한다.
`getChangeTrackings()`	이 범위와 겹치는 변경 추적 항목 목록을 문서 순서로 반환한다.
`getComments()`	이 범위와 겹치는 댓글 목록을 반환한다.
`getContentHtml()`	이 범위에 걸친 단락 내용을 서식이 포함된 HTML로 반환한다.
`getEndnotes()`	이 범위 안의 미주 목록을 반환한다.
`getFootnotes()`	이 범위 안의 각주 목록을 반환한다.
`getFormat()`	이 범위 시작 위치의 글자 서식과 단락 서식을 반환한다.
`getHyperlink()`	이 범위에 걸린 하이퍼링크를 반환한다.
`getHyperlinks()`	이 범위와 겹치는 텍스트 하이퍼링크 목록을 반환한다.
`getLocation()`	이 범위의 시작/끝 위치를 단락 좌표로 반환한다.
`getNotes()`	이 범위 안의 각주·미주 목록을 반환한다.
`getParagraph()`	이 범위의 시작 단락을 반환한다.
`getParentSection()`	이 범위의 시작 위치가 속한 구역을 반환한다.
`getShapes()`	이 범위 안의 도형·이미지·차트 목록을 반환한다.
`getStructure()`	이 범위가 걸친 단락/표 구조를 반환한다.
`getText()`	이 범위에 포함된 텍스트를 반환한다.
`insertBookmark(name)`	이 범위 시작 위치에 책갈피를 삽입한다.
`insertColumnBreak()`	이 범위 위치에 단 나누기를 삽입한다.
`insertComment(text, options)`	이 범위에 댓글을 삽입한다.
`insertEndnote(text)`	이 범위 끝에 미주를 삽입한다.
`insertFootnote(text)`	이 범위 끝에 각주를 삽입한다.
`insertHyperlink(url, options)`	이 범위에 하이퍼링크를 건다.
`insertImage(options)`	이 범위 시작 위치에 이미지를 글자처럼 배치해 삽입한다.
`insertLineBreak()`	이 범위 시작 위치에 줄 나누기를 삽입한다.
`insertPageBreak()`	이 범위 위치에 페이지 나누기를 삽입한다.
`insertParagraph(text, options)`	이 범위의 기준 단락 위·아래에 새 단락을 삽입한다.
`insertSectionBreak(type)`	이 범위 위치에 구역 나누기를 삽입해 새 구역을 만든다.
`insertShape(preset, options)`	이 범위의 단락에 지정한 모양의 도형을 삽입한다.
`insertSymbol(charCode, options)`	이 범위 시작 위치에 기호를 삽입한다.
`insertTab()`	이 범위 시작 위치에 탭 문자를 삽입한다.
`insertTable(rows, columns, options)`	범위의 단락 기준으로 표를 삽입한다.
`insertText(text, options)`	이 범위에 텍스트를 넣는다.
`insertTextbox(options)`	범위의 단락에 텍스트박스를 삽입한다.
`insertWebVideo(url, options)`	이 범위 시작 위치에 웹 동영상을 글자처럼 배치해 삽입한다.
`isCollapsed()`	이 범위가 시작과 끝이 같은 빈 범위인지 확인한다.
`rejectChangeTrackings()`	이 범위와 겹치는 모든 변경 추적 항목을 거부한다.
`search(query, options)`	이 범위 안에서 텍스트 또는 특수 문자(페이지 나누기/단 나누기/줄바꿈/탭/기호)를 찾아, 편집할 수 있는 범위를 반환한다.
`select(mode)`	이 범위를 화면 선택 영역으로 지정한다.
`setIndent(type)`	범위에 걸친 단락들의 들여쓰기/내어쓰기를 한 단계 조정한다.
`setList(listType)`	이 범위에 걸친 단락들에 목록 서식을 적용한다.
`setParagraphBorder(border)`	이 범위에 걸친 단락들에 테두리를 설정한다.
`setParagraphFormat(options)`	이 범위에 걸친 단락들에 단락 서식을 적용한다.
`setStyle(style)`	이 범위에 스타일을 적용한다.
`setTabs(tabs)`	이 범위에 걸친 단락들의 탭 정지 위치를 설정한다.
`setTextFormat(options)`	범위에 글자 서식을 적용한다.

메서드 상세

`acceptChangeTrackings()`

이 범위와 겹치는 모든 변경 추적 항목을 수락한다.

acceptChangeTrackings(): Promise<{ processedCount: number; remainingCount: number; failedIds: string[] }>;

반환값

Promise<{ processedCount: number; remainingCount: number; failedIds: string[] }> - 처리 결과

`clearFormat()`

범위의 글자 서식과 단락 서식을 초기화한다. - 단락 서식은 단락 기호가 범위에 포함된 단락만 초기화한다.

clearFormat(): Promise<void>;

반환값

Promise<void>

`clearList()`

범위에 걸친 단락들의 목록을 해제한다.

clearList(): Promise<void>;

반환값

Promise<void>

`copyFormatTo(targetRange)`

이 범위 시작 위치의 스타일과 서식(글자+단락)을 대상 범위에 복사해 적용한다.
기준은 이 범위의 시작 지점 한 곳에서만 읽는다 - 범위가 여러 단락에 걸쳐도 첫 단락의 서식만 가져온다.
대상 단락 서식도 같은 이유로 대상 범위의 첫 단락에만 걸린다.
대상이 빈 단락이거나 커서면 단락 서식만 걸리고 글자 서식은 걸리지 않는다 - 서식을 입힐 글자가 없기 때문이며, 그 단락에 나중에 넣는 글자도 기준의 글자 서식을 따라가지 않는다.

copyFormatTo(targetRange: WordRange): Promise<void>;

매개변수

이름	타입	설명
`targetRange`	`WordRange`	서식을 적용받을 범위

반환값

Promise<void>

`delete()`

범위의 텍스트를 삭제한다.

delete(): Promise<void>;

반환값

Promise<void>

`getBookmarks()`

범위 안에 마커가 놓인 책갈피 목록을 반환한다.

getBookmarks(): Promise<Bookmark[]>;

반환값

Promise<Bookmark[]> - 책갈피 목록(없으면 빈 배열)

`getChangeTrackings()`

이 범위와 겹치는 변경 추적 항목 목록을 문서 순서로 반환한다.

getChangeTrackings(): Promise<WordChangeTracking[]>;

반환값

Promise<WordChangeTracking[]> - 변경 추적 목록

`getComments()`

이 범위와 겹치는 댓글 목록을 반환한다.

getComments(): Promise<WordComment[]>;

반환값

Promise<WordComment[]> - 댓글 목록

`getContentHtml()`

이 범위에 걸친 단락 내용을 서식이 포함된 HTML로 반환한다. - 시작 단락부터 끝 단락까지 문서 순서로 포함하며, 표 안의 단락도 <p> 요소로 표현한다.

getContentHtml(): Promise<{ html: string; paragraphCount: number }>;

반환값

Promise<{ html: string; paragraphCount: number }> - 범위 HTML·단락 수

`getEndnotes()`

이 범위 안의 미주 목록을 반환한다.

getEndnotes(): Promise<WordNote[]>;

반환값

Promise<WordNote[]> - 미주 목록

`getFootnotes()`

이 범위 안의 각주 목록을 반환한다.

getFootnotes(): Promise<WordNote[]>;

반환값

Promise<WordNote[]> - 각주 목록

`getFormat()`

이 범위 시작 위치의 글자 서식과 단락 서식을 반환한다. - 범위 안의 서식이 서로 달라도 시작 위치의 직접 서식을 반환한다.

getFormat(): Promise<{ textFormat?: TextFormat; paragraphFormat?: ParagraphFormat }>;

반환값

Promise<{ textFormat?: TextFormat; paragraphFormat?: ParagraphFormat }> - 시작 위치의 글자·단락 서식(없는 항목은 생략)

`getHyperlink()`

이 범위에 걸린 하이퍼링크를 반환한다.
시작 지점의 링크를 쓰고, 시작 지점에 링크가 없으면 끝 지점의 링크를 쓴다. 그래서 범위가 여러 링크를 걸치면 시작 링크가 나온다.
두 끝 지점만 본다 - 어느 지점에도 닿지 않고 범위 안에만 들어 있는 링크는 찾지 않는다.

getHyperlink(): Promise<Hyperlink>;

반환값

Promise<Hyperlink> - 하이퍼링크 객체, 두 지점 모두 링크가 없으면 null

`getHyperlinks()`

이 범위와 겹치는 텍스트 하이퍼링크 목록을 반환한다.

getHyperlinks(): Promise<Hyperlink[]>;

반환값

Promise<Hyperlink[]> - 하이퍼링크 목록(없으면 빈 배열)

`getLocation()`

이 범위의 시작/끝 위치를 단락 좌표로 반환한다. - 선택·커서·각주 마커처럼 좌표 없이 만든 범위도 현재 위치를 계산해 돌려준다. 반환 형태가 getRange 인자와 같아, 그대로 넘기면 같은 범위를 다시 만든다.

getLocation(): Promise<{ startParaId: string; startOffset: number; endParaId: string; endOffset: number; storyId: string }>;

반환값

Promise<{ startParaId: string; startOffset: number; endParaId: string; endOffset: number; storyId: string }> - 시작/끝 단락 ID·글자 offset·영역 ID

`getNotes()`

이 범위 안의 각주·미주 목록을 반환한다.

getNotes(): Promise<WordNote[]>;

반환값

Promise<WordNote[]> - 각주·미주 목록

`getParagraph()`

이 범위의 시작 단락을 반환한다.
반환된 단락을 통해 단락 전체의 내용과 서식을 편집한다.
좌표 범위는 여기서 검사하지 않는다 - 없는 단락 ID 면 반환된 단락을 사용할 때 오류가 난다.

getParagraph(): Promise<Paragraph>;

반환값

Promise<Paragraph> - 시작 단락 객체

`getParentSection()`

이 범위의 시작 위치가 속한 구역을 반환한다. - 머리글·바닥글 등 본문 밖에서 구역을 특정할 수 없으면 null을 반환한다.

getParentSection(): Promise<Section>;

반환값

Promise<Section> - 구역 객체, 본문 구역을 찾을 수 없으면 null

`getShapes()`

이 범위 안의 도형·이미지·차트 목록을 반환한다. - 글자처럼 배치한 도형과 글 앞·뒤에 배치한 도형을 모두 포함한다.

getShapes(): Promise<Shape[]>;

반환값

Promise<Shape[]> - 도형 목록(그림은 WordImage, 차트는 WordChart, 없으면 빈 배열)

`getStructure()`

이 범위가 걸친 단락/표 구조를 반환한다. - 범위 시작 단락부터 끝 단락까지(사이의 표 포함)를 문서 순서로 담는다.

getStructure(): Promise<{ paragraphs: { index: number; type: string; id: string; storyId: string; text?: string; rows?: number; columns?: number }[] }>;

반환값

Promise<{ paragraphs: { index: number; type: string; id: string; storyId: string; text?: string; rows?: number; columns?: number }[] }> - 범위가 걸친 단락·표 항목 목록

`getText()`

이 범위에 포함된 텍스트를 반환한다.
단락 경계는 "\n"으로 구분한다. 한 단락 안에서는 반환 텍스트의 글자 위치에 getLocation().startOffset을 더해 단락의 글자 위치를 구한다.
여러 단락에 걸친 범위에서는 이 계산을 사용할 수 없다.
탭은 "\t", 줄·페이지·단 나누기는 "\n", 각주·도형 등의 개체는 "" 한 글자로 표현한다.

getText(): Promise<string>;

반환값

Promise<string> - 범위 텍스트(빈 범위/커서면 "")

`insertBookmark(name)`

이 범위 시작 위치에 책갈피를 삽입한다. - 같은 이름의 책갈피가 있으면 교체한다. 이름은 숫자·특수문자·공백으로 시작할 수 없다.

insertBookmark(name: string): Promise<Bookmark>;

매개변수

이름	타입	설명
`name`	`string`	책갈피 이름

반환값

Promise<Bookmark> - 삽입된 책갈피

`insertColumnBreak()`

이 범위 위치에 단 나누기를 삽입한다. - 뒤 내용은 다음 단에서 시작하며, 구역이 1단이면 다음 페이지에서 시작한다. 본문에만 삽입할 수 있다.

insertColumnBreak(): Promise<void>;

반환값

Promise<void>

`insertComment(text, options)`

이 범위에 댓글을 삽입한다.

insertComment(
  text: string,
  options?: { authorName?: string; initials?: string }
): Promise<WordComment>;

매개변수

이름	타입	설명
`text`	`string`	댓글 본문
`options` (선택)	`{ authorName?: string; initials?: string }`	작성자 메타데이터

반환값

Promise<WordComment> - 삽입된 댓글

`insertEndnote(text)`

이 범위 끝에 미주를 삽입한다. - 표시는 본문에 넣고, 내용은 문서 끝의 미주 영역에 넣는다.

insertEndnote(text?: string): Promise<WordNote>;

매개변수

이름	타입	설명
`text` (선택)	`string`	미주 내용 초기 텍스트(기본은 빈 미주) (기본값: empty endnote)

반환값

Promise<WordNote> - 생성된 미주 객체

`insertFootnote(text)`

이 범위 끝에 각주를 삽입한다. - 표시는 본문에 넣고, 내용은 해당 페이지 하단의 각주 영역에 넣는다.

insertFootnote(text?: string): Promise<WordNote>;

매개변수

이름	타입	설명
`text` (선택)	`string`	각주 내용 초기 텍스트(기본은 빈 각주) (기본값: empty footnote)

반환값

Promise<WordNote> - 생성된 각주 객체

`insertHyperlink(url, options)`

이 범위에 하이퍼링크를 건다.
displayText 를 주면 그 텍스트가 범위 텍스트를 대체하며 링크를 갖는다. 없으면 범위의 기존 텍스트에 그대로 링크를 입힌다.
빈 범위는 링크를 입힐 텍스트가 없으므로 displayText 가 필수다.
링크 종류는 url 을 보고 자동으로 정해진다(웹 http(s)://·이메일 mailto:·북마크 #name, 스킴 없으면 https://).

insertHyperlink(
  url: string,
  options?: { tooltip?: string; displayText?: string }
): Promise<Hyperlink>;

매개변수

이름	타입	설명
`url`	`string`	링크 목적지
`options` (선택)	`{ tooltip?: string; displayText?: string }`	하이퍼링크 옵션
`options.tooltip` (선택)	`string`	마우스오버 툴팁 (기본값: url)
`options.displayText` (선택)	`string`	범위 텍스트 대신 보여줄 텍스트(빈 범위면 필수)

반환값

Promise<Hyperlink> - 삽입된 하이퍼링크, 신규 id 식별 실패 시 null

`insertImage(options)`

이 범위 시작 위치에 이미지를 글자처럼 배치해 삽입한다. - 이미지 출처와 관계없이 비동기로 처리한다.

insertImage(options: { src?: string; url?: string; base64?: string; width?: number; height?: number }): Promise<Image>;

매개변수

이름	타입	설명
`options`	`{ src?: string; url?: string; base64?: string; width?: number; height?: number }`	이미지 삽입 옵션 (출처 src/url/base64 중 정확히 하나 필수)
`options.src` (선택)	`string`	이미 업로드된 이미지 경로
`options.url` (선택)	`string`	이미지 URL (선업로드 후 삽입)
`options.base64` (선택)	`string`	base64 데이터 (선업로드 후 삽입)
`options.width` (선택)	`number`	너비(pt). url/base64 는 생략 시 원본 크기, src 는 원본 크기를 알 수 없어 필수 (기본값: original size)
`options.height` (선택)	`number`	높이(pt). url/base64 는 생략 시 원본 크기, src 는 원본 크기를 알 수 없어 필수 (기본값: original size)

반환값

Promise<Image> - 삽입된 이미지

`insertLineBreak()`

이 범위 시작 위치에 줄 나누기를 삽입한다. - Shift+Enter처럼 단락을 유지하면서 줄만 바꾼다.

insertLineBreak(): Promise<void>;

반환값

Promise<void>

`insertPageBreak()`

이 범위 위치에 페이지 나누기를 삽입한다. - 뒤 내용은 다음 페이지에서 시작한다. 본문에만 삽입할 수 있다.

insertPageBreak(): Promise<void>;

반환값

Promise<void>

`insertParagraph(text, options)`

이 범위의 기준 단락 위·아래에 새 단락을 삽입한다.
새 단락은 기준 단락의 정렬·여백·들여쓰기 등 직접 단락 서식을 상속한다.
상속한 직접 서식을 초기화하려면 반환된 단락의 clearFormat()을 호출한다.

insertParagraph(text: string, options?: { position?: InsertAt }): Promise<Paragraph>;

매개변수

이름	타입	설명
`text`	`string`	새 단락 텍스트
`options` (선택)	`{ position?: InsertAt }`	삽입 옵션
`options.position` (선택)	`InsertAt`	범위 단락 기준 "before"(위)/"after"(아래) (기본값: InsertAt.AFTER)

반환값

Promise<Paragraph> - 새로 생성된 단락 객체

`insertSectionBreak(type)`

이 범위 위치에 구역 나누기를 삽입해 새 구역을 만든다. - 구역 나누기는 본문에만 삽입할 수 있다(머리글/바닥글/텍스트박스에는 불가).

insertSectionBreak(type: SectionBreakType): Promise<void>;

매개변수

이름	타입	설명
`type`	`SectionBreakType`	새 구역의 시작 유형 (continuous: 이어서 / nextPage: 다음 페이지부터 / evenPage: 짝수 페이지부터 / oddPage: 홀수 페이지부터)

반환값

Promise<void>

`insertShape(preset, options)`

이 범위의 단락에 지정한 모양의 도형을 삽입한다. - 반환된 도형으로 서식과 배치를 설정한다.

insertShape(preset: ShapePreset, options?: Size): Promise<Shape>;

매개변수

이름	타입	설명
`preset`	`ShapePreset`	도형의 기본 모양 (예: "rect", "ellipse", "roundRect")
`options` (선택)	`Size`	크기(pt, 생략한 축은 75)

반환값

Promise<Shape> - 삽입된 도형

`insertSymbol(charCode, options)`

이 범위 시작 위치에 기호를 삽입한다.
font 미지정: 해당 유니코드 문자를 일반 텍스트로 삽입한다.
font 지정: 그 글꼴의 기호 글리프로 삽입한다.

insertSymbol(charCode: string | number, options?: { font?: string }): Promise<void>;

매개변수

이름	타입	설명
`charCode`	`string \| number`	유니코드 코드포인트(16진 문자열 "2605" \| "0x2605" \| 숫자 0x2605)
`options` (선택)	`{ font?: string }`	font 지정 시 그 글꼴의 기호로 삽입

반환값

Promise<void>

`insertTab()`

이 범위 시작 위치에 탭 문자를 삽입한다. - 탭 정지 위치는 setTabs()로 별도 설정한다.

insertTab(): Promise<void>;

반환값

Promise<void>

`insertTable(rows, columns, options)`

범위의 단락 기준으로 표를 삽입한다. - 표 셀 안에는 삽입할 수 없다(중첩 표 미지원 - 삽입 지점이 셀 안이면 오류 발생).

insertTable(
  rows: number,
  columns: number,
  options?: { position?: InsertAt; values?: string[][] }
): Promise<Table>;

매개변수

이름	타입	설명
`rows`	`number`	행 수
`columns`	`number`	열 수
`options` (선택)	`{ position?: InsertAt; values?: string[][] }`	삽입 옵션
`options.position` (선택)	`InsertAt`	범위 단락 기준 "before"(위)/"after"(아래) (기본값: InsertAt.AFTER)
`options.values` (선택)	`string[][]`	생성 직후 채울 셀 값(2차원 배열, 표 크기 초과 시 발행 전 오류 발생)

반환값

Promise<Table> - 삽입된 표 객체

`insertText(text, options)`

이 범위에 텍스트를 넣는다.
replace 미지정: 범위의 한쪽 끝 지점에 삽입한다(구간이어도 원래 텍스트는 남는다). position 으로 어느 끝인지 정한다.
replace: true: 범위 텍스트를 새 텍스트로 교체한다(한 지점이면 그 자리에 삽입, position 무시). 텍스트만 다루며 서식은 그대로 둔다. 서식 변경은 반환된 범위에 따로 적용한다.

insertText(text: string, options?: { position?: InsertAt; replace?: boolean }): Promise<Range>;

매개변수

이름	타입	설명
`text`	`string`	넣을 텍스트
`options` (선택)	`{ position?: InsertAt; replace?: boolean }`	삽입/교체 옵션
`options.position` (선택)	`InsertAt`	범위 기준 "before"(시작 지점, 매치 앞) / "after"(끝 지점, 매치 뒤). replace:true 면 무시. (기본값: InsertAt.BEFORE)
`options.replace` (선택)	`boolean`	true 면 범위 텍스트를 새 텍스트로 교체(position 무시)

반환값

Promise<Range> - 삽입되거나 교체된 새 텍스트 범위(반환 범위에 setTextFormat 등을 바로 적용할 수 있다)

`insertTextbox(options)`

범위의 단락에 텍스트박스를 삽입한다.

insertTextbox(options?: Size & { text?: String }): Promise<{ shape: WordShape; storyId: string; paragraphId: string }>;

매개변수

이름	타입	설명
`options` (선택)	`Size & { text?: String }`	텍스트박스 생성 옵션 (크기 생략한 축은 100, text 는 초기 내용)

반환값

Promise<{ shape: WordShape; storyId: string; paragraphId: string }> - 생성 결과 (shape: 도형 객체 / storyId: 텍스트박스 영역 ID / paragraphId: 첫 단락 ID)

`insertWebVideo(url, options)`

이 범위 시작 위치에 웹 동영상을 글자처럼 배치해 삽입한다.
YouTube와 3DS 3DEXPERIENCE 주소를 지원하며 비동기로 처리한다.
미리보기 이미지를 가져올 수 없으면 대체 이미지를 사용한다.

insertWebVideo(url: string, options?: Size): Promise<Image>;

매개변수

이름	타입	설명
`url`	`string`	웹 동영상 URL (YouTube / 3DS 3DEXPERIENCE)
`options` (선택)	`Size`	크기(pt, 기본은 썸네일 원본 크기) (기본값: thumbnail original size)

반환값

Promise<Image> - 삽입된 웹 동영상 이미지 객체

`isCollapsed()`

이 범위가 시작과 끝이 같은 빈 범위인지 확인한다. - 커서만 있는 범위는 true, 선택한 글자나 검색 결과를 포함하는 범위는 false를 반환한다.

isCollapsed(): Promise<boolean>;

반환값

Promise<boolean> - 빈 범위이면 true

`rejectChangeTrackings()`

이 범위와 겹치는 모든 변경 추적 항목을 거부한다.

rejectChangeTrackings(): Promise<{ processedCount: number; remainingCount: number; failedIds: string[] }>;

반환값

Promise<{ processedCount: number; remainingCount: number; failedIds: string[] }> - 처리 결과

`search(query, options)`

이 범위 안에서 텍스트 또는 특수 문자(페이지 나누기/단 나누기/줄바꿈/탭/기호)를 찾아, 편집할 수 있는 범위를 반환한다.

search(
  query: string | { character: SpecialCharacter },
  options?: { caseSensitive?: boolean; wholeWord?: boolean }
): Promise<Range[]>;

매개변수

이름	타입	설명
`query`	`string \| { character: SpecialCharacter }`	문자열이면 텍스트 검색, `\{ character \}` 객체이면 특수 문자 검색
`options` (선택)	`{ caseSensitive?: boolean; wholeWord?: boolean }`	텍스트 검색 옵션(특수 문자 검색은 무시)
`options.caseSensitive` (선택)	`boolean`	대소문자 구분 (기본값: false)
`options.wholeWord` (선택)	`boolean`	단어 단위 검색 (매치 앞뒤가 공백·문장부호·문서 경계일 때만 채택) (기본값: false)

반환값

Promise<Range[]> - 이 범위 안에서 매칭된 범위 목록 (없으면 빈 배열)

`select(mode)`

이 범위를 화면 선택 영역으로 지정한다. - 문서 내용은 변경하지 않는다.

select(mode?: SelectionMode): Promise<void>;

매개변수

이름	타입	설명
`mode` (선택)	`SelectionMode`	"select"(범위 전체) / "start"(시작 지점에 커서) / "end"(끝 지점에 커서) (기본값: SelectionMode.SELECT)

반환값

Promise<void>

`setIndent(type)`

범위에 걸친 단락들의 들여쓰기/내어쓰기를 한 단계 조정한다.
목록 단락이면 목록 단계가, 목록이 아니면 단락 좌여백이 움직인다.
시작 단락이 목록 첫 항목이어도 그 항목의 단계만 움직인다.

setIndent(type: IndentType): Promise<void>;

매개변수

이름	타입	설명
`type`	`IndentType`	"indent"(들여쓰기)\|"outdent"(내어쓰기)

반환값

Promise<void>

`setList(listType)`

이 범위에 걸친 단락들에 목록 서식을 적용한다.
빈 범위는 커서가 있는 단락에 적용한다. 여러 단락을 포함하면 해당 단락 전체에 적용한다.
커서가 기존 목록 안에 있으면 같은 목록의 같은 단계 항목도 함께 바뀐다. 다단계 목록은 목록 전체에 반영한다.

setList(listType: ListType): Promise<void>;

매개변수

이름	타입	설명
`listType`	`ListType`	적용할 목록 종류. 기본 제공 글머리 기호·번호·다단계 목록 중 선택한다.

반환값

Promise<void>

`setParagraphBorder(border)`

이 범위에 걸친 단락들에 테두리를 설정한다. - 셀 테두리와 같은 Border 형식을 사용하며 location으로 적용할 면을 지정한다.

setParagraphBorder(border: Border): Promise<void>;

매개변수

이름	타입	설명
`border`	`Border`	테두리 값 (단락·셀·페이지 공용)

반환값

Promise<void>

`setParagraphFormat(options)`

이 범위에 걸친 단락들에 단락 서식을 적용한다. - 지정한 필드만 변경하며, null은 해당 속성을 제거해 스타일의 서식을 따르게 한다.

setParagraphFormat(options: ParagraphFormat): Promise<void>;

매개변수

이름	타입	설명
`options`	`ParagraphFormat`	적용할 단락 서식

반환값

Promise<void>

`setStyle(style)`

이 범위에 스타일을 적용한다. - 기존 직접 서식은 초기화한다. 단락 스타일은 범위에 걸친 단락들에, 글자 스타일은 범위 텍스트에 적용한다.

setStyle(style: Style | string | null): Promise<void>;

매개변수

이름	타입	설명
`style`	`Style \| string \| null`	내장 스타일은 Style enum(값=키), 커스텀 문서 스타일은 getStyles() 의 style 값. null 이면 글자 스타일만 제거, 단락 스타일은 유지.

반환값

Promise<void>

`setTabs(tabs)`

이 범위에 걸친 단락들의 탭 정지 위치를 설정한다. - 지정한 배열로 기존 설정을 교체하며, 빈 배열은 모든 탭 정지 위치를 제거한다.

setTabs(tabs: TabStop[]): Promise<void>;

매개변수

이름	타입	설명
`tabs`	`TabStop[]`	탭 스톱 배열

반환값

Promise<void>

`setTextFormat(options)`

범위에 글자 서식을 적용한다.

setTextFormat(options: TextFormat): Promise<void>;

매개변수

이름	타입	설명
`options`	`TextFormat`	적용할 글자 서식 (지정한 필드만 변경. 값 대신 null 을 주면 그 속성을 제거해 스타일 상속으로 되돌린다)

반환값

Promise<void>

비고
메서드
메서드 상세

비고​

메서드​

메서드 상세​

acceptChangeTrackings()​

clearFormat()​

clearList()​

copyFormatTo(targetRange)​

delete()​

getBookmarks()​

getChangeTrackings()​

getComments()​

getContentHtml()​

getEndnotes()​

getFootnotes()​

getFormat()​

getHyperlink()​

getHyperlinks()​

getLocation()​

getNotes()​

getParagraph()​

getParentSection()​

getShapes()​

getStructure()​

getText()​

insertBookmark(name)​

insertColumnBreak()​

insertComment(text, options)​

insertEndnote(text)​

insertFootnote(text)​

insertHyperlink(url, options)​

insertImage(options)​

insertLineBreak()​

insertPageBreak()​

insertParagraph(text, options)​

insertSectionBreak(type)​

insertShape(preset, options)​

insertSymbol(charCode, options)​

insertTab()​

insertTable(rows, columns, options)​

insertText(text, options)​

insertTextbox(options)​

insertWebVideo(url, options)​

isCollapsed()​

rejectChangeTrackings()​

search(query, options)​

select(mode)​

setIndent(type)​

setList(listType)​

setParagraphBorder(border)​

setParagraphFormat(options)​

setStyle(style)​

setTabs(tabs)​

setTextFormat(options)​

비고

메서드

메서드 상세

`acceptChangeTrackings()`

`clearFormat()`

`clearList()`

`copyFormatTo(targetRange)`

`delete()`

`getBookmarks()`

`getChangeTrackings()`

`getComments()`

`getContentHtml()`

`getEndnotes()`

`getFootnotes()`

`getFormat()`

`getHyperlink()`

`getHyperlinks()`

`getLocation()`

`getNotes()`

`getParagraph()`

`getParentSection()`

`getShapes()`

`getStructure()`

`getText()`

`insertBookmark(name)`

`insertColumnBreak()`

`insertComment(text, options)`

`insertEndnote(text)`

`insertFootnote(text)`

`insertHyperlink(url, options)`

`insertImage(options)`

`insertLineBreak()`

`insertPageBreak()`

`insertParagraph(text, options)`

`insertSectionBreak(type)`

`insertShape(preset, options)`

`insertSymbol(charCode, options)`

`insertTab()`

`insertTable(rows, columns, options)`

`insertText(text, options)`

`insertTextbox(options)`

`insertWebVideo(url, options)`

`isCollapsed()`

`rejectChangeTrackings()`

`search(query, options)`

`select(mode)`

`setIndent(type)`

`setList(listType)`

`setParagraphBorder(border)`

`setParagraphFormat(options)`

`setStyle(style)`

`setTabs(tabs)`

`setTextFormat(options)`