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 參數