Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingMLCBase
ContentStudio.Site.ActiveScripting.MLCInsertDocumentByMLCLanguage
ContentStudio.Site.ActiveScripting.MLCInsertLinksToMLCSiblings
ContentStudio.Site.ActiveScripting.MLCInsertLinkToOtherLanguage
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
[This is preliminary documentation and is subject to change.]
This class acts as a base class for MLC aware Content Studio Active scripting components.
MLCBase has a number of base properties and useful methods that facilitates the creation of MLC aware components.
Inheritance Hierarchy
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingMLCBase
ContentStudio.Site.ActiveScripting.MLCInsertDocumentByMLCLanguage
ContentStudio.Site.ActiveScripting.MLCInsertLinksToMLCSiblings
ContentStudio.Site.ActiveScripting.MLCInsertLinkToOtherLanguage
Namespace: ContentStudio.Site.ActiveScripting
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
The MLCBase type exposes the following members.
Constructors
Name | Description | |
---|---|---|
MLCBase | Initializes a new instance of the MLCBase class |
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.) | |
LanguageCode |
Gets the language code used. By default this property is "neutral" and set when the LanguageXml property is set.
| |
LanguageID |
Gets the language id used. By default this property is 1 (neutral) and set when the LanguageXml property is set.
| |
LanguageName |
Gets the language name used. By default this property is an "(Language neutral)" and set when the LanguageXml property is set.
| |
LanguageXml |
Sets or gets a value that indicates an MLC-language used by the document to insert.
This is indicated as an XML fragment in the format:
<r><id>NNNNN</id><name>Language name</name><languagecode>LL</languagecode></r>
Where NNNNN is the numeric LanguageID and LL is the language short string
The default value is "<r><id>1</id><name>(Language neutral)</name><languagecode>neutral</languagecode></r>"
When you set this property the LanguageID, LanguageName and LanguageCode properties are set to the language indicated by the XML fragment.
| |
Page |
A reference to the current context page.
This will initialize in the constructor of this class.
(Inherited from CodeBase.) | |
PresentationTemplateSiblings |
Returns a collection of presentation template siblings connected to the current document's presentation template.
The first time this property is called the collection is create and filled with the siblings of the current presentation template.
| |
ReferrerSiblings |
Gets a collection of MLC siblings for the referring page.
| |
RunningUserControl |
Gets the current running user control.
(Inherited from CodeBase.) | |
Siblings |
Returns a collection of siblings connected to this document.
The first time this property is called the collection is create and filled with the siblings of the current document.
To fill the collection with siblings for another document use the LoadDocumentSiblings method before calling this property.
|
Methods
Name | Description | |
---|---|---|
BuildHTMLComponentException |
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
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.) | |
GetDocumentLanguage |
Returns the language of the an MLC documents.
| |
GetHashCode | (Inherited from Object.) | |
GetLanguageDataFromASDatatypeMLCLanguage |
Converts the XML used by the MLC language AS datatype to the language id indicated in the fragment
| |
GetMLCDocumentSibling |
Returns the sibling document to the specified document that has the language indicated by the LanguageID property.
| |
GetMLCDocumentSiblingByLanguageCode |
Returns the sibling document to the specified document that has the language code specified.
| |
GetSiblingCollection |
Returns a collection of siblings given a document identifier.
| |
GetType | (Inherited from Object.) | |
Invoke |
When overridden in derived classes invokes the component and renders its content.
| |
LoadDocumentSiblings |
Loads the Siblings collection with MLC siblings for a specific document. If the collection already exists and is filled it will be recreated an refilled.
| |
MemberwiseClone | (Inherited from Object.) | |
ReadFromApplicationCache |
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.) | |
SetApplicationCache |
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.) | |
SetLanguage(Int32) |
Sets the correct MLC language information if you have the Language identifier.
This method will set the LanguageXml, LanguageID, LanguageName and LanguageCode properties
| |
SetLanguage(String) |
Sets the correct MLC language information if you have the Language code.
This method will set the LanguageXml, LanguageID, LanguageName and LanguageCode properties
| |
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.) |
See Also