userParameter 参数

userParameter 是为了编辑器扩展程序员的方便而提供的参数。它允许在不同的作用域级别上使各种设置与编辑器相关联,方式类似于编辑器参数。

可用性

query 命令
set 命令

作用域

userParameter.view. 的作用域为当前视图。
userParameter.document. 的作用域为当前视图的文档。
userParameter 的作用域为全局。

语法

query userParameter.[ view. | document. ] name
set userParameter.[ view. | document. ] name [ value ] 

参数

view. 使用 view. 限定符来将当前视图指定为用户参数作用域。
document. 使用 document. 限定符来将当前视图的文档指定为用户参数作用域。
name 使用 name 参数来指定用户参数的名称。
value 使用 value 参数来指定用户参数的值。对 value 没有任何限制。如果未对 set userParameter 命令指定值,则将除去指定视图、文档或全局作用域上的用户参数设置,如果有此用户参数的更高作用域值,则还将复原该值。

描述

具有全局作用域的用户参数设置存储在编辑器缺省概要文件中,参见 defaultProfile 编辑器参数。具有文档作用域的用户参数设置(它们覆盖特定文档的全局设置)存储在相关联的文档中。具有视图作用域的用户参数设置(它们覆盖特定文档视图的文档设置)存储在相关联的视图中。

query userParameter 命令返回指定作用域(如果可用)上的用户参数设置,否则该命令返回更高的作用域设置。

示例

query userParameter.myParameter
query userParameter.document.myParameter
query userParameter.view.myParameter
set userParameter.myParameter Global setting
set userParameter.document.myParameter Document value
set userParameter.view.myParameter 42
set userParameter.myParameter 

相关参考
query 命令
set 命令
defaultProfile 参数