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

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

Writes an image element with an optional link attribute to the supplied stream or the default response stream. The image can be used in a presentation template or another HTML document. It can also use images generated by the Content Studio image processing functionality. The InsertAdvancedImage class acts as the underlying engine for the Insert advanced image AS component.
Inheritance Hierarchy

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

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

public class InsertAdvancedImage : EPTBase

The InsertAdvancedImage type exposes the following members.

Constructors

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

  NameDescription
Public propertyAlign
Sets or gets a value that defines the align attribute of the generated image element. The default value is an empty string (no attribute is used).
Public propertyAlternateImageLink
Sets or gets a value that indicates how the generated image element should generate a link to one of the possible alterative images. The default value is AlternateLinkGeneration.None.
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 propertyBorder
Sets or gets a value that defines the size of the border 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.)
Protected propertyCode exampleCS_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 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 propertyHeight
Sets or gets a value that defines the height attribute of the generated image. The default value is an empty string (no attribute is used).
Public propertyHSpace
Sets or gets a value that defines the hspace attribute of the generated image. The default value is an empty string (no attribute is used).
Public propertyImageAlt
Sets or gets a value that defines an EPT field name that contains the text for the alt attribute of the generated image. This property is ignored if StaticImageAlt is specified. The default value is an empty string.
Public propertyImageName
Sets or gets a value that defines an EPT field that contains the URL to the image to show This property is ignored if StaticImageName is specified. The default value is an empty string.
Public propertyLinkTarget
Sets or gets a value that defines target attribute of the alternate image link generated. The default value is an empty string.
Public propertyOwnAttributes
Sets or gets a value that defines attributes to be used on the image element. The default value is an empty string (no attributes are defined).
Protected propertyPage
A reference to the current context page. This will initialize in the constructor of this class.
(Inherited from CodeBase.)
Protected propertyRunningUserControl
Gets the current running user control.
(Inherited from CodeBase.)
Public propertyStaticImageAlt
Sets or gets a value that defines the alt attribute of the generated image. The default value is an empty string.
Public propertyStaticImageName
Sets or gets a value that defines the URL of the image to insert. The default value is an empty string.
Public propertyUseImageType
Specifies what type of image to insert. The default value is ImagesAvailable.Normal.
Public propertyWidth
Sets or gets a value that defines the width attribute of the generated image. The default value is an empty string (no attribute is used).
Public propertyVSpace
Sets or gets a value that defines the vspace attribute of the generated image element. The default value is an empty string (no attribute is used).
Top
Methods

  NameDescription
Protected methodBuildHTMLComponentException
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.)
Protected methodCreatePageRange
Create a page range in HTML or XHTML
(Inherited from PageableComponent.)
Protected methodCSF_LookUpField(Int32, String, String, String)
Used for id lookups from xmlindex
(Inherited from EPTBase.)
Protected methodCSF_LookUpField(Int32, String, String, String, Boolean, Int32)
Used for id lookups from xmlindex
(Inherited from EPTBase.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Protected methodGenerateLinkTargetAttribute
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.)
Protected methodGetCorrectField
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes the result into the supplied stream.
Protected methodMakeDirectEditIcon
Method for creating an direct edit icon used in web view
(Inherited from EPTBase.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodPrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean)
Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell.
(Inherited from EPTBase.)
Protected methodPrepareSortCells(Stream, Boolean, String, String, String, String, String, String, Boolean, Boolean, Boolean)
Prepare sort cells. Writes a <td></td> or <span></span> portion of sort cell.
(Inherited from EPTBase.)
Protected methodReadFromApplicationCache
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodReturnQueryAsDictionary
Returns a Dictionary containing query results.
(Inherited from EPTBase.)
Protected methodSetApplicationCache
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.)
Protected methodSyncronizeMLC
Provides support for components that needs to be MLC aware, by localizing the supplied category or presentation template from the current document, or the preferred language of the visitor.
(Inherited from ActiveScriptingBase.)
Public methodToString (Inherited from Object.)
Protected methodWriteAttribute(TextWriter, String, String)
Writes an attribute string to the supplied stream, unless Value is an empty string or null
(Inherited from ActiveScriptingBase.)
Protected methodWriteAttribute(TextWriter, String, String, Boolean)
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.)
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. The generated code is HTML4/XHTML compatible. However, some of the properties will make the generated code invalid for strict document types. More information is found on the properties that not are fully HTML/XHTML strict compatible.
See Also

Reference