SchemaDesignerServicesGetSchemaFieldCandidates Method |
Gets all Field types as candidates for Schema construction. The collection is grouped by purpose or application of the Field type.
Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 10.5.94
Syntaxpublic XHRServiceResponseGeneric<SchemaFieldsGroupedListing> GetSchemaFieldCandidates()
Return Value
Type: XHRServiceResponseGenericSchemaFieldsGroupedListing2 level collection of all Schema Field types
Examples
Sample JSON return
JavaScript
{
"code": 0,
"error": null,
"message": {
"Groups": [{
"FieldTypes": [{
"ElementTypeName": "string",
"HasExports": false,
"ID": "1",
"IconName": "new16",
"IsXpower": false,
"Label": "Attribute",
"Name": "Attribute",
"Properties": []
}],
"GroupLabel": "Attribute",
"GroupName": "Attributes"
}, {
"FieldTypes": [{
"ElementTypeName": "string",
"HasExports": false,
"ID": "2",
"IconName": "document16",
"IsXpower": false,
"Label": "Plain Text",
"Name": "Text Element",
"Properties": []
}, {
"ElementTypeName": "dhtml",
"HasExports": false,
"ID": "3",
"IconName": "edit16",
"IsXpower": false,
"Label": "XHTML Editor",
"Name": "XHTML Element",
"Properties": [{
"ChoicesValue": "",
"Label": "Height",
"Name": "Height",
"Type": "integer"
}]
}],
"GroupLabel": "Text",
"GroupName": "Text"
}, {
"FieldTypes": [{
"ElementTypeName": "imagefile",
"HasExports": false,
"ID": "12",
"IconName": "image16",
"IsXpower": false,
"Label": "Image",
"Name": "Image File",
"Properties": [{
"ChoicesValue": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Width",
"Name": "Width",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Height",
"Name": "Height",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Border",
"Name": "Border",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "",
"Name": "HSpace",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "",
"Name": "VSpace",
"Type": "integer"
}, {
"ChoicesValue": ";left;right;top;bottom;middle;baseline;texttop;absbottom;absmiddle",
"Label": "Alignment",
"Name": "Alignment",
"Type": "enumeration"
}]
}, {
"ElementTypeName": "mediafile",
"HasExports": false,
"ID": "13",
"IconName": "media16",
"IsXpower": false,
"Label": "Media",
"Name": "Media File",
"Properties": [{
"ChoicesValue": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean"
}]
}, {
"ElementTypeName": "document",
"HasExports": false,
"ID": "14",
"IconName": "document16",
"IsXpower": false,
"Label": "Document",
"Name": "Document",
"Properties": []
}],
"GroupLabel": "Assets",
"GroupName": "Assets"
}, {
"FieldTypes": [{
"ElementTypeName": "Link",
"HasExports": true,
"ID": "6",
"IconName": "link16",
"IsXpower": true,
"Label": "Link",
"Name": "Link",
"Properties": [{
"ChoicesValue": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean"
}, {
"ChoicesValue": ";external;document",
"Label": "Link",
"Name": "Link",
"Type": "enumeration"
}, {
"ChoicesValue": "",
"Label": "Link Text",
"Name": "LinkText",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "",
"Name": "URL",
"Type": ""
}, {
"ChoicesValue": ";_blank;_self;_parent",
"Label": "Target",
"Name": "Target",
"Type": "enumeration"
}]
}, {
"ElementTypeName": "LinkSet",
"HasExports": true,
"ID": "26",
"IconName": "linkset16",
"IsXpower": true,
"Label": "LinkSet",
"Name": "LinkSet",
"Properties": [{
"ChoicesValue": "",
"Label": "Page Types",
"Name": "QuerySchemas",
"Type": "schemas"
}, {
"ChoicesValue": "",
"Label": "Start Pages",
"Name": "QueryLocationRoots",
"Type": "pages"
}, {
"ChoicesValue": "",
"Label": "Title",
"Name": "Title",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "",
"Name": "Values",
"Type": "choices_pipe"
}]
}],
"GroupLabel": "Links",
"GroupName": "Links"
}, {
"FieldTypes": [{
"ElementTypeName": "Component",
"HasExports": false,
"ID": "4",
"IconName": "component16",
"IsXpower": true,
"Label": "Component",
"Name": "Component",
"Properties": [{
"ChoicesValue": "",
"Label": "Component",
"Name": "Component",
"Type": "page"
}, {
"ChoicesValue": "",
"Label": "Component Types",
"Name": "CompTypes",
"Type": "schemas"
}, {
"ChoicesValue": "",
"Label": "Wrapped in Expanded Xml",
"Name": "WrappedUp",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Allow changing xml wrapping",
"Name": "AllowWrappingChange",
"Type": "boolean"
}]
}, {
"ElementTypeName": "Insert",
"HasExports": false,
"ID": "7",
"IconName": "insert16",
"IsXpower": true,
"Label": "Insert",
"Name": "Insert",
"Properties": [{
"ChoicesValue": "",
"Label": "Insert URL",
"Name": "Insert",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "Well-Formed",
"Name": "WellFormed",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Extract HTML Body",
"Name": "ExtractHTMLBody",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Timeout (seconds)",
"Name": "Timeout",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Cache Duration (seconds)",
"Name": "CacheDuration",
"Type": "integer"
}]
}, {
"ElementTypeName": "ComExecute",
"HasExports": false,
"ID": "17",
"IconName": "comcomponent16",
"IsXpower": true,
"Label": "ComExecute",
"Name": "ComExecute",
"Properties": [{
"ChoicesValue": "",
"Label": "Template Schema",
"Name": "schema",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "Override Edit Form (Optional)",
"Name": "EditForm",
"Type": ""
}]
}, {
"ElementTypeName": "password",
"HasExports": false,
"ID": "25",
"IconName": "comcomponent16",
"IsXpower": true,
"Label": "Password",
"Name": "password",
"Properties": []
}],
"GroupLabel": "Functional",
"GroupName": "Functional"
}, {
"FieldTypes": [{
"ElementTypeName": "GroupStart",
"HasExports": false,
"ID": "15",
"IconName": "group16",
"IsXpower": true,
"Label": "Group Start",
"Name": "GroupStart",
"Properties": [{
"ChoicesValue": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Grouped in Expanded Xml",
"Name": "Enclosed",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Allow changing Xml Grouping",
"Name": "AllowEnclosureChange",
"Type": "boolean"
}]
}, {
"ElementTypeName": "",
"HasExports": false,
"ID": "16",
"IconName": "group16",
"IsXpower": true,
"Label": "Group End",
"Name": "GroupEnd",
"Properties": []
}, {
"ElementTypeName": "List",
"HasExports": false,
"ID": "5",
"IconName": "group16",
"IsXpower": true,
"Label": "List",
"Name": "List",
"Properties": [{
"ChoicesValue": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Grouped in Expanded Xml",
"Name": "Enclosed",
"Type": "boolean"
}, {
"ChoicesValue": "",
"Label": "Allow changing Xml Grouping",
"Name": "AllowEnclosureChange",
"Type": "boolean"
}]
}],
"GroupLabel": "Organizational",
"GroupName": "Organizational"
}, {
"FieldTypes": [{
"ElementTypeName": "Navigation",
"HasExports": true,
"ID": "8",
"IconName": "navigation16",
"IsXpower": true,
"Label": "Navigation",
"Name": "Navigation",
"Properties": [{
"ChoicesValue": "",
"Label": "Expanded by Default",
"Name": "Expanded",
"Type": "boolean"
}, {
"ChoicesValue": "Children;Ancestors;Sibling;Sequential;SubTree",
"Label": "Navigation Type",
"Name": "Navigation",
"Type": "enumeration"
}, {
"ChoicesValue": "up;down",
"Label": "Generation Order",
"Name": "GenerationOrder",
"Type": "enumeration"
}, {
"ChoicesValue": "",
"Label": "Start Page",
"Name": "StartPage",
"Type": "page"
}, {
"ChoicesValue": "",
"Label": "Maximum Nodes",
"Name": "MaxNodes",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "Maximum Depth",
"Name": "MaxDepth",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "Query",
"Name": "Query",
"Type": ""
}]
}, {
"ElementTypeName": "TaxonomyNavigation",
"HasExports": true,
"ID": "23",
"IconName": "navigation16",
"IsXpower": true,
"Label": "Taxonomy Navigation",
"Name": "TaxonomyNavigation",
"Properties": [{
"ChoicesValue": "",
"Label": "Start Categories",
"Name": "StartNodes",
"Type": "categories"
}, {
"ChoicesValue": "",
"Label": "Include Pages",
"Name": "IncludePages",
"Type": "boolean"
}, {
"ChoicesValue": "-1;0;1;2;3;4;5;6;7;8;9;10;11;12;13;14;15;16;17;18;19;20",
"Label": "Depth",
"Name": "Depth",
"Type": "enumeration"
}, {
"ChoicesValue": "",
"Label": "Page Types",
"Name": "FilterSchemas",
"Type": "schemas"
}, {
"ChoicesValue": "",
"Label": "Start Pages",
"Name": "FilterParentPages",
"Type": "pages"
}]
}, {
"ElementTypeName": "References",
"HasExports": true,
"ID": "24",
"IconName": "references16",
"IsXpower": true,
"Label": "References Navigation",
"Name": "References",
"Properties": [{
"ChoicesValue": "0;1;2;3;4;5;6;7;8;9;10;",
"Label": "Depth",
"Name": "Depth",
"Type": "enumeration"
}, {
"ChoicesValue": "",
"Label": "Page Types",
"Name": "QuerySchemas",
"Type": "schemas"
}, {
"ChoicesValue": "",
"Label": "Start Pages",
"Name": "QueryLocationRoots",
"Type": "pages"
}, {
"ChoicesValue": "",
"Label": "Cross References",
"Name": "IncludeCrossReferences",
"Type": "boolean"
}]
}],
"GroupLabel": "Navigation",
"GroupName": "Navigation"
}, {
"FieldTypes": [{
"ElementTypeName": "date",
"HasExports": false,
"ID": "10",
"IconName": "datetime16",
"IsXpower": false,
"Label": "Date",
"Name": "Date",
"Properties": [{
"ChoicesValue": "localdateshort;localdateshorttime;localdatelong;localdatelongtime",
"Label": "Field Type",
"Name": "display",
"Type": "enumeration"
}]
}, {
"ElementTypeName": "localdate",
"HasExports": false,
"ID": "27",
"IconName": "datetime16",
"IsXpower": false,
"Label": "Local Date",
"Name": "Local Date",
"Properties": []
}, {
"ElementTypeName": "localtime",
"HasExports": false,
"ID": "28",
"IconName": "datetime16",
"IsXpower": false,
"Label": "Local Time",
"Name": "Local Time",
"Properties": [{
"ChoicesValue": "",
"Label": "Timezone Name",
"Name": "TimezoneName",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "Timezone Offset",
"Name": "TimezoneOffset",
"Type": ""
}]
}],
"GroupLabel": "Date \/ Time",
"GroupName": "DateTime"
}, {
"FieldTypes": [{
"ElementTypeName": "boolean",
"HasExports": false,
"ID": "9",
"IconName": "check16",
"IsXpower": false,
"Label": "Checkbox",
"Name": "Checkbox",
"Properties": []
}, {
"ElementTypeName": "enumeration",
"HasExports": false,
"ID": "11",
"IconName": "dropdown16",
"IsXpower": false,
"Label": "Dropdown List",
"Name": "Dropdown List",
"Properties": [{
"ChoicesValue": "",
"Label": "Choices",
"Name": "values",
"Type": "choices_space"
}]
}, {
"ElementTypeName": "multiselect",
"HasExports": false,
"ID": "19",
"IconName": "dropdown16",
"IsXpower": false,
"Label": "Multi-Select: Hard-coded choices",
"Name": "Multi-Select: Hard-coded choices",
"Properties": [{
"ChoicesValue": "",
"Label": "Maximum Choices",
"Name": "MaxChoices",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Page Size",
"Name": "PageSize",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "",
"Name": "Values",
"Type": "choices_pipe"
}]
}, {
"ElementTypeName": "multiselect",
"HasExports": false,
"ID": "20",
"IconName": "dropdown16",
"IsXpower": false,
"Label": "Multi-Select: Choices from Database Query",
"Name": "Multi-Select: Choices from Database Query",
"Properties": [{
"ChoicesValue": "",
"Label": "Maximum Choices",
"Name": "MaxChoices",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Page Size",
"Name": "PageSize",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "DSN",
"Name": "DSN",
"Type": ""
}, {
"ChoicesValue": "",
"Label": "SQL",
"Name": "SQL",
"Type": ""
}]
}, {
"ElementTypeName": "multiselect",
"HasExports": false,
"ID": "21",
"IconName": "dropdown16",
"IsXpower": false,
"Label": "Multi-Select: Choices from CMS node-set",
"Name": "Multi-Select: Choices from CMS node-set",
"Properties": [{
"ChoicesValue": "",
"Label": "Maximum Choices",
"Name": "MaxChoices",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Page Size",
"Name": "PageSize",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Page Types",
"Name": "Query_PageType",
"Type": "schema"
}, {
"ChoicesValue": "",
"Label": "Start Page",
"Name": "Query_LocationRoot",
"Type": "page"
}, {
"ChoicesValue": "",
"Label": "Fields to Include",
"Name": "Query_SelectedFields",
"Type": "choices_pipe"
}, {
"ChoicesValue": "",
"Label": "",
"Name": "AdditionalFilter_XPathQuery",
"Type": ""
}]
}, {
"ElementTypeName": "multiselect",
"HasExports": false,
"ID": "22",
"IconName": "dropdown16",
"IsXpower": false,
"Label": "Multi-Select: Choices from external scripting",
"Name": "Multi-Select: Choices from external scripting",
"Properties": [{
"ChoicesValue": "",
"Label": "Maximum Choices",
"Name": "MaxChoices",
"Type": "integer"
}, {
"ChoicesValue": "",
"Label": "Page Size",
"Name": "PageSize",
"Type": "integer"
}]
}],
"GroupLabel": "Selection",
"GroupName": "Selection"
}]
}
}RemarksThe Field types will only be changed when upgrade Ingeniux CMS product and site, therefore, normally this operation only needs to be called once.
See Also