ICustom
|
Represents the settings for a custom tab interface displayed on CMS UI
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 10.6.492
SyntaxThe ICustomTabSetting type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | AdminOnly | Gets/sets whether this tab only allows administrators to see. |
| AllowPinning | Obsolete. Obsolete. |
| AppendAssetFolderID | Gets/sets whether to include "assetFolderId" query string with id of the asset folder as value, in the URL of this custom tab inner frame. |
| AppendAssetID | Gets/sets whether to include "assetId" query string with id of the asset as value, in the URL of this custom tab inner frame. |
| AppendPageID | Gets/sets whether to include "pageId" query string with id of the page as value, in the URL of this custom tab inner frame. |
| Archived |
Gets/sets the archived value of this entity
(Inherited from IEntity) |
| AssetFolders | Gets/sets the explicit list of asset folders that are allowed to carry this custom tab on CMS UI. |
| Assets | Gets/sets the explicit list of assets that are allowed to carry this custom tab on CMS UI. |
| AssetSchemas | Gets/sets the list of schemas for assets that are allowed to carry this custom tab on CMS UI. |
| AutoSelect | Gets/sets whether to auto select this tab when a page or asset/asset folder is selected. |
| Created |
Gets the entity's creation date.
(Inherited from IEntity) |
| CreationUser |
Gets the ID of the User who created this entity.
(Inherited from IEntity) |
| Disable | Sets/sets whether this custom tab is disabled. Disabled tabs will not display on CMS UI. |
| DisplayName | Gets/sets the name showing on the tab label for this custom tab |
| Global | Gets/sets whether this custom is global. Global custom tabs will show up in the "Apps" listing. |
| Icon | Gets/sets the icon image path for the custom tab |
| IconClass | Gets/sets the index of the icon in the CMS icon listing. |
| LastModified |
Gets the date when the entity was most recently modified.
(Inherited from IEntity) |
| LastModifiedUser |
Gets the ID of the User who lasted edited the entity.
(Inherited from IEntity) |
| Manager |
Gets the manager that retrieved this entity instance.
(Inherited from IEntityTManager) |
| Pages | Gets/sets the explicit list of pages that are allowed to carry this custom tab on CMS UI. |
| ResourceID | Gets/sets the resource id for tab label. If this settings is in place, DisplayName will not be used. The resource id must exist in the [locale].resx file in l10n/server folder under CMS site file structure. |
| Schemas | Gets/sets the list of schemas for pages that are allowed to carry this custom tab on CMS UI. |
| Session |
Gets the session that retrieved this entity. An entity is always session-specific.
(Inherited from IEntity) |
| SessionId |
Gets the unique ID of the session that retrieved this entity.
(Inherited from IEntity) |
| TabsToHide | Gets/sets the list of the name of other standard tabs to hide. |
| Url | Gets/sets the URL of the custom tab. It can be either a full URL with protocol in the front, or a relative path within CMS system |
| UserGroups | Gets/sets the list of user groups that are allowed to see this custom tab. |
Methods| Name | Description | |
|---|---|---|
 | AbsoluteIconPath | Retrieves the absolute URL of the icon image. |
| AbsoluteUrl | Retrieves the absolute URL of the custom tab content to display |
| CanShow | Checks whether this custom tab is allowed to show on the given content, for given user. |
| Touch |
Updated the entity's LastModified value to the current time.
(Inherited from IEntity) |
| ValidateData |
Validates this entity's data. Implemented by concrete inheriting types.
(Inherited from IEntity) |
| ValidateUserPermission |
Validates the user permission on the current entity. Implemented by concrete inheriting types.
It is called automatically upon saving an entity.
(Inherited from IEntity) |
Events| Name | Description | |
|---|---|---|
 | AfterEntitySave |
This event is fired after a Entity object is saved.
(Inherited from IEntityEvents) |
| BeforeEntitySave |
This event is fired before any Entity object is about to be saved.
(Inherited from IEntityEvents) |
See Also