IComponentElementShareBack Method
|
Unembeds the content off the component and save it back to the original component.
This process requires the embedded/override content to have the same schema as the its original component.
Namespace:
Ingeniux.CMS
Assembly:
Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.308
Syntax void ShareBack(
IUserSession session,
bool checkinComponent,
IPageVersion overrideContent = null,
string overrideName = ""
)
Sub ShareBack (
session As IUserSession,
checkinComponent As Boolean,
Optional overrideContent As IPageVersion = Nothing,
Optional overrideName As String = ""
)
void ShareBack(
IUserSession^ session,
bool checkinComponent,
IPageVersion^ overrideContent = nullptr,
String^ overrideName = L""
)
abstract ShareBack :
session : IUserSession *
checkinComponent : bool *
?overrideContent : IPageVersion *
?overrideName : string
(* Defaults:
let _overrideContent = defaultArg overrideContent null
let _overrideName = defaultArg overrideName ""
*)
-> unit
Parameters
- session
- Type: Ingeniux.CMSIUserSession
The session to use to retrieve original component - checkinComponent
- Type: SystemBoolean
Whether to check in the original component automatically, after share back. - overrideContent (Optional)
- Type: Ingeniux.CMSIPageVersion
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 (Optional)
- Type: SystemString
[Missing <param name="overrideName"/> documentation for "M:Ingeniux.CMS.IComponentElement.ShareBack(Ingeniux.CMS.IUserSession,System.Boolean,Ingeniux.CMS.IPageVersion,System.String)"]
Exceptions Exception | Condition |
---|
ArgumentException | When component doesn't have the original component id, or original component no longer exists |
InvalidOperationException | When current user doesn't have [!:Ingeniux.CMS.Enums.EnumUserRight.IGX_USER_RIGHT_CAN_EMBED_UNEMBED_COMPONENTS] rights, or user doesn't have
write access to the original component |
See Also