Windward Studios API Reference
TemplateVariable Constructor(String,String,Boolean,Boolean,Boolean,Boolean,Boolean,VAR_TYPE,Object,String,String,String,String)
See Also  Send comments on this topic.
net.windward.api.csharp Namespace > TemplateVariable Class > TemplateVariable Constructor : TemplateVariable Constructor(String,String,Boolean,Boolean,Boolean,Boolean,Boolean,VAR_TYPE,Object,String,String,String,String)




name
The name of the variable.
udtGuid
The guid (can be null) for this if a UDT.
required
true if this variable must be set.
allowAll
Can return all values for this select variable.
allowList
Can return a list of values for this select variable.
allowFilter
Can return a filtered result for this select variable.
allowSort
Can return a sorted result for this select variable.
varType
What type of data this variable is. This should be SELECT.
defValue
The default value for this var. Can be null.
description
The description of this variable. This is optional.
datasource
The name of the datasource for the select.
select
The select for this var if a select var.
selectFormat

Glossary Item Box

Create a SELECT object.

Syntax

Visual Basic (Declaration) 
Public Function New( _
   ByVal name As String, _
   ByVal udtGuid As String, _
   ByVal required As Boolean, _
   ByVal allowAll As Boolean, _
   ByVal allowList As Boolean, _
   ByVal allowFilter As Boolean, _
   ByVal allowSort As Boolean, _
   ByVal varType As TemplateVariable.VAR_TYPE, _
   ByVal defValue As Object, _
   ByVal description As String, _
   ByVal datasource As String, _
   ByVal select As String, _
   ByVal selectFormat As String _
)
Visual Basic (Usage)Copy Code
Dim name As String
Dim udtGuid As String
Dim required As Boolean
Dim allowAll As Boolean
Dim allowList As Boolean
Dim allowFilter As Boolean
Dim allowSort As Boolean
Dim varType As TemplateVariable.VAR_TYPE
Dim defValue As Object
Dim description As String
Dim datasource As String
Dim select As String
Dim selectFormat As String
 
Dim instance As New TemplateVariable(name, udtGuid, required, allowAll, allowList, allowFilter, allowSort, varType, defValue, description, datasource, select, selectFormat)
C# 
public TemplateVariable( 
   string name,
   string udtGuid,
   bool required,
   bool allowAll,
   bool allowList,
   bool allowFilter,
   bool allowSort,
   TemplateVariable.VAR_TYPE varType,
   object defValue,
   string description,
   string datasource,
   string select,
   string selectFormat
)
Managed Extensions for C++ 
public: TemplateVariable( 
   string* name,
   string* udtGuid,
   bool required,
   bool allowAll,
   bool allowList,
   bool allowFilter,
   bool allowSort,
   TemplateVariable.VAR_TYPE varType,
   Object* defValue,
   string* description,
   string* datasource,
   string* select,
   string* selectFormat
)
C++/CLI 
public:
TemplateVariable( 
   String^ name,
   String^ udtGuid,
   bool required,
   bool allowAll,
   bool allowList,
   bool allowFilter,
   bool allowSort,
   TemplateVariable.VAR_TYPE varType,
   Object^ defValue,
   String^ description,
   String^ datasource,
   String^ select,
   String^ selectFormat
)

Parameters

name
The name of the variable.
udtGuid
The guid (can be null) for this if a UDT.
required
true if this variable must be set.
allowAll
Can return all values for this select variable.
allowList
Can return a list of values for this select variable.
allowFilter
Can return a filtered result for this select variable.
allowSort
Can return a sorted result for this select variable.
varType
What type of data this variable is. This should be SELECT.
defValue
The default value for this var. Can be null.
description
The description of this variable. This is optional.
datasource
The name of the datasource for the select.
select
The select for this var if a select var.
selectFormat

Requirements

Platforms: Windows 10, Windows NT, Windows Server

See Also

Windward Studios - .NET Document Generation software