Block
Represents an implementation of a
BlockType in Rock. A block can be implemented on a Site's
Layout and appear on all pages on the site that uses that template or on an individual
Page. An example of a Block being implemented on a layout template would be an implementation of a HTML Content Block Type in the footer zone of a layout that contains the site's copyright notice. This Block will show on all
Pages of the
Site that uses the layout. An example of a Block being implemented on a page would be the New Account
BlockType being implemented on the New Account page.
| AdditionalLavaFields | |
| AdditionalSettings | Gets or sets the additional settings. |
| Attributes | |
| AttributeValueDefaults | |
| AttributeValues | |
| AvailableKeys | |
| BlockLocation | Gets the location where this Block is being implemented on (Page, Layout, or Site) This is a hard coded list of values defined in the code as an enumeration.
Show Values |
| BlockType | Gets or sets the BlockType entity that this Block is implementing. |
| BlockTypeId | Gets or sets the Id of the BlockType that this Block is implementing. This property is required. |
| ContextKey | |
| CreatedByPersonAlias | |
| CreatedByPersonAliasId | |
| CreatedByPersonId | |
| CreatedByPersonName | |
| CreatedDateTime | |
| CssClass | Gets or sets an optional CSS class to include when the block's parent container is rendered |
| CustomSortValue | |
| EncryptedKey | |
| EntityStringValue | |
| ForeignGuid | |
| ForeignId | |
| ForeignKey | |
| Guid | |
| Id | |
| IdKey | |
| IsSystem | Gets or sets a flag indicating if this Block was created by and is a part of the Rock core system/framework. This property is required. |
| IsValid | |
| Item | |
| Layout | Gets or sets the Layout entity that this Block is implemented on. This property will be null if this Block is being implemented on as part of a Page or Site. |
| LayoutId | Gets or sets the Id of the Layout that this Block is implemented on. This property will only be populated if the Block is implemented on a Layout. Blocks that have a specific LayoutId will be shown on all pages on a site that have the specified LayoutId |
| ModifiedAuditValuesAlreadyUpdated | |
| ModifiedByPersonAlias | |
| ModifiedByPersonAliasId | |
| ModifiedByPersonId | |
| ModifiedByPersonName | |
| ModifiedDateTime | |
| Name | Gets or sets a user defined name of the block implementation. This property is required. |
| Order | Gets or sets the order that this Block appears in the Page/Layout zone that the Block is implemented in. Blocks are displayed/rendered in Ascending (1,2,3,...) order. The lower the number the higher in the Zone the Block will appear. Page Blocks have priority over layout Blocks, so they will appear higher in the Zone than Site/Layout Blocks. This property is required |
| OutputCacheDuration | Gets or sets the length of time (in minutes) that the Block's data is cached. This property is required. |
| Page | Gets or sets the Page entity that this Block is implemented on. This property will be null if this Block is being implemented on as part of a Layout or Site. |
| PageId | Gets or sets the Id of the Page that this Block is implemented on. This property will only be populated if the Block is implemented on a Page. Blocks that have a specific PageId will only be shown in the specified Page |
| ParentAuthority | Gets the securable object that security permissions should be inherited from based on BlockLocation (Page, Layout, or Site) |
| ParentAuthorityPre | |
| PostHtml | Gets or sets any HTML to be rendered after the block |
| PreHtml | Gets or sets any HTML to be rendered before the block |
| Site | Gets or sets the Site entity that this Block is implemented on. This property will be null if this Block is being implemented on as part of a Page or Layout. |
| SiteId | Gets or sets the Id of the Site that this Block is implemented on. This property will only be populated if the Block is implemented on a Site. Blocks that have a specific SiteId will be shown on all pages on a site |
| SupportedActions | Provides a Dictionary`2 of actions that this model supports, and the description of each. |
| TypeId | |
| TypeName | |
| UrlEncodedKey | |
| ValidationResults | |
| Zone | Gets or sets the name of the layout zone/section that this Block is being implemented on. This property is required. |