Windward Engine API Reference
TemplateVariable Class Members
See Also  Properties  Methods  Send comments on this topic.
net.windward.api.csharp Namespace : TemplateVariable Class


Glossary Item Box

The following tables list the members exposed by TemplateVariable.

Public Constructors

 NameDescription
Public ConstructorTemplateVariable ConstructorOverloaded.   
Top

Public Properties

 NameDescription
Public PropertyAllowAllCan return all values for this select variable.  
Public PropertyAllowedValuesThe allowed values for this var. Can be length 0 (which means anything is allowed OR the list was too long).  
Public PropertyAllowFilterCan set a filter for values for this select variable.  
Public PropertyAllowListCan return a list of values for this select variable.  
Public PropertyAllowSortCan sort values for this select variable.  
Public PropertyAutoMetadataIf this is an auto-select, this is the metadata for the select. For SQL this is [dbo.]table.column using the raw values (no surrounding spaces) and for XML it is the full XPath to that node.  
Public PropertyCalOffsetThe date default value can be set to a calendar offset.  
Public PropertyDatasourceThe name of the datasource for the select.  
Public PropertyDefaultValuesThe default values for this var. Can be length 0 (which means no default).  
Public PropertyDescriptionThe description of this variable. This is optional.  
Public PropertyNameThe name of the variable.  
Public PropertyRequiredtrue if this variable must be set.  
Public PropertySelectThe Select for this var if a select var. null if not a select var.  
Public PropertySelectFormatThe Select format for this var if a select var. null if not a select var.  
Public PropertyUdtGuidIf this is from a UDT it optionally has the GUID of the UDT item.  
Public PropertyVarTypeWhat type of data this variable is.  
Top

Public Methods

 NameDescription
Public Methodstatic (Shared in Visual Basic)ConvertToVarTypeConvert a DbType to the matching VAR_TYPE  
Public Methodstatic (Shared in Visual Basic)FromXmlRead the xml stored with the template to get all vars.  
Public Methodstatic (Shared in Visual Basic)GetValueConvert a string to the requested object type.  
Public Methodstatic (Shared in Visual Basic)SingleFromXmlBuilds a TemplateVar from xml.  
Public MethodToXmlOverloaded. Write out the xml for this var.  
Top

See Also

© 2019 All Rights Reserved.