InsertLinksToMLCSiblings Properties Content Studio 5.7 SDK
Content Studio Web Content Management System

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

The InsertLinksToMLCSiblings type exposes the following members.

Properties

  Name Description
Protected property ActualDocumentId
Gets the ID of the actual inserted document. The default value, before the Invoke method has been executed, is zero. If UseRoot is true, this property contains the root document (if existing), or the current document. If UseRoot is false, this will be the document itself.
Protected property ActualSeparator
Gets the separator that actually is used. If LinksOnNewLine is true, the separator will be a "<BR />" tag, otherwise it will be the value of the Separator property.
Public property Code example Attributes
Sets or gets optional attributes for each generated element. The default value is an empty string.
Public property 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.)
Public property ClassName
Sets or gets the name of an EPT field that contains the CSS class name to use with the displayed link. The default value is an empty string. If the StaticClassName parameter is set this parameter is ignored. This method should only be used in presentation templates.
Public property ComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public property Conformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Protected property Code example 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.)
Public property ElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public property Encoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public property LanguageCode
Gets the language code used. By default this property is "neutral" and set when the LanguageXml property is set.
(Inherited from MLCBase.)
Public property LanguageID
Gets the language id used. By default this property is 1 (neutral) and set when the LanguageXml property is set.
(Inherited from MLCBase.)
Public property LanguageName
Gets the language name used. By default this property is an "(Language neutral)" and set when the LanguageXml property is set.
(Inherited from MLCBase.)
Public property 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.
(Inherited from MLCBase.)
Public property LinkOption
Sets or gets a value that indicates the display mode for the current language. The default value is LinkOptions.DoNotDisplayLinkToSelf.
Public property LinksOnNewLine
Sets or gets a value that indicates if each of the links should be on a separate line (separated by line breaks).The default value is false. If this property is true, the Separator property will be ignored.
Public property LookupPresentationTemplate
Sets or gets a value that indicates if Content Studio should do an MLC lookup on the presentation template. The default value is true. If this property is true, the presentation template must be an MLC member or located in an MLC member category.
Public property LookupReferrer
Sets or gets a value that indicates if Content Studio should do an MLC lookup on the referring document retrieved from the component. The default value is true. If this property is true, the referrer document must be an MLC member or located in an MLC member category.
Public property NoDisplayCountry
Sets or gets a value that indicates if the country information should be displayed. The default value is false ("Swedish - Sweden" will be displayed as "Swedish").
Protected property Page
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Protected property 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.
(Inherited from MLCBase.)
Protected property ReferrerSiblings
Gets a collection of MLC siblings for the referring page.
(Inherited from MLCBase.)
Protected property RunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
Public property Separator
Sets or gets the string that is used as a separator between the links. The default value is a ", " (a comma followed by a space).
Protected property 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.
(Inherited from MLCBase.)
Public property StaticClassName
Gets or sets the CLASS attribute of the displayed link. The default value is an empty string. Set this property to an empty string if the ClassName property should be used.
Public property StaticTarget
Gets or sets the TARGET attribute of the displayed link. The default value is an empty string. Set this property to an empty string if the Target property should be used.
Public property Target
Gets or sets the a name of an EPT field that contains the TARGET attribute of the link. The default value is an empty string If the StaticTarget parameter is set this parameter is ignored. Available in presentation templates only.
Public property Translations
Sets or gets a value that indicates the type of translation of language names to be done while rendering the links. The default value is TranslationOptions.DefaultLanguageName.
Public property UseRoot
Sets or gets a value that indicates if this component is used in an included document. The default value is false. If this property is true, the document that this document is included in will be used (rather that the current document).
Top
See Also

Reference