C# Class Sdl.Web.Common.Models.RegionModel

Represents the View Model for a Page Region.
Inheritance: Region
Exibir arquivo Open project: sdl/dxa-web-application-dotnet Class Usage Examples

Public Methods

Method Description
DeepCopy ( ) : ViewModel

Creates a deep copy of this View Model.

Equals ( object obj ) : bool

Determines whether the specified object is equal to the current Region Model, i.e. it has the same name.

ExtractSyndicationFeedItems ( Sdl.Web.Common.Configuration.Localization localization ) : IEnumerable

Extracts syndication feed items.

FilterConditionalEntities ( Sdl.Web.Common.Configuration.Localization localization ) : void

Filters (i.e. removes) conditional Entities which don't meet the conditions.

Applies to this Region and all its nested Regions.

GetHashCode ( ) : int

Serves as a hash function for a particular type.

GetXpmMarkup ( Sdl.Web.Common.Configuration.Localization localization ) : string

Gets the rendered XPM markup

RegionModel ( string name ) : System.Collections.Generic

Initializes a new RegionModel instance.

RegionModel ( string name, string qualifiedViewName ) : System.Collections.Generic

Initializes a new RegionModel instance for an empty/non-existing Region.

ToString ( ) : string

Returns a string that represents the current object.

Method Details

DeepCopy() public method

Creates a deep copy of this View Model.
public DeepCopy ( ) : ViewModel
return ViewModel

Equals() public method

Determines whether the specified object is equal to the current Region Model, i.e. it has the same name.
public Equals ( object obj ) : bool
obj object The object to compare with the current object.
return bool

ExtractSyndicationFeedItems() public method

Extracts syndication feed items.
public ExtractSyndicationFeedItems ( Sdl.Web.Common.Configuration.Localization localization ) : IEnumerable
localization Sdl.Web.Common.Configuration.Localization The context .
return IEnumerable

FilterConditionalEntities() public method

Filters (i.e. removes) conditional Entities which don't meet the conditions.
Applies to this Region and all its nested Regions.
public FilterConditionalEntities ( Sdl.Web.Common.Configuration.Localization localization ) : void
localization Sdl.Web.Common.Configuration.Localization The context Localization.
return void

GetHashCode() public method

Serves as a hash function for a particular type.
public GetHashCode ( ) : int
return int

GetXpmMarkup() public method

Gets the rendered XPM markup
public GetXpmMarkup ( Sdl.Web.Common.Configuration.Localization localization ) : string
localization Sdl.Web.Common.Configuration.Localization The context Localization.
return string

RegionModel() public method

Initializes a new RegionModel instance.
public RegionModel ( string name ) : System.Collections.Generic
name string The name of the Region.
return System.Collections.Generic

RegionModel() public method

Initializes a new RegionModel instance for an empty/non-existing Region.
public RegionModel ( string name, string qualifiedViewName ) : System.Collections.Generic
name string The name of the Region.
qualifiedViewName string The qualified name of the View to use to render the Region. Format: format AreaName:ControllerName:ViewName.
return System.Collections.Generic

ToString() public method

Returns a string that represents the current object.
public ToString ( ) : string
return string