C# Class DD4T.Mvc.SiteEdit.SiteEditService

Exibir arquivo Open project: dd4t/DD4T.MVC

Public Properties

Property	Type	Description
ComponentSeFormat	string
FieldSeFormat	string
MULTI_VALUE_SE_XPATH_Format	string
PageSeFormat	string
SIMPLE_SE_XPATH_PREFIX	string
SINGLE_VALUE_SE_XPATH_Format	string
SiteEditSettings	SiteEditSettings
Ui2012BootStrap	string
Ui2012ComponentSeFormat	string
Ui2012FieldSeFormat	string
Ui2012PageSeFormat	string
Ui2012RegionSeFormat	string

Public Methods

Method	Description
GenerateSiteEditComponentTag ( IComponentPresentation cp, bool queryBased, string region ) : string	Generates a SiteEdit tag for a componentpresentation. It also needs to know which region it's in (for component swapping) and the order of the page (for a true unique ID).
GenerateSiteEditComponentTag ( IComponentPresentation cp, string region ) : string	Generates a SiteEdit tag for a component presentation. Assumes that the component presentation is not query based.
GenerateSiteEditFieldMarkingWithXpath ( string fieldname, string xpath ) : string	Function generates a fieldmarking for a single-value SiteEditable field based on field name and xpath. For multi-value fields, please code the JSON yourself.
GenerateSiteEditFieldTag ( IField field ) : string	generates siteedit field tag
GenerateSiteEditFieldTag ( IField field, int mvOrder ) : string	generates siteedit field tag for a specific instance of multivalue field.
GenerateSiteEditPageTag ( IPage page ) : string	Generates SiteEdit tag for given page.
GenerateSiteEditRegionTag ( string title, int minOccurs, int maxOccurs, string schemaUri, string templateUri ) : string	It is possible to mark regions in your Page, so that only Components of a certain Schema can be dropped in there and the correct Component Template will automatically be applied to them.
IsSiteEditEnabled ( IRepositoryLocal item ) : bool	Support function, checking if SE is enabled for the given item ID.

Private Methods

Method	Description
GenerateSiteEditFieldMarking ( string fieldname ) : string
GenerateSiteEditFieldMarking ( string fieldname, int mvOrder ) : string
GenerateSiteEditFieldMarking ( string fieldname, string schemaname ) : string
GenerateSiteEditFieldMarking ( string fieldname, string schemaname, int mvOrder ) : string
GetUniqueCpId ( ) : int
XPath2Name ( string xpath ) : string

Method Details

GenerateSiteEditComponentTag() public static method

Generates a SiteEdit tag for a componentpresentation. It also needs to know which region it's in (for component swapping) and the order of the page (for a true unique ID).

public static GenerateSiteEditComponentTag ( IComponentPresentation cp, bool queryBased, string region ) : string
cp	IComponentPresentation	The componentpresentation to mark.
queryBased	bool	indicates whether the component presentation is the result of a query (true), or if it is really part of the page (false)
region	string	The region the componentpresentation is to be shown in.
return	string

GenerateSiteEditComponentTag() public static method

Generates a SiteEdit tag for a component presentation. Assumes that the component presentation is not query based.

public static GenerateSiteEditComponentTag ( IComponentPresentation cp, string region ) : string
cp	IComponentPresentation	the component presentation to mark.
region	string	The region the componentpresentation is to be shown in.
return	string

GenerateSiteEditFieldMarkingWithXpath() public static method

Function generates a fieldmarking for a single-value SiteEditable field based on field name and xpath. For multi-value fields, please code the JSON yourself.

public static GenerateSiteEditFieldMarkingWithXpath ( string fieldname, string xpath ) : string
fieldname	string	the name of the field
xpath	string	xpath
return	string

GenerateSiteEditFieldTag() public static method

generates siteedit field tag

public static GenerateSiteEditFieldTag ( IField field ) : string
field	IField	the field to mark
return	string

GenerateSiteEditFieldTag() public static method

generates siteedit field tag for a specific instance of multivalue field.

public static GenerateSiteEditFieldTag ( IField field, int mvOrder ) : string
field	IField	the field to mark
mvOrder	int	order of the multivalue instance (zero based)
return	string

GenerateSiteEditPageTag() public static method

Generates SiteEdit tag for given page.

public static GenerateSiteEditPageTag ( IPage page ) : string
page	IPage	Page the tag belongs to.
return	string

GenerateSiteEditRegionTag() public static method

It is possible to mark regions in your Page, so that only Components of a certain Schema can be dropped in there and the correct Component Template will automatically be applied to them.

public static GenerateSiteEditRegionTag ( string title, int minOccurs, int maxOccurs, string schemaUri, string templateUri ) : string
title	string	ContentType name or region title
minOccurs	int	minimum amount of components in this region
maxOccurs	int	maximum amount of components in this region
schemaUri	string	allowed schema tcm uri
templateUri	string	component template uri
return	string

IsSiteEditEnabled() public static method

Support function, checking if SE is enabled for the given item ID.

public static IsSiteEditEnabled ( IRepositoryLocal item ) : bool
item	IRepositoryLocal	the tridion item
return	bool

Property Details

ComponentSeFormat public_oe static_oe property

string Format representing a Component-level SiteEdit tag.

public static string ComponentSeFormat
return	string

FieldSeFormat public_oe static_oe property

string Format representing a simple, non-multivalue SiteEdit field marking.

public static string FieldSeFormat
return	string

MULTI_VALUE_SE_XPATH_Format public_oe static_oe property

public static string MULTI_VALUE_SE_XPATH_Format
return	string

PageSeFormat public_oe static_oe property

string Format used to create the Page-level SiteEdit tags.

public static string PageSeFormat
return	string

SIMPLE_SE_XPATH_PREFIX public_oe static_oe property

public static string SIMPLE_SE_XPATH_PREFIX
return	string

SINGLE_VALUE_SE_XPATH_Format public_oe static_oe property

public static string SINGLE_VALUE_SE_XPATH_Format
return	string

SiteEditSettings public_oe static_oe property

SiteEdit settings object

public static SiteEditSettings SiteEditSettings
return	SiteEditSettings

Ui2012BootStrap public_oe static_oe property

string format representing UI 2012 bootstrap script.

public static string Ui2012BootStrap
return	string

Ui2012ComponentSeFormat public_oe static_oe property

string format representing UI 2012 component level tag.

public static string Ui2012ComponentSeFormat
return	string

Ui2012FieldSeFormat public_oe static_oe property

string format representing UI 2012 field marking.

public static string Ui2012FieldSeFormat
return	string

Ui2012PageSeFormat public_oe static_oe property

string format used to create UI 2012 page level tag.

public static string Ui2012PageSeFormat
return	string

Ui2012RegionSeFormat public_oe static_oe property

string format representing UI 2012 region marking.

public static string Ui2012RegionSeFormat
return	string