InsertLink20 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 supplied stream or the default response stream. The InsertLink20 class acts as the underlying engine for the Insert link 2.0 AS component.
Inheritance Hierarchy

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

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 InsertLink20 : EPTBase

The InsertLink20 type exposes the following members.

Constructors

  NameDescription
Public methodInsertLink20
Constructs a new instance of the InsertLink20 class that writes to the default response stream
Public methodInsertLink20(Stream)
Constructs a new instance of the InsertLink20 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 propertyClassName
Gets or sets the a name of an EPT field that contains the CSS class name to use with the displayed link. If the StaticClassName parameter is set this parameter is ignored. 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 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 propertyImageAltAttribute
Gets or sets the a name of an EPT field that contains the ALT attribute to use with the image to be used as a part of the link. If the StaticImageAlt parameter is set this parameter is ignored. The default value is an empty string.
Public propertyLinkImage
Gets or sets the a name of an EPT field that contains the URL to an image file to be used as a part of the link. If the StaticLinkImage parameter is set this parameter is ignored. The default value is an empty string.
Public propertyLinkText
Gets or sets a name of an EPT field that contains the text to display in the link. If the StaticLinkText parameter is set this parameter is ignored. The default value is an empty string.
Public propertyLinkURL
Gets or sets the a name of an EPT field that contains the link URL. If the StaticLinkURL parameter is set this parameter is ignored. The default value is an empty string.
Public propertyOptionalQueryString
Gets or sets the query string argument to be appended to the link. The default value is an empty string.
Public propertyPTId
Gets or sets the presentation template to use. This parameter is ignored if the value is zero or less. The default value is zero.
Public propertyStaticClassName
Gets or sets the name of the CSS class name to use with the displayed link. Set this property to an empty string if the ClassName instead. The default value is an empty string.
Public propertyStaticImageAltAttribute
Gets or sets the content of the ALT attribute to use with the image to be used as a part of the link. Set this property to an empty string if the ImageAlt should be used instead. The default value is an empty string.
Public propertyStaticLinkImage
Gets or sets the name of a URL to the image file to be used as a part of the link. Set this property to an empty string if the LinkImage should be used instead. The default value is an empty string.
Public propertyStaticLinkText
Gets or sets the text to show in the link. Set this property to an empty string if the LinkText should be used instead. The default value is an empty string.
Public propertyStaticLinkURL
Gets or sets the link URL. Set this property to an empty string if the LinkURL should be used instead. The default value is an empty string.
Public propertyStaticTarget
Gets or sets the TARGET attribute of the link. Set this property to an empty string if Target should be used instead. The default value is an empty string.
Public propertyStaticTitle
Gets or sets the that contains the TITLE attribute of the generated link. Set this property to an empty string if Title should be used instead. The default value is an empty string.
Public propertyTarget
Gets or sets the a name of an EPT field that contains the TARGET attribute of the link. If the StaticTarget parameter is set this parameter is ignored. The default value is an empty string.
Public propertyTitle
Gets or sets the a name of an EPT field that contains the TITLE attribute of the generated link. If the StaticTitle parameter is set this parameter is ignored. 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 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 HTML 4, XHTML 1.0, and XHTML 1.1 compatible. This class is sealed and cannot be inherited from by other classes.
See Also

Reference