InsertBacklink Class Content Studio 5.7 SDK
Content Studio Web Content Management System

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

Writes a link to the last page to the supplied stream or the default response stream. The InsertBacklink class acts as the underlying engine for the Insert Backlink AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingDocumentBase
        ContentStudio.Site.ActiveScripting.DocumentInsertBacklink

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

public sealed class InsertBacklink : DocumentBase

The InsertBacklink type exposes the following members.

Constructors

  NameDescription
Public methodInsertBacklink
Constructs a new instance of the InsertBacklink class that writes to the default response stream
Public methodInsertBacklink(Stream)
Constructs a new instance of the InsertBacklink class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyBackwardsComponentCompatibilityMode
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 propertyClass
Sets or gets the value of the generated button or the title of the generated link. The default value is an empty string.
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyDisplayAsButton
Sets or gets the name of a CSS style class name to use to format the generated link or button. The default value is an empty string
Public propertyElementType
Gets a value which specifies the type of outer element that the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyText
Sets or gets the text to be displayed in the link or button. This text is not HTML encoded. The default value is an empty string
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream
Public methodToString (Inherited from Object.)
Top
Remarks

To use this class, create an instance of this object, set up the properties and call the Invoke method with an appropriate set of parameters. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. This class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code is fully HTML/XHTML strict compatible. .
See Also

Reference