GlobalConfigurationsServices.GetTreeMenuConfig Method

GlobalConfigurationsServicesGetTreeMenuConfig Method

Ingeniux CMS Web Services API

Retrieves the configuration for Site Tree context menu. It indicates what commands are available for current user on the Site Tree.

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<TreeMenuItemInformation[]> GetTreeMenuConfig()

Public Function GetTreeMenuConfig As XHRServiceResponseGeneric(Of TreeMenuItemInformation())

public:
virtual XHRServiceResponseGeneric<array<TreeMenuItemInformation^>^>^ GetTreeMenuConfig() sealed

abstract GetTreeMenuConfig : unit -> XHRServiceResponseGeneric<TreeMenuItemInformation[]> 
override GetTreeMenuConfig : unit -> XHRServiceResponseGeneric<TreeMenuItemInformation[]>

Return Value

Type: XHRServiceResponseGenericTreeMenuItemInformation

The collection of commands that current user is allow to carry out. Note that they are available commands. The actual command on specific page node may vary.

Examples

Sample JSON return

JavaScript

Copy

        {
    "code": 0,
    "error": null,
    "message": [{
        "Caption": "Empty Recycle Folder",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "delete16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "EmptyRecycleFolder"
    }, {
        "Caption": "New",
        "Children": [{
            "Caption": "Folder",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "folder16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "Folder"
        }, {
            "Caption": "",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "",
            "IsDisplayed": true,
            "IsSeparator": true,
            "Name": "separator1"
        }, {
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "page16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "Page"
        }, {
            "Caption": "Component",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "component16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "Component"
        }],
        "HasSubMenu": true,
        "Icon": "new16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "New"
    }, {
        "Caption": "Rename",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "rename16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Rename"
    }, {
        "Caption": "Refresh",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "refresh16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Refresh"
    }, {
        "Caption": "",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "",
        "IsDisplayed": true,
        "IsSeparator": true,
        "Name": "separator2"
    }, {
        "Caption": "Cut",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "cut16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Cut"
    }, {
        "Caption": "Copy",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "copy16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Copy"
    }, {
        "Caption": "Paste",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "paste16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Paste"
    }, {
        "Caption": "Delete",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "delete16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Delete"
    }, {
        "Caption": "",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "",
        "IsDisplayed": true,
        "IsSeparator": true,
        "Name": "separator3"
    }, {
        "Caption": "Add to Workflow",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "advance16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "AddToWorkflow"
    }, {
        "Caption": "Remove from Workflow",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "revert16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "RemoveFromWorkflow"
    }, {
        "Caption": "Assign To...",
        "Children": [{
            "Caption": "Me",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "user16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "AssignToMe"
        }, {
            "Caption": "User",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "user16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "AssignToUser"
        }, {
            "Caption": "Group",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "usergroup16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "AssignToGroup"
        }],
        "HasSubMenu": true,
        "Icon": "assignto16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "AssignTo"
    }, {
        "Caption": "Advance",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "advance16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Advance"
    }, {
        "Caption": "Show History",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "differences16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "ShowHistory"
    }, {
        "Caption": "Send Mail",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "mailto16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "SendMail"
    }, {
        "Caption": "",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "",
        "IsDisplayed": true,
        "IsSeparator": true,
        "Name": "separator4"
    }, {
        "Caption": "Check Out",
        "Children": [{
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "document16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "CheckOutPage"
        }, {
            "Caption": "Page and Children",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "revision16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "CheckOutPageAndChildren"
        }],
        "HasSubMenu": true,
        "Icon": "checkout16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "CheckOut"
    }, {
        "Caption": "Check In",
        "Children": [{
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "document16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "CheckInPage"
        }, {
            "Caption": "Page and Children",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "revision16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "CheckInPageAndChildren"
        }],
        "HasSubMenu": true,
        "Icon": "checkin16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "CheckIn"
    }, {
        "Caption": "Propagate publishes to latest version",
        "Children": [{
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "document16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "PropagateCheckInPage"
        }, {
            "Caption": "Page and Children",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "revision16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "PropagateCheckInPageAndChildren"
        }],
        "HasSubMenu": true,
        "Icon": "checkin16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "PropagateCheckIn"
    }, {
        "Caption": "Undo Check Out",
        "Children": [{
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "document16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "UndoCheckOutPage"
        }, {
            "Caption": "Page and Children",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "revision16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "UndoCheckOutPageAndChildren"
        }],
        "HasSubMenu": true,
        "Icon": "undocheckout16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "UndoCheckOut"
    }, {
        "Caption": "Rollback",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "revert16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Rollback"
    }, {
        "Caption": "",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "",
        "IsDisplayed": true,
        "IsSeparator": true,
        "Name": "separator5"
    }, {
        "Caption": "Mark\/Unmark For Publish",
        "Children": [{
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "document16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "MarkForPublishPage"
        }, {
            "Caption": "Page and Children",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "revision16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "MarkForPublishPageAndChildren"
        }],
        "HasSubMenu": true,
        "Icon": "markforpublish16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "MarkForPublish"
    }, {
        "Caption": "Preview",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "preview16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Preview"
    }, {
        "Caption": "Publish",
        "Children": [{
            "Caption": "Page",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "document16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "PublishPage"
        }, {
            "Caption": "Page and Children",
            "Children": [],
            "HasSubMenu": false,
            "Icon": "revision16.png",
            "IsDisplayed": true,
            "IsSeparator": false,
            "Name": "PublishPageAndChildren"
        }],
        "HasSubMenu": true,
        "Icon": "publish16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "Publish"
    }, {
        "Caption": "",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "",
        "IsDisplayed": true,
        "IsSeparator": true,
        "Name": "separator6"
    }, {
        "Caption": "Page Properties",
        "Children": [],
        "HasSubMenu": false,
        "Icon": "page16.png",
        "IsDisplayed": true,
        "IsSeparator": false,
        "Name": "PageProperties"
    }]
}

Reference

GlobalConfigurationsServices Class

IngeniuxCMService Namespace