3.3.16 IToolsOptions
IToolsOptions是工具配置对象，用于配置工具对象(IToolsObject)的参数。
工具类配置对象通过ToolsCOM组件的CreateToolsOptions()接口创建。
1.AddConfig
说明:
配置键值对。配置项键值对以字符串进行传入。
语法:
Javascript调用
AddConfig(key, value)
C++调用
HRESULT AddConfig([in] BSTR key, [in] BSTR value)
C#调用
void AddConfig(string key, string value)
参数：
| 参数名 | 参数类型 | 说明 |
|---|---|---|
| key | string | 配置项键值类型 |
| value | string | 配置项键值 |
2.GetConfigSetCount
说明:
获取已配置键值对的数量。
语法:
Javascript调用
GetConfigSetCount()
C++调用
HRESULT GetConfigSetCount([out,retval] LONG* count)
C#调用
long GetConfigSetCount()
返回值： count
count表示已配置键值对的数量。
3.GetConfigKeyByIndex
说明:
通过索引获取配置键名称。
语法:
Javascript调用
GetConfigKeyByIndex(index)
C++调用
HRESULT GetConfigKeyByIndex([in] LONG index, [out,retval] BSTR* key)
C#调用
string GetConfigKeyByIndex(long index)
参数：
| 参数名 | 参数类型 | 说明 |
|---|---|---|
| index | long | 索引 |
返回值： key
key表示配置键名称。
4.GetConfigValueByKey
说明:
通过键名获取配置键值。
语法:
Javascript调用
GetConfigValueByKey(key)
C++调用
HRESULT GetConfigValueByKey([in] BSTR key, [out,retval] BSTR* value)
C#调用
string GetConfigValueByKey(string key)
参数：
| 参数名 | 参数类型 | 说明 |
|---|---|---|
| key | string | 键名 |
返回值： value
value表示配置键值。
5.GetToolsOptionsTypeName
说明:
获取工具类型名。
语法:
Javascript调用
GetToolsOptionsTypeName()
C++调用
HRESULT GetToolsOptionsTypeName([out,retval] BSTR* toolsOptionTypeName)
C#调用
string GetToolsOptionsTypeName()
返回值： toolsOptionTypeName
toolsOptionTypeName表示工具类型名。
6.SetName
说明:
设置对象名称。
语法:
Javascript调用
SetName(name)
C++调用
HRESULT SetName([in] BSTR name)
C#调用
void SetName(string name)
参数：
| 参数名 | 参数类型 | 说明 |
|---|---|---|
| name | string | 对象名 |