VariableTemplateType Class

A type of variable in a IVariableTemplate that prompts for input in a certain way (textbox, list, checkbox, or custom), as well as renders it in a custom way (such as with an icon, or hyperlink).

Inheritance Hierarchy

Syntax

public class VariableTemplateType

Constructors

Name Description
VariableTemplateType

Initializes a new instance of the VariableTemplateType class.

Properties

Name Description
IsBasicType

Gets a value indicating whether this instance is a built-in Checkbox, Text, Constant, or List type.

Methods

Name Description
CreateInput(IVariableTemplate variableTemplate, VariableTemplateContext context)

Creates the Inedo.Web.Editors.VariableTemplateInput control used to input the variable at job, release, build, etc. creation time

CreateRenderer(Inedo.ExecutionEngine.RuntimeValue value, VariableTemplateContext context)

Creates a control that can render the specified value

GetDescription

Returns a friendly description.

Fields

Name Description
Checkbox

The built-in checkbox variable.

Constant

The built-in constant variable.

List

The built-in list variable.

Text

The built-in text variable.

Remarks

If you inherit this class without overriding CreateRenderer(Inedo.ExecutionEngine.RuntimeValue value, VariableTemplateContext context) or CreateInput(IVariableTemplate variableTemplate, VariableTemplateContext context), it will simply render as a basic textbox during input and an encoded value during rendering. Consider implementing DynamicListVariableType to display a list to users instead.