Click or drag to resize

IComponentElementEmbed Method (IPage, Boolean)


Embeds a component. The component can be an existing Page object or newly creately that hasn't been save to Content Store yet. For an component created from scratch, "Id" attributes will be empty, since the embedded component doesn't need its own identification.

Namespace:  Ingeniux.CMS
Assembly:  Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.5.94
Syntax
void Embed(
	IPage componentContentToEmbed,
	bool bypassPermission = false
)

Parameters

componentContentToEmbed
Type: Ingeniux.CMSIPage
The component to embed. Can be an existing component (with Id), or new component not saved yet (without Id). It is OK to allow the embedded component to be a Page with View or Template
bypassPermission (Optional)
Type: SystemBoolean

[Missing <param name="bypassPermission"/> documentation for "M:Ingeniux.CMS.IComponentElement.Embed(Ingeniux.CMS.IPage,System.Boolean)"]

Exceptions
ExceptionCondition
ArgumentNullExceptionWhen "componentContentToEmbed" parameter is null value
ArgumentExceptionWhen component has CompTypes limitations, and the content schema is not in the list.
Remarks
It is allowed for embedded component to embed another component. The new embed component will replace the old one.
See Also