Visual Signal ExternalBase Class Library Documentation
RegisterProperty Method (name, type, defaultValue, category, displayName, description, tags)
VisualSignalVSignal.ExternalBaseTExternalBaseRegisterProperty(String, Type, Object, String, String, String, String)
API version 1.2.2.0

[This is preliminary documentation and is subject to change.]

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.
Declaration Syntax
C#Visual BasicVisual C++
protected void RegisterProperty(
	string name,
	Type type,
	Object defaultValue,
	string category,
	string displayName,
	string description,
	string tags
)
Protected Sub RegisterProperty ( _
	name As String, _
	type As Type, _
	defaultValue As Object, _
	category As String, _
	displayName As String, _
	description As String, _
	tags As String _
)
protected:
void RegisterProperty(
	String^ name, 
	Type^ type, 
	Object^ defaultValue, 
	String^ category, 
	String^ displayName, 
	String^ description, 
	String^ tags
)
Parameters
name (String)
Specifies the name of the property.
type (Type)
Specifies the System.Type of the property. Currently, only the following types are handled:
TypeDescription
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 (Object)
Specifies the default value of the property.
category (String)
Specifies the category of the property.
displayName (String)
Specifies the display name of the property.
description (String)
Specifies the description of the property.
tags (String)
Specifies comma-separated tags for special purposes. Currently supports:
TypeDescription
"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 (*.*)|*.*"

Assembly: vsmExternalBase (Module: vsmExternalBase) Version: 1.2.2.0 (1.3.0.0)