FivePD API
Models/VariableData

VariableDataAttribute

Represents a VariableDataSet attribute.

This model represents the database table fivepd_variable_data_attributes. When modifying any properties of this model, ensure that you have saved the changes using the DatabaseContext.

Properties

Id

Gets or sets the id of this attribute.

Type: int

Set

Gets or sets which set this attribute belongs to.

Type: VariableDataSet

DataType

Gets or sets the data type of this attribute.

Type: VariableDataType

AddonId

Gets or sets the id of the addon which created this attribute. If it was created by an admin it should equal to VariableDataAttribute.AddedByAdminAddonId.

Type: string

Name

Gets or sets the name of this attribute.

Type: string

Order

Gets or sets the order of this attribute. Used for overriding the default order of grid columns.

Type: int

Required

Gets or sets a value indicating whether this attribute is required in forms or not.

Type: bool

Hidden

Gets or sets a value indicating whether this attribute should be hidden in forms or not.

Type: bool

Readonly

Gets or sets a value indicating whether this attribute should be readonly in forms or not.

Type: bool

ShowInGrid

Gets or sets a value indicating whether this attribute should be displayed in grids or not.

Type: bool

Placeholder

Gets or sets the placeholder which will be shown in the attribute's input field.

Type: string

Label

Gets or sets the label which will be shown above the attribute's input field.

Type: string

HelpLabel

Gets or sets the help label which will be shown under the attribute's input field.

Type: string

Options

Gets or sets the custom options of this attribute.

Type: AttributeOptions

AttributeOptions

Represents the possible options of an attribute.

Type: class

Items

Type: Dictionary<int, string>