SiteSettings.getEditorLocation (Method)

Returns structure containing the server relative path and physical directory to editor.js file downloaded from ckeditor.

Returns:

SiteSettings_GetEditorLocation_Result (struct)

Each row of the returned query results has the following fields:

Field Name Type Description
editorPath PlainText_255 Server relative path to the editor.js downloaded from ckeditor.
inheritFromServer Boolean Boolean flag when true means that the value is inherited from server-settings.
isLocal Boolean Boolean flag when true means the editor is downloaded locally on the server instead of using ckEditor's cdn location.
resourceID ResourceID_0 ID of ckeditor resource associated for this site.

Arguments:

Name Type Required Description
resolvePath Boolean Optional. Defaults to '0'. Boolean flag when true, we return the value configured at server level if the the value is inherited from server or if the path is coming from a registered resource.
siteResourceID Integer Optional. Defaults to '-1'. Resource ID for site-specific RTE location, or zero to use server configuration, or -1 to get the value from Request.Site.GeneralSettings.

Context:

License Requirements None
Permission Requirements (none)
Deny Context None
Require Context None
Author Lock (not required)
Transaction Logging Transaction logging is disabled for this method
Customization Customization is not supported for this method.

Error Codes:

None

Notes:

None