Table of Contents

Class CPDocBaseClass

Namespace
Contensive.BaseClasses
Assembly
CPBase.dll

The document being constructed

public abstract class CPDocBaseClass
Inheritance
CPDocBaseClass
Inherited Members

Properties

Body

The html body of the document valid only during end-of-body addon event. Use this property to modify the body after rendering

public abstract string Body { get; set; }

Property Value

string

Content 

[Obsolete("Filter addons are deprecated", false)]
public abstract string Content { get; set; }

Property Value

string

HtmlAssetList

assets like scripts and styles included in this document

public abstract List<CPDocBaseClass.HtmlAssetClass> HtmlAssetList { get; }

Property Value

List<CPDocBaseClass.HtmlAssetClass>

IsAdminSite

True if the document is being created within the admin site

public abstract bool IsAdminSite { get; }

Property Value

bool

NavigationStructure 

[Obsolete("Use addon navigation.", false)]
public abstract string NavigationStructure { get; }

Property Value

string

NoFollow

sets the html head nofollow meta tag signaling spidering bots not to follow links on this document

public abstract bool NoFollow { get; set; }

Property Value

bool

PageId

The page id for this document

public abstract int PageId { get; }

Property Value

int

PageName

The name of the page referenced by .PageId

public abstract string PageName { get; }

Property Value

string

Properties

A list of all doc properties available. Return the values with getInteger(), etc.

public abstract List<string> Properties { get; }

Property Value

List<string>

RefreshQueryString

Use this querystring to create a link that if clicked by a user will return the user to the current page + addon

public abstract string RefreshQueryString { get; }

Property Value

string

SectionId 

[Obsolete("Section is no longer supported", false)]
public abstract int SectionId { get; }

Property Value

int

SiteStylesheet 

[Obsolete("Site styles are no longer supported. Include styles and javascript in addons.", false)]
public abstract string SiteStylesheet { get; }

Property Value

string

StartTime

The datetime when this document was started

public abstract DateTime StartTime { get; }

Property Value

DateTime

TemplateId

The id of the template referenced by this document

public abstract int TemplateId { get; }

Property Value

int

Type

Get the html DOCTYPE declaration for this document

public abstract string Type { get; }

Property Value

string

Methods

AddBodyEnd(string)

Add html to the end-of-body

public abstract void AddBodyEnd(string html)

Parameters

html string

AddBodyJavascript(string)

Add javascript (not a link to javascript) to the assets for the end-of-body of this document. Do NOT include script tags.

public abstract void AddBodyJavascript(string code)

Parameters

code string

AddBodyJavascriptLink(string)

Add a link to a javascript file to the assets for the end-of-body of this document.

public abstract void AddBodyJavascriptLink(string codeLink)

Parameters

codeLink string

AddHeadJavascript(string)

Add javascript (not a link to javascript) to the assets for the Head of this document. Do NOT include script tags.

public abstract void AddHeadJavascript(string code)

Parameters

code string

AddHeadJavascriptLink(string)

Add a link to a javascript file to the assets for the Head of this document.

public abstract void AddHeadJavascriptLink(string codeLink)

Parameters

codeLink string

AddHeadStyle(string)

Add a stylesheet (not a link to a stylesheet) to the assets for this document. Do NOT include style tags

public abstract void AddHeadStyle(string styleSheet)

Parameters

styleSheet string

AddHeadStyleLink(string)

Add a link to a stylesheet to the assets for this document.

public abstract void AddHeadStyleLink(string styleSheetLink)

Parameters

styleSheetLink string

AddHeadTag(string)

Add a tag to the head of this document

public abstract void AddHeadTag(string htmlTag)

Parameters

htmlTag string

AddMetaDescription(string)

Add to the head's meta description tag

public abstract void AddMetaDescription(string metaDescription)

Parameters

metaDescription string

AddMetaKeywordList(string)

Add to the head's meta keyword tag

public abstract void AddMetaKeywordList(string metaKeywordList)

Parameters

metaKeywordList string

AddOnLoadJavascript(string)

Add javascript code to be run on load.

public abstract void AddOnLoadJavascript(string code)

Parameters

code string

AddRefreshQueryString(string, bool)

Add a key=value to the current refresh query string. Set .RefreshQueryString property for details.

public abstract void AddRefreshQueryString(string key, bool value)

Parameters

key string
value bool

AddRefreshQueryString(string, DateTime)

Add a key=value to the current refresh query string. Set .RefreshQueryString property for details.

public abstract void AddRefreshQueryString(string key, DateTime value)

Parameters

key string
value DateTime

AddRefreshQueryString(string, double)

Add a key=value to the current refresh query string. Set .RefreshQueryString property for details.

public abstract void AddRefreshQueryString(string key, double value)

Parameters

key string
value double

AddRefreshQueryString(string, int)

Add a key=value to the current refresh query string. Set .RefreshQueryString property for details.

public abstract void AddRefreshQueryString(string key, int value)

Parameters

key string
value int

AddRefreshQueryString(string, string)

Add a key=value to the current refresh query string. Set .RefreshQueryString property for details.

public abstract void AddRefreshQueryString(string key, string value)

Parameters

key string
value string

AddTitle(string)

Add to the document's title

public abstract void AddTitle(string pageTitle)

Parameters

pageTitle string

GetBoolean(string)

Get document property previously set during this document rendering.

public abstract bool GetBoolean(string key)

Parameters

key string

Returns

bool

GetBoolean(string, bool)

Get document property previously set during this document rendering.

public abstract bool GetBoolean(string key, bool defaultValue)

Parameters

key string
defaultValue bool

Returns

bool

GetBoolean(string, string) 

[Obsolete("Use GetBoolean(string,bool)", false)]
public abstract bool GetBoolean(string key, string defaultValue)

Parameters

key string
defaultValue string

Returns

bool

GetDate(string)

Get document property previously set during this document rendering.

public abstract DateTime GetDate(string key)

Parameters

key string

Returns

DateTime

GetDate(string, DateTime)

Get document property previously set during this document rendering.

public abstract DateTime GetDate(string key, DateTime defaultValue)

Parameters

key string
defaultValue DateTime

Returns

DateTime

GetDate(string, string) 

[Obsolete("Use GetDate(string,DateTime)", false)]
public abstract DateTime GetDate(string key, string defaultValue)

Parameters

key string
defaultValue string

Returns

DateTime

GetInteger(string)

Get document property previously set during this document rendering.

public abstract int GetInteger(string key)

Parameters

key string

Returns

int

GetInteger(string, int)

Get document property previously set during this document rendering.

public abstract int GetInteger(string key, int defaultValue)

Parameters

key string
defaultValue int

Returns

int

GetInteger(string, string) 

[Obsolete("Use GetInteger(string,int)", false)]
public abstract int GetInteger(string key, string defaultValue)

Parameters

key string
defaultValue string

Returns

int

GetNumber(string)

Get document property previously set during this document rendering.

public abstract double GetNumber(string key)

Parameters

key string

Returns

double

GetNumber(string, double)

Get document property previously set during this document rendering.

public abstract double GetNumber(string key, double defaultValue)

Parameters

key string
defaultValue double

Returns

double

GetNumber(string, string) 

[Obsolete("Use GetNumber(string,double)", false)]
public abstract double GetNumber(string key, string defaultValue)

Parameters

key string
defaultValue string

Returns

double

GetProperty(string)

Get document property previously set during this document rendering. Get document property previously set during this document rendering

public abstract string GetProperty(string key)

Parameters

key string

Returns

string

GetProperty(string, string)

Get document property previously set during this document rendering. GetProperty is the same as GetText

public abstract string GetProperty(string key, string defaultValue)

Parameters

key string
defaultValue string

Returns

string

GetText(string)

Get document property previously set during this document rendering.

public abstract string GetText(string key)

Parameters

key string

Returns

string

GetText(string, string)

Get document property previously set during this document rendering.

public abstract string GetText(string key, string defaultValue)

Parameters

key string
defaultValue string

Returns

string

IsProperty(string)

Determine if a key has already been set in this document.

public abstract bool IsProperty(string key)

Parameters

key string

Returns

bool

SetProperty(string, bool)

Set document property, valid only during this document rendering

public abstract void SetProperty(string key, bool value)

Parameters

key string
value bool

SetProperty(string, DateTime)

Set document property, valid only during this document rendering

public abstract void SetProperty(string key, DateTime value)

Parameters

key string
value DateTime

SetProperty(string, double)

Set document property, valid only during this document rendering

public abstract void SetProperty(string key, double value)

Parameters

key string
value double

SetProperty(string, int)

Set document property, valid only during this document rendering

public abstract void SetProperty(string key, int value)

Parameters

key string
value int

SetProperty(string, string)

Set document property, valid only during this document rendering

public abstract void SetProperty(string key, string value)

Parameters

key string
value string

get_GlobalVar(string) 

[Obsolete("Use GetText().", false)]
public abstract string get_GlobalVar(string Index)

Parameters

Index string

Returns

string

get_IsGlobalVar(string) 

[Obsolete("Use IsProperty().", false)]
public abstract bool get_IsGlobalVar(string Index)

Parameters

Index string

Returns

bool

get_IsVar(string) 

[Obsolete("Use IsProperty().", false)]
public abstract bool get_IsVar(string Index)

Parameters

Index string

Returns

bool

get_Var(string) 

[Obsolete("Use GetText().", false)]
public abstract string get_Var(string Index)

Parameters

Index string

Returns

string

set_GlobalVar(string, string) 

[Obsolete("Use SetProperty().", false)]
public abstract void set_GlobalVar(string Index, string Value)

Parameters

Index string
Value string

set_Var(string, string) 

[Obsolete("Use SetProperty().", false)]
public abstract void set_Var(string Index, string Value)

Parameters

Index string
Value string
Edit this page