EPTBase Class

Content Studio 5.7 SDK

Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

This abstract base class provides EPT functionality for Content Studio components.

Inheritance Hierarchy

Namespace: ContentStudio.Site.ActiveScripting
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)

Syntax

Copy

public abstract class EPTBase : PageableComponent

Public MustInherit Class EPTBase
	Inherits PageableComponent

The EPTBase type exposes the following members.

Constructors

	Name	Description
	EPTBase	Constructs a new instance of the EPTBase class.
	EPTBase(SiteBase)	Constructs a new instance of the EPTBase class.
	EPTBase(UserControlBase)	Constructs a new instance of the EPTBase class.
	EPTBase(SiteBase, UserControlBase)	Constructs a new instance of the EPTBase class.

Top

Properties

	Name	Description
	BackwardsComponentCompatibilityMode	Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false. (Inherited from ActiveScriptingBase.)
	ComponentName	Gets the name of the component (Inherited from ActiveScriptingBase.)
	Conformance	Gets a value which specifies which type of code a component can generate. (Inherited from ActiveScriptingBase.)
	CS_DataFields	Gets a EPTXmlParser that contains a collection of EPT field definitions and values. This property is the replacement for the obsolete EPT_GetFieldName(String) and EPT_GetFieldValue(String) methods. (Inherited from CodeBase.)
	ElementType	Gets a value which specifies the type of outer element the component generates. (Inherited from ActiveScriptingBase.)
	Encoding	Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark. (Inherited from ActiveScriptingBase.)
	Page	A reference to the current context page. This will initialize in the constructor of this class. (Inherited from CodeBase.)
	RunningUserControl	Gets the current running user control. (Inherited from CodeBase.)

Top

Methods

	Name	Description
	BuildHTMLComponentException	Returns an component exception in HTML format. (Inherited from ActiveScriptingBase.)
	CreatePageRange	Create a page range in HTML or XHTML (Inherited from PageableComponent.)
	CSF_LookUpField(Int32, String, String, String)	Used for id lookups from xmlindex
	CSF_LookUpField(Int32, String, String, String, Boolean, Int32)	Used for id lookups from xmlindex
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	FixXmlIndexArraySize(Boolean)	Fix the length of arrays used for XmlIndexQuery.
	FixXmlIndexArraySize(String)	Fix the length of arrays used for XmlIndexQuery.
	FixXmlIndexArraySize(EPTBaseICS_ASDynamicCode)	Fix the length of arrays used for XmlIndexQuery.
	FixXmlIndexArraySize(XmlIndexQueryQueryDataTypes)	Fix the length of arrays used for XmlIndexQuery.
	GenerateLinkTargetAttribute	Returns the attribute string to be written to the link. (Inherited from ActiveScriptingBase.)
	GetCorrectField	Extracts the correct value from a passed in EPT field name and a static field value. (Inherited from ActiveScriptingBase.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MakeDirectEditIcon	Method for creating an direct edit icon used in web view
	MemberwiseClone	(Inherited from Object.)
	PrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean)	Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell.
	PrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean, Boolean)	Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell.
	ReadCategoryIdFromIndexedField	Reads out the category ID from AS-Datatype: Indexed EPT fields.
	ReadFieldNameFromIndexedField	Reads out the field name from AS data type: Indexed EPT fields.
	ReadFromApplicationCache	Returns data that is read from the application cache. (Inherited from ActiveScriptingBase.)
	ReturnAlternateImage	Returns the filename for thumbnail or hires image
	ReturnQueryAsDictionary	Returns a Dictionary containing query results.
	SetApplicationCache	Stores a string in the application cache. (Inherited from ActiveScriptingBase.)
	SyncronizeMLC	Provides support for components that needs to be MLC aware, by localizing the supplied category or presentation template from the current document, or the preferred language of the visitor. (Inherited from ActiveScriptingBase.)
	ToString	(Inherited from Object.)
	WriteAttribute(TextWriter, String, String)	Writes an attribute string to the supplied stream, unless Value is an empty string or null (Inherited from ActiveScriptingBase.)
	WriteAttribute(TextWriter, String, String, Boolean)	Writes an attribute string to the supplied stream. (Inherited from ActiveScriptingBase.)

Top

Reference

ContentStudio.Site.ActiveScripting Namespace

Inheritance Hierarchy