IComponentElementEmbed Method (IPageVersion)
|
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.3.169
Syntax void Embed(
IPageVersion componentContentToEmbed
)
Sub Embed (
componentContentToEmbed As IPageVersion
)
void Embed(
IPageVersion^ componentContentToEmbed
)
abstract Embed :
componentContentToEmbed : IPageVersion -> unit
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
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.
See Also