Click or drag to resize

IComponentElementShare Method


Unembeds the content off the component and turn it into an actual Page object and place it under the given root.

Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
Syntax
IPage Share(
	IPage rootPage,
	bool placeAtEnd = false,
	IPageVersion overrideContent = null,
	string overrideName = ""
)

Parameters

rootPage  IPage
Root page to place the extracted component under
placeAtEnd  Boolean  (Optional)
Specifies whether or not to place the component at the root page's children. Default is to place in the front.
overrideContent  IPageVersion  (Optional)
The page version content to replace the embed content of this component. When specified, this content will be used to create the shared component instead.
overrideName  String  (Optional)

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

Return Value

IPage
The extracted component, null if component is not in embedded mode
Exceptions
ExceptionCondition
ArgumentExceptionWhen root page is null
InvalidOperationExceptionWhen current user doesn't have IGX_USER_RIGHT_CAN_EMBED_UNEMBED_COMPONENTS rights, or user doesn't have write access to root page node
See Also