This is the login panel

 

Home|Account

Return to Product Support > Learning Center > Developer References > Creating Add-ons > Add-on Collections > Collection Installation File

Collection File Addon Node

A page interface defines an addon that will display content on a page

<Addon name="" guid="" type="Addon|Report|Setting|Tool">
<ActiveXProgramID/>
<AssemblyFullName/>
<Admin />
<ArgumentList/>
<AsAjax/>
<Content />
<Copy />
<CopyText />
<Description />
<DotNetClass />
<Filter />
<FormXML />
<Help />
<HelpLink />
<Icon Link="" Width="" Height="" Sprites="" />
<InIframe />
<IncludeAddon />
<IsInline />
<JavascriptOnLoad />
<JavascriptInHead />
<JavascriptBodyEnd />
<MetaDescription />
<Otherheadtags />
<OnPageEndEvent />
<OnPageStartEvent />
<OnBodyStart />
<OnBodyEnd />
<OnNewVisitEvent />
<PageTitle />
<RemoteMethod />
<RemoteAssetLink />
<RobotsTxt />
<StyleSheet />
<Template />
<UseFilter />
<Scripting Language="" EntryPoint="">
<IncludeModule>name or guid of scripting module</IncludeModule>
<Code>scripting code</Code>
</Scripting>
<ProcessInterval />
<ProcessRunOnce />
<ProcessTriggers>
<ContentChange>Name or guid of content definition</ContentChange>
</ProcessTriggers>
<Editors>
<Type>name of field type</Type>
</Editors>
</Page>

Name is used to identify the addon in displayed lists. If the GUID is not present, name is used to locate an addon for upgrades.

guid is string used to uniquely identify the addon. To create a new guid, use the Create GUID tool from Advanced Tool menu in the navigator any Contensive site

type sets the navigator icon, and creates a navigator node in the appropriate branch. Values can be "setting", "tool", or "report".

 

Node Description
ArgumentList A single name=value argument pair, or multiple arguments delimited by a new line. See the KB article on Option encoding for more details on building value arguments that include checkboxes, drop down list, etc.
ActiveXProgramID The program ID of an Add-on to be to instanciated and executed when this Add-on is executed.
Description A description of the Add-on for Add-on Lists only.
Help Detailed descriptive help copy to be displayed when the help feature is used on an installed Add-on
HelpLink A link to for more help.
IconLink A link to an icon for the addon
IncludeAddon Check the add-ons you want to run BEFORE running this add-on. For instance, check the 'jquery' addon if you want to guarantee the jquery add-on is included on this page. You might also create an empty add-on, that just includes several others, then assign a wrapper to the add-on. This will create a border that includes multiple add-ons.
Template When true, this add-on can be added to a template.
Content When true, this add-on can be added to web site content.
Admin When true, this add-on can be executed from the admin site off the navigator
Filter When true, this add-on can act as a filter. Filters modify the output of other objects, like Add-ons
RemoteMethod When true, this add-on will respond to RemoteMethod calls.
onPageEndEvent When true, the add-on will be executed at the end of every page's content box.
onPageStartEvent When true, this add-on will be executed at the start of every page's content box.
onBodyStart
When true, this add-on will be executed immediately following the <body> tag.
onBodyEndWhen true, this add-on will be executed immediately before the </body> tag
onNewVisitEvent When true, this add-on will be executed at the start of the first page hit of a new visit
JavascriptOnLoad This is a javascript code line that will be added to the Body onLoad event
JavascriptBodyEnd This is a block of javascript that will be wrapped in a <script> tag, and added immediately before the </body>
PageTitle This text will be added to the page title with a comma
MetaDescription This text will be added to the page's Meta Description tag
OtherHeadTags This is a block of HTML that will be added to the head. note: this is HTML, not text, and must include the necessary HTML tags (like <meta ...>"
RobotsTxt This is a line of text that will be added the Robot.txt file when it is requested.
Stylesheet These styles will be added to the site when this add-on is executed.
Copy This is a block of HTML that will be added to the page where the add-on is dropped.
CopyText This is a block of text that will be added to the page where the add-on is dropped. It may be text, HTML, javascript, etc
UseFilter Includes the name or guid of an Add-on to be used as a filter for every instance of this Add-on.
ProcessInterval
When this value is non-zero, the value represents a time in milliseconds. This add-on will be executed as a background process, waiting this interval between executions
ProcessRunOnce
When true, the add-on will be executed one time as a background process, clearing this setting
ProcessTriggers
A list of content definitions. When a record is change in the respective table, this addon will be run as process. The option string will be loaded with:
action=contentchange
contentid=value
recordid=value
Editors

When present, this add-on will be executed to create the form input element (editor) for the admin site for all fields of the type selected.

Field types can be any of the following:

  • boolean
  • text
  • date
  • longtext
  • textfile
  • javascript file
  • css file
  • xml file
  • lookup
  • redirect
  • link
  • resource link
  • integer
  • many to many
  • file
  • currency
  • image
  • float
  • auto increment

This page was last reviewed Tuesday, December 07, 2010

Support

Home

Search

FAQ



space
Login
space