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

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

Writes a link containing a reference to the same page using another presentation template. This functionality is only applicable to presentation templates. The InsertLinkToSelf class acts as the underlying engine for the Insert link to self AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.EPTInsertLinkToSelf

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

public sealed class InsertLinkToSelf : EPTBase

The InsertLinkToSelf type exposes the following members.

Constructors

  NameDescription
Public methodInsertLinkToSelf
Constructs a new instance of the InsertLinkToSelf class that writes to the default response stream
Public methodInsertLinkToSelf(Stream)
Constructs a new instance of the InsertLinkToSelf class that writes to the supplied stream
Public methodInsertLinkToSelf(MasterPageBase)
Constructs a new instance of the InsertLinkToSelf class that writes to the supplied stream
Public methodInsertLinkToSelf(SiteBase)
Constructs a new instance of the InsertLinkToSelf class that writes to the supplied stream
Public methodInsertLinkToSelf(UserControlBase)
Constructs a new instance of the InsertLinkToSelf class that writes to the supplied stream
Public methodInsertLinkToSelf(SiteBase, UserControlBase)
Constructs a new instance of the InsertLinkToSelf class that writes to the supplied stream
Public methodInsertLinkToSelf(Stream, SiteBase, UserControlBase)
Constructs a new instance of the InsertLinkToSelf class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyAltText
Sets or gets the ALT attribute of the image, which describes the content of the image. The default value is an empty string.
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 propertyClassName
Sets or gets the CLASS attribute of the link. The default value is an empty string (the attribute is not used).
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 propertyElementType
Gets a value which specifies the type of outer element 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 propertyImageField
Sets or gets a value indicating if the LinkImage property should be interpreted as an EPT field name. The default value is false (the LinkField property is interpreted as an URL).
Public propertyLinkField
Sets or gets a value indicating if the LinkText property should be interpreted as an EPT field name. The default value is false (the LinkText property is interpreted as plain text).
Public propertyLinkImage
Sets or gets the URL of an image to be displayed with the link. If the property ImageField is set, this should be the name of an EPT field containing the URL of the image. The default value is empty string (no image to display).
Public propertyLinktext
Sets or gets the text to be displayed with the link. If the property LinkField is set, this should be the name of an EPT field containing the text to display. The default value is empty string (no text to display).
Public propertyCode examplePTID
Sets or gets an optional presentation template (PTID) to be used. The default value is zero (no optional PTID).
Public propertyRememberQueryString
Sets or gets a value indicating if all query string variables (except ID and PTID) should be remembered. The default value is true.
Public propertyRootSelf
Sets or gets a value indicating if you want to link to the root document (the ID in query string). The default value is false.
Public propertyTarget
Sets or gets the TARGET attribute of the link. The default value is an empty string (the attribute is not used).
Public propertyTargetField
Sets or gets a value indicating if the Target property should be interpreted as an EPT field name. The default value is false (the Target property is interpreted as plain text).
Public propertyTitle
Sets or gets the TITLE attribute of the link. The default value is an empty string (the attribute is not used).
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 the properties that does not have the values you expect, and call the Invoke method. 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. This class is sealed and cannot be inherited from by other classes.
See Also

Reference