Only 2 weeks until the Rock Community takes over PHX! Follow along on X for the latest updates and conference experience!

Model Map

Key
A required field.
A property on the database.
Not mapped to the database. These fields are computed and are only available in the object.
These fields are available where Lava is supported.
These fields can be used as qualifiers on attributes.
These methods or fields are obsolete and should not be used.

Model Details

Show: Methods

DefinedType

A DefinedType is a dictionary of consistent values for a particular thing in Rock. The individual items are refereed to as DefinedValues in Rock. Several classic examples of DefinedTypes can be Shirt Sizes, a Country List, etc. Defined Values can be categorized, ordered and can be furthered specified by a FieldType
Properties
AdditionalLavaFields
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
CategorizedValuesEnabled Gets or sets a flag indicating if the Defined Values associated with this Defined Type can be grouped into categories.
Category Gets or sets the category.
CategoryId Gets or sets the category identifier.
ContextKey
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
DefinedTypeAttributeValues Gets the entity attribute values. This should only be used inside LINQ statements when building a where clause for the query. This property should only be used inside LINQ statements for filtering or selecting values. Do not use it for accessing the attributes after the entity has been loaded.
DefinedValues Gets or sets a collection containing the DefinedValues that belong to this DefinedType.
Description Gets or sets a user defined description of the DefinedType.
EnableSecurityOnValues Gets or sets a value indicating whether the DefinedValues for this DefinedType should allow security settings.
EncryptedKey
EntityStringValue
FieldType Gets or sets the FieldType that is used to set/select, and at times display the DefinedValues that are associated with this DefinedType.
FieldTypeId Gets or sets the FieldTypeId of the FieldType that is used to set/select, and at times display the DefinedValues that are associated with NOTE: Currently, Text is the only supported fieldType for DefinedTypes. this DefinedType.
ForeignGuid
ForeignId
ForeignKey
Guid
HelpText Gets or sets the help text for the defined type.
Id
IdKey
IsActive Gets or sets a value indicating whether this Defined Type is active.
IsSystem Gets or sets a flag indicating if this DefinedType is part of the Rock core system/framework. This property is required.
IsValid
Item
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Name Gets or sets the Name of the DefinedType.
Order Gets or sets the display order of this DefinedType. The lower the number the higher the display priority. This property is required.
ParentAuthority
ParentAuthorityPre
SupportedActions
TypeId
TypeName
UrlEncodedKey
ValidationResults