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.6.308

Syntax

C++

Copy

void Embed(
	IPage componentContentToEmbed,
	bool bypassPermission = false
)

Sub Embed ( 
	componentContentToEmbed As IPage,
	Optional bypassPermission As Boolean = false
)

void Embed(
	IPage^ componentContentToEmbed, 
	bool bypassPermission = false
)

abstract Embed : 
        componentContentToEmbed : IPage * 
        ?bypassPermission : bool 
(* Defaults:
        let _bypassPermission = defaultArg bypassPermission false
*)
-> unit

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

Exception	Condition
ArgumentNullException	When "componentContentToEmbed" parameter is null value
ArgumentException	When 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.

Reference

IComponentElement Interface

Embed Overload

Ingeniux.CMS Namespace

IComponentElementAddLanguageSpecificTextSet("LST1253352A_0?cpp=::|nu=.");Embed Method (IPage, Boolean)

Parameters

Reference

IComponentElementEmbed Method (IPage, Boolean)