API version 1.5.2
Assembly: vsmExternalBase (in vsmExternalBase.dll) Version: 1.6.0.0
[This is preliminary documentation and is subject to change.]
(Deprecated) Protected function "RegisterProperty", proved to the user DLL for registering
properties used by the DLL computation. This function should be invoked in
Init, and the registered properties will be passed to Visual
Signal's ExternalDll module via getDllInfo and become available in
the module's property dialog for editing. The current values will be communicated
back and forth between ExternalDll module and the user DLL via setProperties(String)
and getProperties exported functions.
This is deprecated. Property values can now be defined like regular C# properties, with
appropriate attributes attached to the properties to define their categories, display names,
descriptions, etc. Properties must be public and browsable.
Namespace: VSignal.ExternalBase
Assembly: vsmExternalBase (in vsmExternalBase.dll) Version: 1.6.0.0
Syntax
protected void RegisterProperty( string name, Type type, Object defaultValue, string category, string displayName, string description, string tags = null, int order = -1 )
Parameters
- name
- Type: SystemString
Specifies the name of the property. - type
- Type: SystemType
Specifies the System.Type of the property. Currently, only the following types are handled:Type Description System.Boolean Use typeof(bool) to obtain this System.Type. System.Int32 Use typeof(int) to obtain this System.Type. System.Double Use typeof(double) to obtain this System.Type. System.String Use typeof(string) to obtain this System.Type. System.Int32[] Use typeof(int[]) to obtain this System.Type. This will be handled in Visual Signal's property dialog as a string delimiited by ",", ";", or " ". System.Double[] Use typeof(double[]) to obtain this System.Type. This will be handled in Visual Signal's property dialog as a string delimiited by ",", ";", or " ". System.Enum Use typeof({enumType}) to obtain the type, where {enumType} is a user-defined enum type whose base type is System.Enum. This will be handled in Visual Signal's property dialog as a pull-down menu. - defaultValue
- Type: SystemObject
Specifies the default value of the property. - category
- Type: SystemString
Specifies the category of the property. - displayName
- Type: SystemString
Specifies the display name of the property. - description
- Type: SystemString
Specifies the description of the property. - tags (Optional)
- Type: SystemString
Specifies comma-separated tags for special purposes. Currently supports:Type Description "ReadOnly" Specifies that the property is read-only when displayed in Visual Signal. "File:[fileter]" Specifies that the property is a file path, and can invoke the OpenFile dialog in Visual Signal. The filters used in OpenFile dialog can be specified using the standard "|"-separated .Net filter specification in [filter]. For example: "Text files (*.txt)|*.txt|All files (*.*)|*.*", or "Image Files(*.BMP;*.JPG;*.GIF)|*.BMP;*.JPG;*.GIF|All files (*.*)|*.*" - order (Optional)
- Type: SystemInt32
Specifies the order of the property
See Also