VS:DefineCustomObj: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Transfer Orso to _c_) |
||
(5 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<desc> | <desc> | ||
Calls GS_DefineCustomObject for a passed plugin name and preference.</desc> | |||
</desc> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<def> | <def> | ||
<funcDef lang="vs"> | <funcDef lang="vs"> | ||
FUNCTION DefineCustomObj(pluginName: STRING; prefWhen: INTEGER) : HANDLE; | FUNCTION DefineCustomObj(pluginName:STRING; prefWhen:INTEGER) : HANDLE; | ||
</funcDef> | </funcDef> | ||
<funcDef lang="py"> | <funcDef lang="py"> | ||
Line 35: | Line 24: | ||
pluginName | pluginName | ||
STRING | STRING | ||
The name of the plug-in for which preferences to be shown. | |||
</line> | </line> | ||
<line> | <line> | ||
prefWhen | prefWhen | ||
INTEGER | INTEGER | ||
When the preference dialog is to be shown. See remarks for details. | |||
</line> | </line> | ||
</lineList> | </lineList> | ||
</params> | </params> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
< | <remark> | ||
The parameter '''prefWhen''' can be one of: | |||
* kCustomObjectPrefNever = 0 | |||
* kCustomObjectPrefAlways = 1 | |||
* kCustomObjectPrefNew = 2 | |||
-- | ([[User:CBM-c-|_c_]], 2016.02.08): | ||
Objects created with this call won't allow you to set a profile group, even if they usually support it. | |||
</remark> | </remark> | ||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<sample> | <sample></sample> | ||
</ | ----------------------------------------------------------------------------------------------------------- | ||
<seeAlso></seeAlso> | |||
----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ||
<version> | <version> | ||
Availability: from | Availability: from Vectorworks 2014 | ||
</version> | </version> | ||
</vwDoc> | </vwDoc> |
Latest revision as of 05:31, 30 December 2020
.VectorScript|VectorScript ..VS:Function Reference|Function Reference ..VS:Function_Reference_Appendix|Appendix
Description
Calls GS_DefineCustomObject for a passed plugin name and preference.
FUNCTION DefineCustomObj(
pluginName :STRING;
prefWhen :INTEGER) : HANDLE;
def vs.DefineCustomObj(pluginName, prefWhen): return HANDLE
Parameters
pluginName STRING The name of the plug-in for which preferences to be shown. prefWhen INTEGER When the preference dialog is to be shown. See remarks for details.
Remarks
The parameter prefWhen can be one of:
- kCustomObjectPrefNever = 0
- kCustomObjectPrefAlways = 1
- kCustomObjectPrefNew = 2
(_c_, 2016.02.08): Objects created with this call won't allow you to set a profile group, even if they usually support it.
Version
Availability: from Vectorworks 2014