Word.Hyperlink
Word.Hyperlink은 Word 모듈(Office.word(iframe))의 객체 타입입니다. 메서드 8개.
Word · 객체 타입 14개 · 메서드 259개 · 네임스페이스 Word. 이 레퍼런스는 SDK 빌드와 함께 생성된 API 문서 아티팩트(sdk-api-doc.html)에서 생성됩니다. 설명은 게시된 편집기 API 주석 그대로입니다. SDK와 Office 버전을 함께 고정하고, 둘 중 하나가 바뀌면 다시 생성하십시오.
비고
- 모듈: Word ·
Office.word(iframe)· 네임스페이스Word - 얻는 방법:
Document.getHyperlink(hyperlinkId),Document.getHyperlinks(options),Range.getHyperlink(),Range.getHyperlinks(),Range.insertHyperlink(url, options) - 모든 메서드는
Promise를 반환하며, 시그니처는 TypeScript 표기입니다.
메서드
| 메서드 | 설명 |
|---|---|
delete() | 하이퍼링크를 삭제한다. |
exists() | 하이퍼링크 존재 여부를 반환한다. |
getId() | 하이퍼링크 ID를 반환한다. |
getLinkType() | 링크 종류를 반환한다. |
getRange() | 링크가 연결된 표시 텍스트의 범위를 반환한다. |
getTooltip() | 링크 툴팁(마우스를 올렸을 때 뜨는 설명)을 반환한다. |
getUrl() | 링크 대상 주소를 반환한다. |
update(options) | 하이퍼링크의 주소·설명·표시 텍스트를 수정한다. |
메서드 상세
delete()
하이퍼링크를 삭제한다. - 표시 텍스트는 문서에 남긴다.
delete(): Promise<void>;
반환값
Promise<void>
exists()
하이퍼링크 존재 여부를 반환한다.
exists(): Promise<boolean>;
반환값
Promise<boolean> - 존재하면 true
getId()
하이퍼링크 ID를 반환한다.
getId(): Promise<string | null>;
반환값
Promise<string | null> - 하이퍼링크 ID, 아직 삽입 전이면 null
getLinkType()
링크 종류를 반환한다.
getLinkType(): Promise<HyperlinkType>;
반환값
Promise<HyperlinkType> - 링크 종류 (link/mailto/bookmark)
getRange()
링크가 연결된 표시 텍스트의 범위를 반환한다. - 링크 시작·끝 표시는 포함하지 않는다. 반환된 범위를 편집하면 링크를 유지하면서 글자만 변경한다.
getRange(): Promise<Range>;
반환값
Promise<Range> - 표시 텍스트 범위
getTooltip()
링크 툴팁(마우스를 올렸을 때 뜨는 설명)을 반환한다.
getTooltip(): Promise<string | null>;
반환값
Promise<string | null> - 툴팁, 지정되지 않았으면 null
getUrl()
링크 대상 주소를 반환한다. - 책갈피는 "#이름" 형태로 반환한다. 프로토콜 없이 입력한 웹 주소는 "https://…" 형태로 반환한다.
getUrl(): Promise<string>;
반환값
Promise<string> - 목적지 url
update(options)
하이퍼링크의 주소·설명·표시 텍스트를 수정한다. - 변경할 필드를 하나 이상 지정한다. url만 지정하면 표시 텍스트를 유지하고, displayText를 지정하면 표시 텍스트를 교체한다.
update(options: { url?: string; tooltip?: string; displayText?: string }): Promise<void>;
매개변수
| 이름 | 타입 | 설명 |
|---|---|---|
options | { url?: string; tooltip?: string; displayText?: string } | 수정 옵션 (전 필드 생략 가능, 최소 하나) |
options.url (선택) | string | 새 URL (웹 http(s):// · 이메일 mailto: · 북마크 #name), 생략 시 현재값 유지 (기본값: current value) |
options.tooltip (선택) | string | 새 툴팁. 생략하면 현재 툴팁을 유지하지만, url 도 함께 바꾸면 툴팁이 새 url 로 바뀐다 |
options.displayText (선택) | string | 새 표시 텍스트 (주면 보이는 글자가 교체됨), 생략 시 현재값 유지 (기본값: current value) |
반환값
Promise<void>