Programming/한컴 API

[HwpCtrl] 필드 리스트 구하기 - GetFieldList

자수씨 2009. 8. 30. 16:32

Description
 문서 중의 필드 리스트를 구한다.


Prototype
 BSTR GetFieldList([HwpFieldNumber number], [HwpFieldOption option])

 number
문서 중에서 동일한 이름의 필드가 여러 개 존재할 때 이를 구별하기 위한 식별 방법을 지정한다.
생략하면 hwpFieldPlain이 지정된다.
ID 설명
hwpFieldPlain 0 아무 기호 없이 순서대로 필드 이름이 나열된다.
hwpFieldNumber 1 필드 이름 뒤에 일련번호가 {{#}}와 같은 형식으로 붙는다.
hwpFieldCount 2 필드 이름뒤에 그 이름의 필드가 몇 개 있는지 {{#}}와 같은 형식으로 붙는다.

 option 
다음과 같은 옵션을 조합할 수 있다. 0을 지정하면 모두 off이다.
생략하면 0이 지정된다. 
ID 설명
hwpFieldCell 1 셀에 부여된 필드 리스트만을 구한다. hwpFieldClickHere와는 함께 지정할 수 없다.
hwpFieldClickHere 2 누름틀에 부여된 필드 리스트만을 구한다. hwpFieldCell과는 함께 지정할 수 없다.
hwpFieldSelection 4 셀렉션 내에 존재하는 필드 리스트를 구한다.


Return Values
 각 필드 사이를 문자코드 0x02로 구분하여 다음과 같은 형식으로 리턴 한다. (가장 마지막 필드에는 0x02가 붙지 않는다.)
 "필드이름#1\x2필드이름#2\x2...필드이름#n"


ㅁ 활용 예
   var fieldList = HwpCtrl.GetFieldList();
   var fields = fieldList.split(String.fromCharCode(2));


0x02 로 구분되어 있기 때문에 String.fromCharCode() 함수를 통하여 구분합니다.
위에서 fields 는 배열로 활 용할 수 있습니다.