3.4.8 IToolsObject
IToolsObject是工具对象。工具对象提供对工具的更新、激活、关闭和获取工具结果等操作。具体使用可参考网页气泡弹窗。
工具对象需要通过ToolsCOM组件的CreateToolsObject()接口创建。
1.GetToolsID
说明:
获取工具对象ID。
语法:
Javascript调用
GetToolsID()
C++调用
HRESULT GetToolsID([out,retval] LONG* id)
C#调用
long GetToolsID()
返回值： id
id表示工具对象ID。
2.GetToolsTypeName
说明:
获取工具对象类型名称。
语法:
Javascript调用
GetToolsTypeName()
C++调用
HRESULT GetToolsTypeName([out,retval] BSTR* name)
C#调用
string GetToolsTypeName()
返回值： name
name表示工具对象类型名称。
3.UpdateToolsOptions
说明:
更新工具对象。
语法:
Javascript调用
UpdateToolsOptions(pLayerOptions)
C++调用
HRESULT UpdateToolsOptions([in] IUnknown* pLayerOptions)
C#调用
void UpdateToolsOptions(IToolsOptions pLayerOptions)
参数：
| 参数名 | 参数类型 | 说明 |
|---|---|---|
| pLayerOptions | IToolsOptions | 工具配置对象 |
4.GetToolsOptions
说明:
获取工具对象配置信息。
语法:
Javascript调用
GetToolsOptions()
C++调用
HRESULT GetToolsOptions([out,retval] IUnknown** toolsConfigOption)
C#调用
IToolsOptions GetToolsOptions()
返回值： toolsConfigOption
toolsConfigOption表示工具配置对象。
5.GetToolsResult
说明:
获取工具对象处理结果。
语法:
Javascript调用
GetToolsResult()
C++调用
HRESULT GetToolsResult([out,retval] IUnknown** toolsResult)
C#调用
IToolsOptions GetToolsResult()
返回值： toolsResult
toolsResult表示结果对象。
7.AddObserver
说明:
添加监听处理。工具对象添加监听处理之后，前端还需要添加回调处理事件。当对象有响应消息时，会主动回调给前端。如果不添加监听处理，那么不会发送回调消息。
语法:
Javascript调用
AddObserver()
C++调用
HRESULT AddObserver(void)
C#调用
void AddObserver()
7.DelObserver
说明:
移除监听处理，移除工具对象的监听处理后，工具对象不再向前端发送回调消息。
语法:
Javascript调用
DelObserver()
C++调用
HRESULT DelObserver(void)
C#调用
void DelObserver()
8.Active
说明:
激活工具对象。对象创建之后，可以通过该接口进行激活，激活操作会让工具对象运行，并产生相应的效果。
语法:
Javascript调用
Active()
C++调用
HRESULT Active([out,retval] VARIANT_BOOL* result)
C#调用
bool Active()
返回值： result
result表示是否成功。true-成功；false-失败。
9.Deactive
说明:
关闭工具对象。将工具对象关闭并从SDK中移除工具对象。
语法:
Javascript调用
Deactive()
C++调用
HRESULT Deactive([out,retval] VARIANT_BOOL* result)
C#调用
bool Deactive()
返回值： result
result表示是否成功。true-成功；false-失败。