RegisterProperty Method (name, type, defaultValue, category, displayName, description)

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

Visual Basic

Visual C++

protected void RegisterProperty(
	string name,
	Type type,
	Object defaultValue,
	string category,
	string displayName,
	string description
)

Protected Sub RegisterProperty ( _
	name As String, _
	type As Type, _
	defaultValue As Object, _
	category As String, _
	displayName As String, _
	description As String _
)

protected:
void RegisterProperty(
	String^ name, 
	Type^ type, 
	Object^ defaultValue, 
	String^ category, 
	String^ displayName, 
	String^ description
)

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:

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 " ".

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.

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