ICABookmark


    object
    uuid(A6157E58-FDE3-4E71-8619-A3143DE7D612), 
    dual
    nonextensible
    helpstring("ICABookmark Interface"), 
    pointer_default(unique

interface ICABookmark : IDispatch{
 [propget, id(1), helpstring("property Type")] HRESULT Type([out, retval] LONG* pVal);
 [propget, id(2), helpstring("property GUID")] HRESULT GUID([out, retval] BSTR* pVal);
 [propget, id(3), helpstring("property Parent")] HRESULT Parent([out, retval] IDispatch** pVal);
 [propput, id(3), helpstring("property Parent")] HRESULT Parent([in] IDispatch* newVal);
 [propget, id(4), helpstring("property Children")] HRESULT Children([out, retval] IDispatch** pVal);
 [propget, id(5), helpstring("property Title")] HRESULT Title([out, retval] BSTR* pVal);
 [propput, id(5), helpstring("property Title")] HRESULT Title([in] BSTR newVal);
 [propget, id(6), helpstring("property PosX")] HRESULT PosX([out, retval] LONG* pVal);
 [propput, id(6), helpstring("property PosX")] HRESULT PosX([in] LONG newVal);
 [propget, id(7), helpstring("property PosY")] HRESULT PosY([out, retval] LONG* pVal);
 [propput, id(7), helpstring("property PosY")] HRESULT PosY([in] LONG newVal);
 [propget, id(8), helpstring("property IconIndex")] HRESULT IconIndex([out, retval] LONG* pVal);
 [propput, id(8), helpstring("property IconIndex")] HRESULT IconIndex([in] LONG newVal);
 [propget, id(9), helpstring("property Pos")] HRESULT Pos([out, retval] LONG* pVal);
 [propput, id(9), helpstring("property Pos")] HRESULT Pos([in] LONG newVal);
 [id(10), helpstring("method CreateChildBookmark")] HRESULT CreateChildBookmark([in] IDispatch* pNodeDisp, [in] LONG nIconIndex, [in] LONG nPosX, [in] LONG nPosY, [out,retval] IDispatch** ppNewBookmarkDisp);
 [id(11), helpstring("method CreateChildFolder")] HRESULT CreateChildFolder([in] BSTR bstrTitle, [in] LONG nIconIndex, [out,retval] IDispatch** ppNewFolderDisp);
 [id(12), helpstring("method Delete")] HRESULT Delete();
 [id(13), helpstring("method GetNode")] HRESULT GetNode([out] BSTR* pbstrBookGUID, [out] LONG* pnNodeID);
};
 
ProgID
CyberArticleBook.CABookmark
C/C++头文件
CyberArticleBook.h; CyberArticleBook_i.c
 

修订:

从CyberArticle 5.3开始,书签接口进行了修改。和之前版本接口不同

属性 Type

获得书签类型。
0:文件夹
1:书签

参数

类型

  • get: [out, retval] LONG* pVal:获得书签类型

属性 GUID

获得/设置书签的GUID

参数

类型

  • get: [out, retval] BSTR* pVal:获得书签的GUID

属性 Parent

获得/设置书签,保存网页的时候,是否需要包含图片。

参数

类型

  • get: [out, retval] IDispatch** pVal:获得书签的父节点 (ICABookmark)
  • put: [in] IDispatch* newVal:设置书签的父节点 (ICABookmark)

属性 Children

获得书签文件夹所包含的子节点

参数

类型

  • get: [out, retval] IDispatch** pVal:获得书签包含的字节点 (ICABookmarkCollection)

属性 Title

获得/设置书签的标题

参数

类型

  • get: [out, retval] BSTR* pVal:获得标题
  • put: [in] BSTR newVal:设置标题

属性 PosX

获得/设置打开文章时,水平滚动条的位置

参数

类型

  • get: [out, retval] LONG* pVal:获得滚动条位置
  • put: [in] LONG newVal:设置滚动条位置

属性 PosY

获得/设置打开文章时,垂直滚动条的位置

参数

类型

  • get: [out, retval] LONG* pVal:获得滚动条位置
  • put: [in] LONG newVal:设置滚动条位置

属性 IconIndex

获得/设置书签的图标

参数

类型

  • get: [out, retval] LONG* pVal:获得图标索引
  • put: [in] LONG newVal:设置图标索引

属性 Pos

获得/设置书签的显示顺序

参数

类型

  • get: [out, retval] LONG* pVal:获得显示顺序
  • put: [in] LONG newVal:设置显示顺序

方法 CreateChildBookmark

在当前文件夹下面,创建一个新的书签。

参数

  • [in] IDispatch* pNodeDisp:ICANode对象
  • [in] LONG nIconIndex:图标索引
  • [in] LONG nPosX:水平滚动条位置
  • [in] LONG nPosY:垂直滚动条位置[in] IStream* pStream:Stream对象,用来接收文章资源数据。

返回

  • [out,retval] IDispatch** ppNewBookmarkDisp:新增的书签 (ICABookmark)

方法 CreateChildFolder

在当前文件夹下面,创建一个新的文件夹。

参数

  • [in] BSTR bstrTitle:标题
  • [in] LONG nIconIndex:图标索引

返回

  • [out,retval] IDispatch** ppNewFolderDisp:新增的文件夹

方法 Delete

删除书签

参数

返回

方法 GetNode

获得书签对应的节点

参数

  • [out] BSTR* pbstrBookGUID:书籍GUID 
  • [out] LONG* pnNodeID:节点ID
  • 返回