Watch our RX24 Keynotes!

Model Map

Model Details

Show: Methods

Attribute

Represents an attribute or configuration setting in Rock
Properties
AbbreviatedName Gets or sets the shortened name of the attribute. If null or whitespace then the full name is returned.
AdditionalLavaFields
AllowSearch Gets or sets whether this Attribute should be used in 'search by attribute value' UIs. For example, if you had a UI where you would allow the user to find people based on a list of attributes
AttributeColor The color to visually distinguish the attribute. For example, AttributeColor might be used to set the color for the IconCssClass of the icon.
AttributeQualifiers Gets or sets a collection containing the AttributeQualifiers for this Attribute.
Attributes
AttributeValueDefaults
AttributeValues
AvailableKeys
Categories Gets or sets the collection of Categories that this Attribute is associated with. NOTE: Since changes to Categories isn't tracked by ChangeTracker, set the ModifiedDateTime if Categories are modified.
ContextKey
CreatedByPersonAlias
CreatedByPersonAliasId
CreatedByPersonId
CreatedByPersonName
CreatedDateTime
CustomSortValue
DefaultPersistedCondensedHtmlValue Gets or sets the default persisted condensed HTML value.
DefaultPersistedCondensedTextValue Gets or sets the default persisted condensed text value.
DefaultPersistedHtmlValue Gets or sets the default persisted HTML value.
DefaultPersistedTextValue Gets or sets the default persisted text value.
DefaultValue Gets or sets the Attribute's default value.
Description Gets or sets the description of the Attribute.
EnableHistory Gets or sets a value indicating whether changes to this attribute's attribute values should be logged in AttributeValueHistorical
EncryptedKey
EntityStringValue
EntityType Gets or sets the EntityType that this Attribute is used to configure. This property will not be populated if the Attribute is a Global (system) Attribute.
EntityTypeId Gets or sets the EntityTypeId of the EntityType that this Attribute is used to configure. This property will not be populated if the Attribute is a Global (system) Attribute.
EntityTypeQualifierColumn Gets or sets the entity type qualifier column that contains the value (see EntityTypeQualifierValue) that is used narrow the scope of the Attribute to a subset or specific instance of an EntityType.
EntityTypeQualifierValue Gets or sets the entity type qualifier value that is used to narrow the scope of the Attribute to a subset or specific instance of an EntityType.
FieldType Gets or sets the FieldType that is used to get/capture the value of the Attribute
FieldTypeId Gets or sets the FieldTypeId of the FieldType that is used to select/set the AttributeValue for this Attribute setting. The FieldType can also be used to enforce formatting of the attribute setting. This property is required.
ForeignGuid
ForeignId
ForeignKey
Guid
IconCssClass Gets or sets the name of the icon CSS class. This property is only used for CSS based icons.
Id
IdKey
IsActive Gets or sets a value indicating whether this attribute is active.
IsAnalytic Gets or sets a value indicating whether this instance is analytic. NOTE: Only applies if this is an Attribute on an Entity that implements IAnalytic and has an [AnalyticAttributes] Attribute If this is true, the Analytic table for this entity should include a field for this attribute
IsAnalyticHistory Gets or sets a value indicating whether this instance is analytic history. Only applies if this is an Attribute on an Entity that implements IAnalyticHistorical and IsAnalytic is True If this is true and IsAnalytic is also true, a change in value of this Attribute on the Entity makes the CurrentRowIndicator=1 record to become CurrentRowIndicator=0, sets the ExpireDate, then a new row with CurrentRowIndicator=1 to be created
IsDefaultPersistedValueDirty Gets or sets a value indicating whether the persisted values are considered dirty. If the values are dirty then it should be assumed that they are not in sync with the DefaultValue property.
IsGridColumn Gets or sets a flag indicating if this Attribute is a Grid Column?
IsIndexEnabled Gets or sets a value indicating whether this instance is index enabled.
IsMultiValue Gets or sets a flag indicating if the Attribute supports multiple values.
IsPublic Indicates whether or not this attribute should be displayed in public contexts (e.g., responding to an RSVP without logging in).
IsRequired Gets or sets a flag indicating if a value is required.
IsSuppressHistoryLogging Gets or sets a flag indicating if changes to the attribute values should be recorded into the generic History log table.
IsSystem Gets or sets a flag indicating if this Attribute is part of the Rock core system/framework. This property is required.
IsValid
Item
Key Gets sets the Key value that is used to reference and call the Attribute. This property is required.
ModifiedAuditValuesAlreadyUpdated
ModifiedByPersonAlias
ModifiedByPersonAliasId
ModifiedByPersonId
ModifiedByPersonName
ModifiedDateTime
Name Gets or sets the Name of the Attribute. This property is required.
Order Gets or sets the display order of the attribute.
ParentAuthority Gets the parent authority.
ParentAuthorityPre
PostHtml Gets or sets any HTML to be rendered after the attribute's edit control
PreHtml Gets or sets any HTML to be rendered before the attribute's edit control
ShowOnBulk Gets or sets a flag indicating if this attribute shows when doing a bulk entry form.
SupportedActions
TypeId
TypeName
UrlEncodedKey
ValidationResults