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

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

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

The InsertImageLink type exposes the following members.

Constructors

  NameDescription
Public methodInsertImageLink
Constructs a new instance of the InsertImageLink class .
Public methodInsertImageLink(Stream)
Constructs a new instance of the InsertImageLink class that writes to the supplied stream
Public methodInsertImageLink(MasterPageBase)
Constructs a new instance of the InsertImageLink class.
Public methodInsertImageLink(SiteBase)
Constructs a new instance of the InsertImageLink class.
Public methodInsertImageLink(UserControlBase)
Constructs a new instance of the InsertImageLink class.
Public methodInsertImageLink(SiteBase, UserControlBase)
Constructs a new instance of the InsertImageLink class.
Public methodInsertImageLink(Stream, SiteBase, UserControlBase)
Constructs a new instance of the InsertImageLink class that writes to the supplied stream
Top
Properties

  NameDescription
Public propertyAftContent
Sets or gets the text to be displayed immediately after the image link. The default value is an empty string.
Public propertyAlign
Sets or gets the ALIGN attribute of the image. The default value is an empty string (the attribute is not used).
Public propertyAlt
Sets or gets the name of the field containing the text to be used for the ALT attribute of the image. This value will override the StaticAlt property. The default value is an empty string.
Public propertyAlwaysShowImage
Sets or gets a value indicating if the image should be displayed even if the StaticURL or URL property not is vlalid. The default value is false.
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 propertyCode exampleBorder
Sets or gets the BORDER attribute of the image. The default value is zero (no border).
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 propertyCode exampleHeight
Sets or gets the HEIGHT attribute of the image. The default value is an empty string (the attribute is not used).
Public propertyCode exampleHSpace
Sets or gets the HSPACE (horizontal space) attribute of the image. The default value is an empty string (the attribute is not used).
Public propertyCode exampleImage
Sets or gets the name of the field containing the source reference (URL) of the image to use. The default value is an empty string (using the value of StaticImage instead).
Public propertyCode examplePreContent
Sets or gets the text to be displayed immediately before the image link. The default value is an empty string.
Public propertyCode examplePTID
Sets or gets an optional presentation template (PTID) to be used when StaticURL is a document ID. The default value is zero (no optional PTID).
Public propertyCode exampleStaticAlt
Sets or gets the ALT attribute of the image, which describes the content of the image. This value can be overridden by the Alt property. The default value is an empty string.
Public propertyCode exampleStaticImage
Sets or gets the static source reference (URL) of the image to use. This value can be overridden by the Image property. The default value is an empty string..
Public propertyCode exampleStaticTarget
Sets or gets the static TARGET attribute of the link. This value can be overridden by the Target property. The default value is an empty string (the attribute is not used).
Public propertyCode exampleStaticText
Sets or gets the link text This value can be overridden by the Text property. The default value is an empty string.
Public propertyCode exampleStaticURL
Sets or gets the link URL, which can be a regular URL or a document ID. This value can be overridden by the URL property. The default value is an empty string.
Public propertyTarget
Sets or gets the name of the field containing the text to be used in theTARGET attribute of the link. This value will override the StaticTarget property. The default value is an empty string (the attribute is not used).
Public propertyText
Sets or gets the name of the field containing the text to be used in the link text. This value will override the StaticText property.The default value is an empty string.
Public propertyURL
Sets or gets the name of the field containing the source reference to the destination URL. This value will override the StaticURL property. The default value is an empty string.
Public propertyCode exampleWidth
Sets or gets the WIDTH attribute of the image. The default value is an empty string (the attribute is not used).
Public propertyCode exampleVSpace
Sets or gets the VSPACE (vertical space) attribute of the image. 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
Exceptions

ExceptionCondition
ArgumentNullExceptionA null reference (undefined reference) was passed and referenced.
ArgumentOutOfRangeExceptionAn argument with with a value out of range was passed.
ArgumentExceptionAn argument with with an illegal value was passed.
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.
See Also

Reference