Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Runtime.Modules Namespace > ImageFromHtml Class > ImageFromHtml Properties
PRELIMINARY INFORMATION - SUBJECT TO CHANGE
This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C# Copy imageCopy Code 
                                  public class ImageFromHtml
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public Class ImageFromHtml

The type exposes the following properties.

Public Properties

  Name Description
Public property AcceptsInnerXml
Returns true if the module currently accepts string data within the macro tags.
(Inherited from BaseModule.)
Public property AccessDeniedReturnValue
Gets or sets the value that is returned when the site visitor has insufficient access.
(Inherited from Module.)
Public property AIMMode
Gets or sets the AIM scanning mode of the macro.
(Inherited from Module.)
Public property AIMOrigin
Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item.
(Inherited from Module.)
Public property AuthenticationPassword
Optionally set the Password property to authenticate to web server before accessing the URL to be converted (e.g handles any IIS authentication method).
Public property AuthenticationUsername
Optionally set the Username property to authenticate to web server before accessing the URL to be converted (e.g handles any IIS authentication method).
Public property BufferNames
Gets or sets the buffer names.
(Inherited from Module.)
Public property Condition
Gets or sets the Viper expression to evaluate before actually executing the macro.
If the expression returns false, the execution of the module and its child modules is skipped.
(Inherited from Module.)
Public property ConditionMatched
Must return true if TestCondition() matched.
(Inherited from Module.)
Public property ConversionDelay
An additional time in seconds to wait for asynchronous items to be loaded. A delay is necessary for example to allow a Flash movie to start before starting conversion.
Public property CurrentCacheModule
Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block.
(Inherited from Module.)
Public property CurrentProperty
Gets the property currently being set on the module.
(Inherited from BaseModule.)
Public property DefaultValue
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.)
Public property EnableActiveX
Enable ActiveX controls when rendering HTML to image. Default is false.
Public property EnableBehaviors
Enable behaviors when rendering HTML to image. Default is false.
Public property EnableJavascript
Enable scripts when rendering HTML to image. Default is true.
Public property Formatting
Gets the formatting options.
(Inherited from Module.)
Public property HasParameterSection
Returns true if the macro currently uses an SXML parameters section
(Inherited from BaseModule.)
Public property Height
Gets or sets the web page height. Defaults to 1600. Set to 0 for auto-detect.
Public property HttpRequestHeaders
Gets or sets a string containing the HTTP headers sent by the converter to the web server when the web page is requested from a URL. The HTTP headers string can be used to define cookies, authentication options, URL referer or any other HTTP header to be sent to the web browser.
Public property Id
Gets or sets the unique id of the module instance during the current processing.
Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method.
(Inherited from BaseModule.)
Public property ImageFormat
Gets or sets the ImageFormat to be used. Defaults to Png.
Public property IsCancelled
Gets a value indicating whether the execution of the macro is cancelled.
(Inherited from BaseModule.)
Public property IsSelfClosing
Gets a value indicating whether this instance is self closing.
(Inherited from BaseModule.)
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property Location
Sets the location of the source HTML. This can be an (absolute) url or a smartsite item.
Public property MinimumAccessTypeLevel
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.)
Public property ModuleInfo
Gets the module info.
(Inherited from BaseModule.)
Public property NavigationTimeout
The navigation timeout in seconds. Default value is 60.
Public property OnErrorReturnValue
Gets or sets the value to return in case on error occurs during execution.
The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context.
(Inherited from Module.)
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property Remarks
Gets or sets the remarks. Remarks have no effect on the actual execution of the module.
They only improve the readability of the code.
(Inherited from BaseModule.)
Public property Result
Returns a reference to the module result
(Inherited from BaseModule.)
Public property ResultFormat
Gets or sets the resultformat.
(Inherited from Module.)
Public property ResultType
Gets or sets the type of the result.
(Inherited from BaseModule.)
Public property State
Gets a key/value collection that can be used to organize and share data during the lifecycle of a module.
(Inherited from BaseModule.)
Public property Status
Gets a value indicating the ModuleStatus of this module.
(Inherited from BaseModule.)
Public property SXMLPath
Gets the path to the macro in the current execution stack.
(Inherited from BaseModule.)
Public property TimeoutSeconds
Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out.
(Inherited from BaseModule.)
Public property Trim
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.)
Public property TypeName
Gets the name of the Module type.
(Inherited from BaseModule.)
Public property UserSetPropertyList
Gets the user-set property list.
(Inherited from BaseModule.)
Public property Whitespace
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.)
Public property Width
Gets or sets the web page width. Defaults to 1600. Set to 0 for auto-detect.

Protected Properties

  Name Description
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Explicit Interface Implementations

See Also

Advanced