Click or drag to resize

IComponentElementEmbed Method (IPageVersion, String, Boolean)
Embeds a component. The component can be an existing Page Version object or newly creately that hasn't been save to Content Store yet. For an component Page Version 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.6.308
Syntax
Copy
void Embed(
	IPageVersion componentContentToEmbed,
	string schemaNameOverride = "",
	bool bypassPermission = false
)

Parameters

componentContentToEmbed
Type: Ingeniux.CMSIPageVersion
The component to embed. Can be an existing component (with XID), or new component not saved yet (without XID). It is OK to allow the embedded component to be a Page with View or Template
schemaNameOverride (Optional)
Type: SystemString
Override schema name, for validataion of comp types
bypassPermission (Optional)
Type: SystemBoolean

[Missing <param name="bypassPermission"/> documentation for "M:Ingeniux.CMS.IComponentElement.Embed(Ingeniux.CMS.IPageVersion,System.String,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