Applications.Cms.WebModules Entity

Namespace: Applications.Cms

The abstract basic building block of web sites. Each module can render multiple web pages. Entity: Cms_Web_Modules (Obsoleted in version 22.1.6.73)

Note

OBSOLETE! Do not use!

Default Visualization

Default Display Text Format:
{Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
Applications.Cms.WebSites
Aggregate Root:
Applications.Cms.WebSites

Attributes

Name	Type	Description
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Id	guid
IsPublished	boolean	Specifies whether the module is published and will be showed in the web site. `Required` `Default(false)` `Filter(eq)`
LocalUrl	string (128) nullable	The local Module Url. The full Url of a module is formed based on the sites Base Url, the local Urls of all parent modules and the module Local Url. Null means that the web Module is the default web module within the parent path. `Filter(like)`
ModulePicture	byte[] nullable	Default picture. Used for picture links, small module icons, etc. PNG format is suggested.
ModuleType	ModuleType	Specifies the content handler. The content handler is responsible for generating the actual web page content. Module Types include Category, Static, News, Product, etc. `Required` `Filter(like)`
Name	string (512)	Multilanguage Module name. This is used as a title when displaying the web Module. `Required` `Filter(like)`
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

References

Name	Type	Description
~~Parent~~	WebModules (nullable)	OBSOLETE! Do not use! The parent web Module. It can only be a module with Module Type = Category. Null means that the web Module is root web Module. `Obsolete` `Filter(multi eq)` `Obsoleted in version 25.1.1.47` `Obsolete`
~~WebSite~~	WebSites	OBSOLETE! Do not use! The web site to which the module belongs. `Obsolete` `Required` `Filter(multi eq)` `Obsoleted in version 25.1.1.47` `Obsolete` `Owner`

Attribute Details

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsPublished

Specifies whether the module is published and will be showed in the web site. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LocalUrl

The local Module Url. The full Url of a module is formed based on the sites Base Url, the local Urls of all parent modules and the module Local Url. Null means that the web Module is the default web module within the parent path. Filter(like)

Type: string (128) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

ModulePicture

Default picture. Used for picture links, small module icons, etc. PNG format is suggested.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

ModuleType

Specifies the content handler. The content handler is responsible for generating the actual web page content. Module Types include Category, Static, News, Product, etc. Required Filter(like)

Type: ModuleType
Category: System
Allowed values for the ModuleType data attribute
Allowed Values (Applications.Cms.WebModulesRepository.ModuleType Enum Members)

Value	Description
CategoryPage	CategoryPage value. Stored as 'CAT'. Database Value: 'CAT' Model Value: 0 Domain API Value: 'CategoryPage'
Static	Static value. Stored as 'STA'. Database Value: 'STA' Model Value: 1 Domain API Value: 'Static'
News	News value. Stored as 'NEW'. Database Value: 'NEW' Model Value: 2 Domain API Value: 'News'

Supported Filters: Like
Supports Order By: False
Show in UI: ShownByDefault

Name

Multilanguage Module name. This is used as a title when displaying the web Module. Required Filter(like)

Type: string (512)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 512
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Reference Details

Parent

OBSOLETE! Do not use! The parent web Module. It can only be a module with Module Type = Category. Null means that the web Module is root web Module. Obsolete Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete

Type: WebModules (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

WebSite

OBSOLETE! Do not use! The web site to which the module belongs. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete Owner

Type: WebSites
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST