aardio 文档

win.clip 库模块帮助文档

win.clip 成员列表

win.clip.eachFormat()

for id,name in win.clip.eachFormat(){
    /*遍历剪贴板的格式 ID,格式名称(name)  
ID 小于 0x02FF (CF_PRIVATELAST) 为系统预定义的格式。  
ID 自 0xC000 到 0xFFFF 为注册的自定义剪贴板格式。  

ID 小于 0xC000 的 格式 name 返回友好名称或 "Unknown",  
其余返回注册的格式名。*/
}

win.clip.formats()

获取剪贴板所有可用类型。
位置越靠前优先级越高,应优先使用。
返回值为数组,数组元素为表示格式的数值,例如 _CF_UNICODETEXT

win.clip.getFormatName

自剪贴板获取格式名称

win.clip.getFormatName(formatId,friendly)

自剪贴板获取格式名称。
参数 @formatId 指定剪贴板格式 ID。

如果 @friendly 为 true 则预定义格式返回友好名称。
否则仅返回 ::User32.RegisterClipboardFormat 注册的名称。

请注意 win.clip.eachFormat 迭代器始终返回友好名称

win.clip.read()

读取剪贴板文本

win.clip.readBitmap()

读取剪贴板位图句柄,
返回的位图句柄用完要自行销毁。
读取失败返回 null 。
└── 请谨慎处理位图释放责任。

可使用 com.picture.fromBitmap 将位图句柄转换为 com.picture 对象。
可使用 gdip.bitmap 构造函数将位图句柄转换为 gdip.bitmap 对象

win.clip.readUtf16()

读取剪贴板 UTF16 编码字符串

win.clip.test(formats...)

检测剪贴板是否存在参数指定的任意一个剪贴板类型。
@formats 可指定数值数组,也可以指 定一个或多个表示剪贴板类型的数值

win.clip.write()

调用 tostring 转换参数 @1 为文本并写入剪贴板。
可选使用参数 @2 指定在复制前是否清空剪贴板,默认清空。
成功返回剪贴板数据句柄。

win.clip.writeBitmap

写入位图到剪贴板,
成功返回剪贴板数据句柄

win.clip.writeBitmap(位图句柄,接管位图,清空剪贴板)

写入位图到剪贴板

除位图句柄以外其他参数为可选参数。
└── gdip.bitmap 对象请调用 copyHandle 函数复制位图句柄
└── com.picture 对象请调用 CopyHandle 函数复制位图句柄
如果接管位图参数为 true,则由剪贴板负责释放参数指定的位图。
└── 否则会复制位图到剪贴板,且不负责释放参数传入的位图句柄。
└── 请谨慎处理位图释放责任。
如清空剪贴板参数为 false(默认为 true),则保留剪贴板其他格式数据

Markdown 格式