| |
Name |
Description |
|
Admin
|
When true, this add-on is displayed on and can be used from the admin navigator. |
|
|
ArgumentList
|
A crlf delimited list of name=value pairs. These pairs create an options dialog available to administrators in advance edit mode. When the addon is executed, the values selected are available through the cp.doc.var("name") method. |
|
|
AsAjax
|
When true, this addon returns the javascript code necessary to implement this object as ajax. |
|
|
BlockDefaultStyles
|
When true, the system only uses the custom styles field when building the page. This field is not updated with add-on updates. |
|
|
ccGuid
|
The guid used to uniquely identify the add-on |
|
|
CollectionID
|
The ID local to this site of the collection which installed this addon. |
|
|
Content
|
When true, this addon can be placed in the content of pages. |
|
|
Copy
|
text copy is added to the addon content during execution. |
|
|
CopyText
|
text copy is added to the addon content during execution. |
|
|
CustomStyles
|
Styles that are rendered on the page when the addon is executed. Custom styles are editable and are not modified when the add-on is updated. |
|
|
DefaultStyles
|
Styles that are included with the add-on and are updated when the add-on is updated. See BlockdefaultStyles to block these. |
|
|
Description
|
The add-on description is displayed in the addon manager |
|
|
DotNetClass
|
When present, the system calls the execute method of an objected created from this dot net class namespace. |
|
|
FormXML
|
This is an xml stucture that the system executes to create an admin form. See the support.contensive.com site for more details. |
|
|
Help
|
This copy is displayed when the help icon for this addon is clicked. |
|
|
HelpLink
|
If present, this link is displayed when the addon icon is clicked. |
|
|
IconFilename
|
When present, this icon will be used when the add-on is displayed in the addon manager and when edited. The height, width and sprites must also be set. |
|
|
IconHeight
|
The height in pixels of the icon referenced by the iconfilename. |
|
|
IconSprites
|
The number of images in the icon. There can be multiple images stacked top-to-bottom in the file. The first is the normal image. the second is the hover-over image. The third is the clicked image. |
|
|
IconWidth
|
The width of the icon referenced by the iconfilename |
|
|
ID
|
The local ID of this addon on this site. |
|
|
InFrame
|
When true, this addon will be displayed in an html iframe. |
|
|
IsInline
|
When true, the system will assume the addon returns html that is inline, as opposed to block. This is used to vary the edit icon behaviour. |
|
|
JavaScriptBodyEnd
|
Javascript code that will be placed in the document right before the end-body tag. Do not include script tags. |
|
|
JavascriptInHead
|
Javascript code that will be placed in the head of the document. Do no include script tags. |
|
|
JavaScriptOnLoad
|
Javascript that will be executed in the documents onload event. |
|
|
Link
|
A URL to a webserver that returns javascript. This URL will be added as the src attribute of a script tag, and placed in the content where this Add-on is inserted. This URL can be to any server-side program on any server, provided it returns javascript. For instance, if you have a script page that returns javascript,put the URL of that page here. The addon can be dropped on any page and will execute the script. Your script can be from any site. This technique is used in widgets and avoids the security issues with ajaxing from another site. |
|
|
MetaDescription
|
Text here will be added to the meta description section of the document head. |
|
|
MetaKeywordList
|
This is a comma or crlf delimited list of phrases that will be added to the document's meta keyword list |
|
|
Name
|
The name of the addon. |
|
|
NavIconType
|
The type of navigator entry to be made. Choices are: Add-on,Report,Setting,Tool |
|
|
ObjectProgramID
|
If present, this string will be used as an activex programid to create an object and call it's execute method. |
|
|
OnBodyEnd
|
If true, this addon will be execute at the end of every page and its content added to right before the end-body tag |
|
|
OnBodyStart
|
If true, this addon will be execute at the start of every page and it's content added to right after the body tag |
|
|
OnContentEnd
|
if true, this add-on will be executed on every page and its content added right after the content box. |
|
|
OnContentStart
|
If true, this add-on will be executed on every page and its content added right before the content box |
|
|
OtherHeadTags
|
All content in the field will be added directly, as-is to the document head. |
|
|
PageTitle
|
All content in the field will be added to the documents title tag |
|
|
ProcessInterval
|
When present, this add-on will be executed stand-alone without a webpage periodically at this interval (in minutes). |
|
|
ProcessNextRun
|
The next time this add-on is scheduled to run as a processs |
|
|
ProcessRunOnce
|
Check true, this addon will be run once within the next minute as a stand-alone process. |
|
|
RemoteAssetLink
|
|
|
|
RemoteMethod
|
if true, this add-on can be executed as a remote method. The name of the addon is used as the url. |
|
|
RobotsTxt
|
When present, this text will be added to the robots.txt content for the site. This content is editable through the preferences page |
|
|
ScriptCode
|
When present, the first routine of this script will be executed when the add-on is executed and its return added to the add-ons return |
|
|
ScriptEntryPoint
|
if the ScriptCode has more than one routine and you want to run one other than the first, list is here. |
|
|
ScriptLanguage
|
The script language selected for this script. |
|
|
SharedStyles
|
A comma delimited list of the local id values of shared style record that will display with this add-on |
|
|
Template
|
|
Public Properties