模板属性和方法

最后更新: | 浏览次数: 349|开发文档

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

全局属性

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

<div>
   <!--调用站点名称-->
   <h1>@Cms.SiteName</h1>
   <!--调用站点Logo-->
   <a href="@Cms.Domain"><img src="@Cms.Logo" alt="@Cms.SiteName"/></a>
   <!--调用名称为defaultimg的站点扩展字段-->
   <p>@cms["defaultimg"]</p>
</div>
属性名称 属性说明 返回类型 对应设定(返回)值
["fieldname"] fielename为站点扩展字段名称 String 返回站点扩展字段的值,字段不存在则返回空值
SiteName 站点名称 String 站点设置->站点名称
Domain 站点域名 String 站点管理->站点编辑
CdnDomain CDN加速域名 String 站点设置 -> CDN配置
Logo 站点LogoURL路径 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  
IsMobile 是否为移动设备 Boolean  
IsTablet 是否为平板设备 Boolean  
IsDesktop 是否为桌面设备 Boolean  
InlineCss 是否内联CSS Boolean 系统->站点设置->内联核心CSS(图片优化/性能)
DisableContextMenu 是否屏蔽右键菜单 Boolean 站点设置->阅读&询盘
IsEnableBasket 是否允许购物车 Boolean  
IsRequiredCaptcha 留言是否需要验证 Boolean 站点设置->阅读&询盘
IsEnableQuantity 是否允许购物数量选择 Boolean  
GoogleAnalyticsId Google Analytics Id String SEO -> 基础设置->流量与访问统计
GoogleVerifyKey Google Webmaster认证Key String SEO -> 基础设置 -> 站点工具
BaiduVerifyKey 百度站长工具认证Key String
YandexVerifyKey Yandex Webmaster Key String
BingVerifyKey Bing Webmaster Key String
Version 系统版本号 String 系统当前程序版本号
IsLogin 会员是否登录 Boolean 会员是否已登录
MemberName 会员登录名 String 会员名称
CompanyName 公司名称 String 系统设置->站点设置->结构化数据
CompanyLogo 公司LOGO String
CompanyAddress 公司地址 String
Phone 电话号码 String
Email 电子邮件 String
WhatsApp WhatsApp帐号 String
Line Line二维码地址 String
Skype skype号码  
QQ QQ号码 String
Weixin 微信二维码 String
Facebook Facebook帐户主页 String 系统 -> 站点设置 -> 社交媒体
Twitter Twitter帐户主页 String
Linkedin Linkedin帐户主页 String
Youtube Youtube帐户主页 String
Pinterest Pinterest帐户主页 String
Instagram Instagram帐户主页 String
Reddit Reddit帐户主页 String
Tiktok Tiktok帐户主页 string
OnlineShop 在线商铺帐户主页 String
LiveUrl 直接地址主页 String

全局方法

方法名称 描述 说明
局部调用
如果网站所有页面中有大量公共的内容(例如网站顶部/底部区域等)，可将这部分内容独立出来，采用局部调用的方式
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) 按分类Id和属性取前N条商品  
Top(ProductAttr attr,int top,int categoryId=0,bool child=false) 按分类别名和属性取N条商品  
Top(ArticleAttr attr,int top,string alias,bool child=false) 按分类Id和属性取前N条文章  
Top(ArticleAttr attr,int top,int categoryId,bool child=false) 按分类别名和属性取前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/>标签  
GetAdvert(string identName,string viewPath=null) 调用广告  
     

通用属性

属性名称 属性说明 返回类型 页面类型
home category content search tag
Id 当前页面Id Int          
RootId 当前页面一级分类Id Int          
CategoryId 当前页面所属分类Id Int          
OgType OG类型 String          
Name 页面名称 String          
FriendlyName 页面友好名称 String          
Alias 页面Url别名 String          
Thumb 页面缩略图 String          
Title 页面标题 String          
Description 页面描述 String          
CurrentUrl 页面Url地址 String          
CanonicalUrl 页面Url权威地址 String          
CurrentCategory 当前页面所属分类 CategoryBase          
CreateTime 内容创建时间 Datetime          
IsEnableIndex 页面是否允许被收录 Bool          
               
CategoryName              
ContentModel 内容模型(article/product) string          
Visit 页面浏览次数            
Tags 标签列表            
FileList              
File              
BannerModel              
ContentNavList              
Thumbs 页面缩略略            
Video 页面视频            
VideoPoster 页面视频封面            
Content 页面内容            
Summary 页面摘要            
List 页面记录列表            
Attributes 页面属性            
FieldList 页面扩展字段            
JumpUrl 跳转地址            
               
               

 

分类页属性

属性名称 属性说明 返回类型
Id 分类Id Int
Name 分类名称 String
FirendlyName 分类友好名称，如果未设置友好名称，则返回分类名称 string
ParentId 父类分级Id Int
Alias 分类url别名 String
ContentModel 内容模型 String
Depth 分类深度 Int
Thumb 分类缩略图 String
Thumbs 分类缩略图列表 List<PhotoItem>
Video 分类视频地址 string
VideoPoster 分类视频封面图片 string
Content 分类内容 HtmlString
AttributeGroupId 分类属性组Id Int
RootId 分类所属一级分类Id Int
Title 分类标题 String
Description 分类页描述 String
CurrentCategory 当前分类信息 CategoryBase
Description 分类描述 String
List 分类列表 List<Content>
Attributes 分类属性列表 List<sss>
CurrentUrl 分类页当前Url String

分类页方法

方法名称 属性说明  
Banner(string viewPath = null) 获取分类Banner图片设置(调用规则阅读后台栏目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 = "》") 生成分页列表  
IsTop 商品是否置顶  
IsHot 是否热门商品  
IsRcommend 是否推荐商品  
IsNew 是否新品  
IsPromotion 是否促销  
Visit 商品查看次数  
     
     
     
     

商品详情页属性

属性名称 返回类型 属性说明
Id 商品Id号 Int
CategoryId 商品所属分类Id Int
FieldList例 商品所有扩展字段 Dictionary<string,string>
AttributeGroupId 商品所属属性Id Int
Name 商品名称 String
Alias 商品别名 String
JumpUrl 商品页跳转地址 String
Number 商品编号 String
Unit 单位 String
Ad 商品广告词 String
Price 商品价格 Decimal
Stock 商品库存 Int
SaleCount 销量 Int
Thumbs 商品缩略图列表 List<string>
Thumb 商品第一张缩略图 String
Video 产品视频地址 string
VideoPoster 产品视频封面图片 string
Summary 商品摘要 String
IsTop 商品是否置顶 Boolean
IsHot 是否热门商品 Boolean
IsRcommend 是否推荐商品 Boolean
IsNew 是否新品 Boolean
IsPromotion 是否促销 Boolean
Visit 商品查看次数 Int
CreateTime 商品创建时间 DateTime
CurrentCategory 商品前分类信息 CategoryBase
商品方法
Banner(string viewPath = null) 获取商品所属分类Banner图片设置(调用规则阅读后台栏目banner设置说明)  
GetUnions(int top) 取当前商品前后各N条数据，如Top值为2，则取前后各2条。共4条记录 List<ProductBase>
Download(string field) 下载  
BreadCrumb(string cssClass = "breadcrumb", bool self = false) 面包屑导航  
GetPrevs(int top) 取当前商品前N条记录  
Prev() 上一条商品  
PrevUrl() 上一条商品Url  
Next() 下一个商品  
NextUrl() 下一个商品Url  
     
     
     

文章详情页属性

属性名称 属性说明 返回类型
Id 文章Id号 Int
CategoryId 文章所属分类Id Int
CategoryId 商品所属分类Id Int
FieldList 文章所有扩展字段 Dictionary<string,string>
AttributeGroupId 文章所属属性Id Int
Name 文章标题 HtmlString
Alias 文章别名 String
JumpUrl 文章跳转地址 String
Thumbs 文章缩略图列表 List<String>
Thumb 文章第一张缩略图 String
Video 文章视频地址 string
VideoPoster 文章视频封面图片 string
Summary 文章摘要 String
IsTop 是否置顶的文章 Boolean
IsHot 是否热门文章 Boolean
IsRcommend 是否推荐文章 Boolean
Visit 文章浏览次数 Int
CreateTime 文章创建时间 DateTime
CurrentCategory新 文章分类信息 CategoryBase
文章详情方法    
Banner(string viewPath = null) 获取文章所属分类Banner图片设置(调用规则阅读后台栏目banner设置说明)  
GetUnions(int top) 取当前文章前后各N条数据，如Top值为2，则取前后各2条。共4条记录 List<ProductBase>
Download(string field) 下载  
BreadCrumb(string cssClass = "breadcrumb", bool self = false) 面包屑导航  
GetPrevs(int top) 取当前文章前N条记录  
Prev() 上一篇文章  
PrevUrl() 上一篇文章Url  
Next() 下一篇文章  
NextUrl() 下一篇文章Url  
     
     
     
文档