본문으로 건너뛰기

Word.Section

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

Generated from the SDK type definitions

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

비고

메서드

메서드설명
deleteBreak()이 구역의 나누기를 제거하고 다음 구역과 합친다.
getBody()구역 본문을 반환한다.
getColumns()이 구역의 단(다단) 레이아웃을 반환한다.
getFooter(type)이 구역의 바닥글 영역을 반환한다.
getHeader(type)이 구역의 머리글 영역을 반환한다.
getIndex()이 구역의 인덱스를 반환한다.
getNext()문서 순서상 다음 구역을 반환한다.
getPageSetup()이 구역의 페이지 설정을 반환한다.
getPrevious()문서 순서상 이전 구역을 반환한다.
setBreakType(type)이 구역의 나누기 유형(이어서/다음 페이지부터 등)을 변경한다.
setColumns(layout)이 구역의 단(다단) 레이아웃을 변경한다.
setPageMargin(margins)이 구역의 페이지 여백을 설정한다.
setPageNumbering(options)이 구역의 페이지 번호 설정을 변경한다.
setPageSize(size, orientation)이 구역의 용지 크기와 방향을 설정한다.
setTitlePage(enabled)이 구역의 첫 페이지에 별도의 머리글·바닥글을 사용하도록 설정한다.

메서드 상세

deleteBreak()

이 구역의 나누기를 제거하고 다음 구역과 합친다. - 마지막 구역에는 제거할 나누기가 없다.

deleteBreak(): Promise<void>;

반환값

Promise<void>

getBody()

구역 본문을 반환한다. - 본문은 모든 구역이 공유하므로, 어느 구역에서 호출해도 같은 본문을 반환한다.

getBody(): Promise<Body>;

반환값

Promise<Body> - 본문 영역

getColumns()

이 구역의 단(다단) 레이아웃을 반환한다.
count·equalWidth·space·separator 는 항상 포함되고, 단 너비가 서로 다를 때만 widths 가 추가된다.
단이 하나면 항상 균등으로 보고하므로 { count: 1, equalWidth: true, space, separator } 형태이며 widths 는 없다.
반환값은 setColumns()에 그대로 전달할 수 있다.

getColumns(): Promise<ColumnLayout>;

반환값

Promise<ColumnLayout> - 단 레이아웃(setColumns 입력과 같은 형태)

getFooter(type)

이 구역의 바닥글 영역을 반환한다. - 아직 없는 영역은 첫 콘텐츠 삽입 시 생성한다.

getFooter(type?: HeaderFooterType | HeaderFooterVariant): Promise<Body>;

매개변수

이름타입설명
type (선택)HeaderFooterType | HeaderFooterVariant종류: HeaderFooterType(primary/firstPage/evenPages) 또는 HeaderFooterVariant(default/first/even) (기본값: HeaderFooterType.PRIMARY)

반환값

Promise<Body> - 해당 종류 바닥글 영역

getHeader(type)

이 구역의 머리글 영역을 반환한다. - 아직 없는 영역은 첫 콘텐츠 삽입 시 생성한다.

getHeader(type?: HeaderFooterType | HeaderFooterVariant): Promise<Body>;

매개변수

이름타입설명
type (선택)HeaderFooterType | HeaderFooterVariant종류: HeaderFooterType(primary/firstPage/evenPages) 또는 HeaderFooterVariant(default/first/even) (기본값: HeaderFooterType.PRIMARY)

반환값

Promise<Body> - 해당 종류 머리글 영역

getIndex()

이 구역의 인덱스를 반환한다.

getIndex(): Promise<number>;

반환값

Promise<number> - 0부터 시작하는 구역 인덱스

getNext()

문서 순서상 다음 구역을 반환한다.

getNext(): Promise<Section>;

반환값

Promise<Section> - 다음 구역. 마지막 구역이면 null

getPageSetup()

이 구역의 페이지 설정을 반환한다. - 용지 크기와 여백은 pt 단위로 반환한다.

getPageSetup(): Promise<PageSetupInfo>;

반환값

Promise<PageSetupInfo> - 이 구역의 페이지 설정

getPrevious()

문서 순서상 이전 구역을 반환한다.

getPrevious(): Promise<Section>;

반환값

Promise<Section> - 이전 구역. 첫 구역이면 null

setBreakType(type)

이 구역의 나누기 유형(이어서/다음 페이지부터 등)을 변경한다. 현재값과 같으면 아무것도 바꾸지 않는다. - getPageSetup().breakType 로 읽는 값과 같다.

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

매개변수

이름타입설명
typeSectionBreakType나누기 유형(continuous/nextPage/evenPage/oddPage)

반환값

Promise<void>

setColumns(layout)

이 구역의 단(다단) 레이아웃을 변경한다.
지정한 필드만 변경하며 나머지는 현재값을 유지한다. 현재값과 같으면 변경하지 않는다. 단위는 pt.
각 단 너비를 다르게 하려면 widths 를 지정하고, 지정하지 않으면 모든 단이 같은 너비다. count 가 1이면 equalWidth·widths 는 무시된다.
설정값은 getColumns()로 확인하며, 그 반환값을 그대로 전달할 수 있다.

setColumns(layout: ColumnLayout): Promise<void>;

매개변수

이름타입설명
layoutColumnLayout단 레이아웃

반환값

Promise<void>

setPageMargin(margins)

이 구역의 페이지 여백을 설정한다. - 지정한 방향의 여백만 변경하며 단위는 pt이다.

setPageMargin(margins: PageMargins): Promise<void>;

매개변수

이름타입설명
marginsPageMargins여백(pt)

반환값

Promise<void>

setPageNumbering(options)

이 구역의 페이지 번호 설정을 변경한다.
지정한 필드만 변경하며, null은 설정 전체를 제거한다. 현재값과 같으면 변경하지 않는다.
설정값은 getPageSetup().pageNumber로 확인한다.

setPageNumbering(options: PageNumbering | null): Promise<void>;

매개변수

이름타입설명
optionsPageNumbering | null페이지 번호 설정 또는 null(제거)

반환값

Promise<void>

setPageSize(size, orientation)

이 구역의 용지 크기와 방향을 설정한다.
용지 프리셋 또는 pt 단위의 너비·높이를 지정한다. 지정하지 않은 크기는 유지한다.
방향을 지정하면 너비·높이를 해당 방향에 맞춘다. 프리셋만 변경하면 현재 방향을 유지한다.

setPageSize(size: Size | PaperSize | null, orientation?: PageOrientation): Promise<void>;

매개변수

이름타입설명
sizeSize | PaperSize | null용지 치수(pt, 생략한 축은 현재값 유지) 또는 용지 프리셋 이름(A3/A4/A5/Letter/Legal/Executive). null 이면 크기 유지(방향만 변경)
orientation (선택)PageOrientation방향(portrait/landscape)

반환값

Promise<void>

setTitlePage(enabled)

이 구역의 첫 페이지에 별도의 머리글·바닥글을 사용하도록 설정한다.
현재값과 같으면 변경하지 않는다. 기능을 켠 뒤 첫 페이지 내용은 별도로 입력한다.
설정값은 getPageSetup().titlePage로 확인한다.

setTitlePage(enabled: boolean): Promise<void>;

매개변수

이름타입설명
enabledboolean켜기(true)/끄기(false)

반환값

Promise<void>