模型属性和方法

最后更新: | 浏览次数: 944|前端开发

在模板中调用相应的属性和方法时，需严格区分大小写，具体语法请阅读系统模板语法文章

全局属性与全局方法可在任意模板页面中使用，返回当前站点的相应信息，如果系统有配置多个站点，当前模板页为站点A使用，则返回的值为站点A的配置信息，全局属性和方法以@Cms.开头，例如：

<div>
   <!--调用站点名称-->
   <h1>@Cms.SiteName</h1>
   <!--调用站点Logo-->
   <a href="@Cms.Domain"><img src="@Cms.Logo" alt="@Cms.SiteName"/></a>
</div>

全局属性

属性名称 属性说明 返回类型 对应设定(返回)值
SiteName 站点名称 String 站点设置->站点名称
Domain 站点域名 String 站点管理->站点编辑
CdnDomain CDN加速域名 String 站点设置 -> CDN配置
Logo 站点图片Logo路径 String 站点设置->站点Logo
Ico 站点图标URL路径 String 站点设置->站点Ico
Direction 文字方向 String 站点管理->站点编辑
Language 站点语言 String 站点管理->语言标识
Lic 客户端授权码 String 用户客户端授权判断
Theme 站点模板目录URL String 域名(CDN域名)/theme/模板名称
RealTheme 站点模板目录Url路径 String 域名/theme/模板名称
PageName 页面类型标识 String 值：home/category/product/article/shoppingcart
ClientIp 客户端IP地址 String 访客IP地址
StatusCode 页面状态码 int 页面状态数据
ConstMode 意见征求模式 Int 站点设置->隐私设置
IsMobile 是否为移动设备 Boolean  
IsTablet 是否为平板设备 Boolean  
IsDesktop 是否为桌面设备 Boolean  
DisableContextMenu 是否屏蔽右键菜单 Boolean 站点设置->阅读&询盘
IsEnableBasket 是否允许购物车 Boolean  
IsEnableInquiry 是否允许询盘 Boolean 站点->站点设置->阅读&询盘
IsRequiredCaptcha 留言是否需要验证 Boolean 站点设置->阅读&询盘
Version 系统版本号 String 系统当前程序版本号
IsLogin 会员是否登录 Boolean 会员是否已登录
MemberName 会员登录名 String 会员名称
Structured 结构化对象数据 Object 详见：Structured属性
Soical 社媒对象数据 Object 详见Social属性
Verify 搜索引擎验证 Object 详见:Verify属性

Structured属性

Structured数据对应管理后台:站点->站点设置->结构化数据

调用电子邮件示例

<a href="mailto:@Cms.Structured.Email">@Cms.Structured.Email</a>
属性名称 属性说明 返回类型 备注
OrganizationName 机构/商家名称 String  
Logo 机构/商家Logo String  
Image 机构/商家对应的店招图片 String  
Country 机构/商家所在国家 String 返回为国家代码，非具体国家名称
Locality 机构/商家所在城市 String  
Address 机构/商家详细地址 String  
PostalCode 邮政编码 String  
TelePhone 联系电话 String  
Email 电子邮件 String  
WhatsApp whatsapp号码 String  
Skype skype号码 String  
QQ QQ号码 String  
WeChat 微信二维码图片 String  

Social对象

属性名称 返回类型 属性说明
Youtube String 对应组织/商家/个人的社交媒体主页
Facebook String
Twitter String
Linkedin String
Pinterest String
Instagram String
Reddit String
TikTok String
OnlineShop String
LiveUrl String

Verify对象

用于搜索引擎管理员验证，

名称 返回类型 说明
Google String Google管理员控制台验证字符串
Baidu String 百度站长平台验证字符串
Bing String Bing管理员控制台验证字符串
Yandex String Yandex管理员控制台验证字符串
GoogleAnalyticsId String Google Analaytics Tag Id
MetricaId String Yandex Metrica Tag Id

全局方法

方法名称 描述 说明
局部调用
如果网站所有页面中有大量公共的内容(例如网站顶部/底部区域等)，可将这部分内容独立出来，采用局部调用的方式
Load(string partialViewName) 调用局部模板 @Cms.Load("header")
Load(string partialViewName, T arg) 调用局部模板  
Load(string partialViewName, T arg, T2 arg2) 调用局部模板  
Load(string partialViewName, T arg, T2 arg2, T3 arg3) 调用局部视图  
分类获取
HasChilds(int categoryId) 判断分类Id下是否有子类  
HasChilds(string categoryAlias) 判断分类别名下是否有子类  
ColAll(int categoryId=0) 按分类Id获取其所有子类  
ColAll(string alias) 按分类别名获取其下所有子类  
Col(int categoryId) 按分类Id获取其分类信息
Col(string alias) 按分类别名获取其分类信息  
ColChilds(int categoryId=0) 按分类Id获取其下直接子类  
ColChilds(string alias) 按分类Id获取其下直接子类  
GetGroup(string groupName) 按分组获取分类列表  
链接生成
Link(Content content,string cssClass=null)例 生成内容链接  
获取 
@foreach(var item in Model.List)
    {
        @Cms.link(item)
    }
Link(CategoryBase category,string cssClass=null) 生成分类链接  
Link(Content content,string fragment,object htmlAttributes) 生成内容链接  
Link(CategoryBase category,string fragment,object htmlAttributes) 生成分类链接  
Url(Content content,string fragment=null) 生成内容Url地址  
Url(CategoryBase category,string fragment=null) 生成分类链接地址  
Url(string categoryAlias) 生成分类链接(如分类不存在，则返回#)  
获取内容
Top(ProductAttr attr,int top,string categoryAlias=null,bool child=true) 按分类别名和属性取前N条商品  
Top(ProductAttr attr,int top,int categoryId=0,bool child=false) 按分类id和属性取N条商品  
Top(ArticleAttr attr,int top,string alias,bool child=false) 按分类别名和属性取前N条文章  
Top(ArticleAttr attr,int top,int categoryId,bool child=false) 按分类id和属性取前N条文章  
社交媒体与其它
SocialFollow(string cssClass = null) 社交媒体个人主页  
SocialShare(string cssClass = null) 社交分享按钮  
Filesize(string virtualFilePath) 生成文件路径  
ConvertUrl(string virtualUrl) 转换Url  
SubString(string str, int length) 截取字符串  
Raw(string str) 输出原生HTML  
Format(string str) 将字符串中的换行符替换为<br/>标签  
Banner(string identName,string viewPath=null) 调用广告  
GetAdvert(string identName,string viewPath=null) 调用广告(v5版本将弃用)  

分类页属性

属性名称  属性说明  返回类型 是否支持
内容 分类 首页 搜索页 标签页
Name 当前页面名称 String          
FriendlyName 当前页面友好名称 String         -
Alias 当前页面Url别名 String          
Thumb 当前页面第一张缩略图 String          
Title 当前页面标题  String          
Description 当前页面描述  String          
Id 当前页面Id Int     0 0  
RootId 当前页面一级分类Id Int     0 0 0
CategoryId 当前页面所属分类Id Int     0 0 0
CurrentCategory 当前页面分类信息 CategoryBase          
CanonicalUrl 当前页面权威Url  String          
CurrentUrl 当前页面Url  String          
CreateTime 当前页面创建时间 Time          
IsEnableIndex 当前页面是否允许索引 boolean          
               
Thumbs 当前页面缩略图列表  List<PhotoItem>     × × ×
ThumbCaption 当前页面第一张缩略图alt文字 String     × × ×
ParentId 当前页面父类分类Id 分类     0 0 0
Content 当前页面内容  HtmlString     × ×  
Video 当前页面视频地址  string     × × ×
VideoPoster 页面视频封面图片地址  string     × × ×
RelatedArticles 当前页面关联文章 List<ArticleBase>     × × ×
RelatedProducts 当前页面关联产品 List<ProductBase>     × × ×
List 当前页面内容  List<Content> ×   × × ×
JumpUrl 当前页面跳转地址 String     × × ×
File 当前页面第一个附件 FileltemModel     × × ×
FileList 当前页面附件列表 List<FilelemModel>     × × ×
FileCount 当前页面附件总数 Int     × × ×
HasChilds 当前页面是否有分类  Boolean ×   × × ×
ModifiedTime 当前页面编辑时间 Time ×   × × ×
IsOpenBlank 当前页面是否新标签页打开  Boolean ×   × × ×
IsWideMenu 当前页面是否宽屏显示菜单  Boolean ×   × × ×
ShowChildMenu 当前页面是否显示子菜单  Boolean ×   × × ×
ShowContentMenu 当前页面是否显示内容菜单  Boolean ×   × × ×
Attributes 当前页面属性分类 List<sss>     × × ×
               
FieldList 内容所有扩展字段  Dictionary<string,string>   × × × ×
ContentNavList 内容结构 List<ContentNavModel>   × × × ×
Tags 内容标签 List<TagBase>   × × × ×
Visit 内容查看次数  Int   × × × ×
IsTop 内容是否置顶  Boolean   × ×    
IsHot 内容是否热门  Boolean   × × × ×
IsRcommend 内容是否推荐 Boolean   × × × ×
               
Number 产品编号  String   × × × ×
SubName 产品副标题  String   × × × ×
Price 产品价格  Decimal   × × × ×
Unit 产品单位  String   × × × ×
Ad 产品广告词 String   × ×    
Stock 产品库存  Int   × × × ×
SaleCount 产品销量  Int   × × × ×
IsNew 产品是否新品  Boolean   × × × ×
IsPromotion 产品是否促销  Boolean   × × × ×
Gallery 产品画集图册 ThumbList   × × × ×
ProductBrand 产品品牌  String   × × × ×
RatingValue 产品评分  String   × × × ×
SaleCount 产品销量 Int   × × × ×
SKU 产品SKU  String   × × × ×
Mpn 产品制造商编号  String   × × × ×
               
IsHead 文章是否头条  Boolean   × × × ×
               
GetType              
IsNoFolllow 是否不追踪            
NodeList              
SortLink              
SortUrl 生产排序链接            
ToString              
OgType              
Depth  分类深度  Int          
EnableComment 是否允许评论  Boolean   × × × ×
AttributeGroupId  页面分类属性组Id            
ReviewName 表示将在运行时解析其操作的对象 Dynamic          

分类页方法

方法名 说明 是否支持
内容 分类 首页 搜索页 标签页
Banner(string viewPath = null) 获取当前页面Banner图片     × × ×
BreadCrumb(string cssClass = null, bool self = true) 生成当前页面面包屑导航     ×    
AttriuteUrl(int attributeId, int valueId) 生成当前页面属性值链接 × × × × ×
AttributeIgnoreUrl(int attributeId) 取消当前页面属性选择链接 × × × × ×
PagingSimple(string cssClass = "pager", string prevText = "《", string nextText = "》") 生成当前页面简单上下页 ×   ×    
Paging(string cssClass = "pagination", int pageItem = 10, string prevText = "《", string nextText = "》") 生成当前页面列表 ×   ×    
GetUnions(int top) 取当前页面前后各N条数据，如Top值为2，则取前后各2条。共4条记录   × × × ×
Download(string field) 下载当前页面的第一个附件   × × × ×
GetPrevs(int top) 取当前页面前N条记录   × × × ×
GetNexts(int top) 取当前页面后N条记录   × × × ×
Prev() 当前页面上一条内容   × × × ×
PrevUrl() 当前页面上一条内容Url   × × × ×
Next() 当前页面下一个内容   × × × ×
NextUrl() 当前页面下一个内容Url   × × × ×