VS:DefineCustomObj

From Vectorworks Developer
Revision as of 05:31, 8 February 2016 by CBM-c- (talk | contribs) (add remark)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

.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

(Orso, 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

Retrieved from "http://developer.vectorworks.net/index.php?title=VS:DefineCustomObj&oldid=21487"