Class CPUtilsBaseClass.addonExecuteContext

Namespace

Contensive.BaseClasses

Assembly

CPBase.dll

When an addon is execute, this object describes the environment in which the addon will be used.

public class CPUtilsBaseClass.addonExecuteContext

Inheritance

object

CPUtilsBaseClass.addonExecuteContext

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

addonType

select enumeration option the describes the environment in which the addon is being executed (in an email, on a page, as a remote method, etc)

public CPUtilsBaseClass.addonContext addonType { get; set; }

Property Value

CPUtilsBaseClass.addonContext

argumentKeyValuePairs

Optional. Name value pairs added to the document environment during execution so they be read by addon programming during and after execution with cp.doc.getText(), etc.

public Dictionary<string, string> argumentKeyValuePairs { get; set; }

Property Value

Dictionary<string, string>

backgroundProcess

When true, the environment is run from the task subsystem, without a UI. Assemblies from base collection run from program files. Addon return is ignored.

public bool backgroundProcess { get; set; }

Property Value

bool

cssContainerClass

Optional. If included, the addon will be wrapped with a div and this will be the html class value of the div. May be used to customize the resulting html styles.

public string cssContainerClass { get; set; }

Property Value

string

cssContainerId

Optional. If included, the addon will be wrapped with a div and this will be the html Id value of the div. May be used to customize the resulting html styles.

public string cssContainerId { get; set; }

Property Value

string

dependencyRecursionTestStack

public Stack<int> dependencyRecursionTestStack { get; set; }

Property Value

Stack<int>

errorContextMessage

This caption is used if the addon cannot be executed.

public string errorContextMessage { get; set; }

Property Value

string

forceHtmlDocument

Optional. If set true, the addon being called will be delivered as ah html document, with head, body and html tags. This forces the addon's htmlDocument setting.

public bool forceHtmlDocument { get; set; }

Property Value

bool

forceJavascriptToHead

When true, an addon's javascript will be put in the head. This also forces javascript for all dependant addons to the head.

public bool forceJavascriptToHead { get; set; }

Property Value

bool

hostRecord

Optional. If this addon is run automatically because it was included in content, this is the contentName, recordId and fieldName of the record that held that content.

public CPUtilsBaseClass.addonExecuteHostRecordContext hostRecord { get; set; }

Property Value

CPUtilsBaseClass.addonExecuteHostRecordContext

instanceGuid

Optional. If the addon is run from a page, it includes an instanceGuid which can be used by addon programming to locate date for this instance.

public string instanceGuid { get; set; }

Property Value

string

isDependency

Optional. If true, this addon is called because it was a dependancy, and can only be called once within a document.

public bool isDependency { get; set; }

Property Value

bool

personalizationAuthenticated

Deprecated. execute against the current session context

public bool personalizationAuthenticated { get; set; }

Property Value

bool

personalizationPeopleId

Deprecated. execute against the current session context

public int personalizationPeopleId { get; set; }

Property Value

int

wrapperID

deprecated

[Obsolete("Deprecated", false)]
public int wrapperID { get; set; }

Property Value

int