Content Studio Web Content Management System
SystemObject
ContentStudio.SiteCodeBase
ContentStudio.Site.ActiveScriptingActiveScriptingBase
ContentStudio.Site.ActiveScriptingPageableComponent
ContentStudio.Site.ActiveScriptingEPTBase
ContentStudio.Site.ActiveScripting.EPTInsertAdvancedImage
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Top
Top
Top
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.
[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
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
The InsertAdvancedImage type exposes the following members.
Constructors
Name | Description | |
---|---|---|
InsertAdvancedImage |
Constructs a new instance of the InsertAdvancedImage class that
writes to the default response stream.
| |
InsertAdvancedImage(Stream) |
Constructs a new instance of the InsertAdvancedImage class that
writes to the supplied stream
|
Properties
Name | Description | |
---|---|---|
Align |
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).
| |
AlternateImageLink |
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.
| |
BackwardsComponentCompatibilityMode |
Sets or gets a value that indicates whether the code runs in backwards
compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.) | |
Border |
Sets or gets a value that defines the size of the border of the
image. The default value is zero (no border).
| |
ComponentName |
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.) | |
Conformance |
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.) | |
CS_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.) | |
ElementType |
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.) | |
Encoding |
Sets or gets the encoding the component uses. The default encoding is
the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.) | |
Height |
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).
| |
HSpace |
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).
| |
ImageAlt |
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.
| |
ImageName |
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.
| |
LinkTarget |
Sets or gets a value that defines target attribute of the
alternate image link generated. The default value is an empty string.
| |
OwnAttributes |
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).
| |
Page |
A reference to the current context page.
This will initialize in the constructor of this class.
(Inherited from CodeBase.) | |
RunningUserControl |
Gets the current running user control.
(Inherited from CodeBase.) | |
StaticImageAlt |
Sets or gets a value that defines the alt attribute of the
generated image. The default value is an empty string.
| |
StaticImageName |
Sets or gets a value that defines the URL of the image to insert. The
default value is an empty string.
| |
UseImageType |
Specifies what type of image to insert. The default value is ImagesAvailable.Normal.
| |
Width |
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).
| |
VSpace |
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).
|
Methods
Name | Description | |
---|---|---|
BuildHTMLComponentException |
Returns an component exception in HTML format.
(Inherited from ActiveScriptingBase.) | |
CreatePageRange |
Create a page range in HTML or XHTML
(Inherited from PageableComponent.) | |
CSF_LookUpField(Int32, String, String, String) |
Used for id lookups from xmlindex
(Inherited from EPTBase.) | |
CSF_LookUpField(Int32, String, String, String, Boolean, Int32) |
Used for id lookups from xmlindex
(Inherited from EPTBase.) | |
Equals | (Inherited from Object.) | |
Finalize | (Inherited from Object.) | |
GenerateLinkTargetAttribute |
Returns the attribute string to be written to the link.
(Inherited from ActiveScriptingBase.) | |
GetCorrectField |
Extracts the correct value from a passed in EPT field name and a static field value.
(Inherited from ActiveScriptingBase.) | |
GetHashCode | (Inherited from Object.) | |
GetType | (Inherited from Object.) | |
Invoke |
Invokes the component and writes the result into the supplied stream.
| |
MakeDirectEditIcon |
Method for creating an direct edit icon used in web view
(Inherited from EPTBase.) | |
MemberwiseClone | (Inherited from Object.) | |
PrepareSortCells(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.) | |
PrepareSortCells(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.) | |
ReadFromApplicationCache |
Returns data that is read from the application cache.
(Inherited from ActiveScriptingBase.) | |
ReturnQueryAsDictionary |
Returns a Dictionary containing query results.
(Inherited from EPTBase.) | |
SetApplicationCache |
Stores a string in the application cache.
(Inherited from ActiveScriptingBase.) | |
SyncronizeMLC |
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.) | |
ToString | (Inherited from Object.) | |
WriteAttribute(TextWriter, String, String) |
Writes an attribute string to the supplied stream, unless Value is
an empty string or null (Inherited from ActiveScriptingBase.) | |
WriteAttribute(TextWriter, String, String, Boolean) |
Writes an attribute string to the supplied stream.
(Inherited from ActiveScriptingBase.) |
Remarks
See Also