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 Code
public class Embed

Visual Basic (Declaration)	Copy Code
Public Class Embed

The type exposes the following members.

Public Constructors

	Name	Description
	Embed	Initializes a new instance of the Embed class.

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	ApplyProperties	Applies the properties from the SXML processing environment into the current module. (Inherited from BaseModule.)
	BeginExecute	Override this to execute code before Execute() is fired. Last point to add data to the Cache Signature. (Inherited from Module.)
	Capture	Passes an SXML subtree to the current module. (Inherited from BaseModule.)
	CheckTimeout	Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()(). (Inherited from BaseModule.)
	ClearForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from BaseModule.)
	DoPreparse	Check whether to preparse data in the given property. (Inherited from BaseModule.)
	DoRecurseTag	Determines whether to recurse on a given tag
	EndExecute	Override this to execute code after Execute() is fired. (Inherited from Module.)
	Equals	(Inherited from Object.)
	EvaluatePropertyExpression	Evaluates an expression in a property with Expression Syntax (Inherited from Module.)
	Execute	Execute the macro. Should be overridden by inherited class. (Inherited from EmbedBase.)
	ExecuteRawParameter	Executes the data of a raw parameter. (Inherited from Module.)
	ExistsBuffer	Checks whether a local buffer exists. (Inherited from BaseModule.)
	Find	Finds the specified child module. (Inherited from BaseModule.)
	FindExtension	Finds an extension macro. (Inherited from BaseModule.)
	GetAIMRelations	Gets a list of all outgoing AIM relations created by the macro. (Inherited from BaseModule.)
	GetBodyXml	Gets the Xml of the document's body node. (Inherited from EmbedBase.)
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetCompleteDocument	Gets the complete document. (Inherited from EmbedBase.)
	GetDataLength	Gets the response length of the embedded page. (Inherited from EmbedBase.)
	GetDocumentBody	Gets the inner html of the document's body node. (Inherited from EmbedBase.)
	GetException	Returns the text message of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionSmartsiteCode	Returns the Smartsite Error code of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionString	Returns the full information of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetExceptionType	Returns the full Type name of the exception that has occurred. (Inherited from BaseModule.)
	GetExpireDate	Gets the expiry date of the embedded page. (Inherited from EmbedBase.)
	GetForcedResult	Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult(). (Inherited from Module.)
	GetHashCode	(Inherited from Object.)
	GetHeadSection	Returns a DataTable containing all the header elements from the embedded page. (Inherited from EmbedBase.)
	GetInnerException	Returns the text message of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionSmartsiteCode	Returns Smartsite error code of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionString	Returns the full information of the inner exception of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetInnerExceptionType	Returns the full Type name of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetLastModified	Gets the last modified datetime of the embedded page. (Inherited from EmbedBase.)
	GetMimeType	Gets the mime type of the embedded page. (Inherited from EmbedBase.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off). (Inherited from BaseModule.)
	GetRenderTime	Returns the render time of the macro in milliseconds. (Inherited from Module.)
	GetResponseHeaders	Returns the http response headers.
	GetResponseTime	Gets the response time of the embedded page. (Inherited from EmbedBase.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetStatusCode	Gets the http status code of the embedded page (see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html) (Inherited from EmbedBase.)
	GetType	(Inherited from Object.)
	Initialize	Initializes the macro. (Inherited from EmbedBase.)
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	SetBuffer	Sets a local buffer. (Inherited from BaseModule.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	TestCondition	Tests whether execution should take place based on the expression in the condition property (Inherited from Module.)
	TestPropertyExpression	Tests whether an expression in a property with Expression Syntax evaluates to true. (Inherited from Module.)
	ThrowCurrentException	Makes Smartsite throw the current exception. (Inherited from BaseModule.)
	ThrowInnerException	Makes Smartsite throw the inner exception. (Inherited from BaseModule.)
	ToString	Returns a String that represents the current Object. (Inherited from Module.)

Protected Methods

	Name	Description
	AddBaseHref	(Inherited from EmbedBase.)
	Finalize	(Inherited from Object.)
	FixLink	Fixes a single link in relation to the location field. (Inherited from EmbedBase.)
	FixLinks	Fixes links in the embedded document. (Inherited from EmbedBase.)
	GetResponseCookiesInternal	Gets the cookies set by the embedded page. (Inherited from EmbedBase.)
	IsBufferName	Determines whether the data is a buffer name. (Inherited from Module.)
	IsSingleSaveBuffername	Determines whether a single save buffername is used. (Inherited from Module.)
	MemberwiseClone	(Inherited from Object.)
	ParseHead	Collects all style and script elements from the head section in the headSection DataTable. (Inherited from EmbedBase.)
	ParseXml	Initializes the embeddedDocument field. (Inherited from EmbedBase.)
	SetCurrentProperty	Sets the current property. (Inherited from BaseModule.)

Protected Fields

	Name	Description
	cookiesInternal	Gets or sets a collection of cookies that are sent to and received back from the embedded page. Will optionally override the cookies present in the request to the embedding page. (Inherited from EmbedBase.)
	CustomDataList	Gets or sets the custom data. (Inherited from EmbedBase.)
	CustomPostDataList	Gets or sets the data to be posted by the request. (Inherited from EmbedBase.)
	DoExecute	Specifies whether to execute the module (Inherited from BaseModule.)
	embeddedDocument	XmlDocument representing the embedded document. Initialize with the ParseXml method. Some processing such as link fixing is done destructively on the document. (Inherited from EmbedBase.)
	followRedirectInternal	Follow redirect to be set from public property of derived class (Inherited from EmbedBase.)
	headerModeInternal	Http header handling to be set from public property of derived class (Inherited from EmbedBase.)
	headSection	Contains all style and script elements from the embedded document. (Inherited from EmbedBase.)
	InternalAIMMode	Cotnains the internal AIM mode. (Inherited from Module.)
	InternalCopyFormatting	The id of the macro to copy the formatting settings from. (Inherited from Module.)
	InternalFormatting	Formatting settings. (Inherited from Module.)
	Mode	The request mode. (Inherited from EmbedBase.)
	namespaceManager	Namespace manager belonging with embeddedDocument. The default namespace is initialized with prefix "default". (Inherited from EmbedBase.)
	OutputDecodingSetting	Gets or sets a value indicating whether to use output decoding before sending the response to the client. (Inherited from EmbedBase.)
	ProcessHttpErrorsInternal	Set to true to receive a response even when an Http error has occurred. Set to false to throw the Http error as an exception. (Inherited from EmbedBase.)
	requestHeadersInternal	Gets or sets a collection of request headers for the embedded request. Will optionally override headers from the embedding page (Inherited from EmbedBase.)
	ResolvingSaveBuffers	True when save buffers are evaluated. (Inherited from BaseModule.)
	responseHeadersInternal	Gets a collection of response headers from the embedded response. (Inherited from EmbedBase.)
	savingUnformattedResult	True when save buffers are checked before formatting is applied, to facilitate unformated data to be saved. (Inherited from BaseModule.)

Public Properties

	Name	Description
	AcceptsInnerXml	Returns true if the module currently accepts string data within the macro tags. (Inherited from BaseModule.)
	AccessDeniedReturnValue	Gets or sets the value that is returned when the site visitor has insufficient access. (Inherited from Module.)
	AIMMode	Gets or sets the AIM scanning mode of the macro. (Inherited from Module.)
	AIMOrigin	Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item. (Inherited from Module.)
	BufferNames	Gets or sets the buffer names. (Inherited from Module.)
	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.)
	ConditionMatched	Must return true if TestCondition() matched. (Inherited from Module.)
	CurrentCacheModule	Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block. (Inherited from Module.)
	CurrentProperty	Gets the property currently being set on the module. (Inherited from BaseModule.)
	CustomPostData	Gets or sets the custom post data.
	CustomRequestBody	Gets or sets the custom request body. (Inherited from EmbedBase.)
	CustomRequestContentType	Gets or sets the content type of the request when CustomRequestBody is set. (Inherited from EmbedBase.)
	DefaultValue	Gets or sets the default value that will be returned when the execution would otherwise return an empty string. (Inherited from Module.)
	DoAddBaseHref	Set to true to add a base href element to the head section of the embedded page. (Inherited from EmbedBase.)
	DoFixLinks	Fixes links to self and relative resources. (Inherited from EmbedBase.)
	FollowRedirect	Determines if redirect instructions from the embedded page are followed. (Inherited from EmbedBase.)
	Formatting	Gets the formatting options. (Inherited from Module.)
	HasParameterSection	Returns true if the macro currently uses an SXML parameters section (Inherited from BaseModule.)
	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.)
	IsCancelled	Gets a value indicating whether the execution of the macro is cancelled. (Inherited from BaseModule.)
	IsSelfClosing	Gets a value indicating whether this instance is self closing. (Inherited from BaseModule.)
	LocalId	Gets or sets the local id of the macro in the current buffer scope. (Inherited from Module.)
	Location	Gets or sets the Locator location to embed. (Inherited from EmbedBase.)
	MinimumAccessTypeLevel	Friendly name of the minimum access type level required by the site visitor to execute this macro. (Inherited from Module.)
	ModuleInfo	Gets the module info. (Inherited from BaseModule.)
	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.)
	OutputDecoding	Gets or sets a value indicating whether to use output decoding before sending the response to the client.
	PostDirect	Set to true to make form actions point to the embedded page directly, without passing through Smartsite. (Inherited from EmbedBase.)
	Properties	Gets the full list of properties as set when executing the module. (Inherited from BaseModule.)
	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.)
	Result	Returns a reference to the module result (Inherited from BaseModule.)
	ResultFormat	Gets or sets the resultformat. (Inherited from Module.)
	ResultType	Gets or sets the type of the result. (Inherited from BaseModule.)
	State	Gets a key/value collection that can be used to organize and share data during the lifecycle of a module. (Inherited from BaseModule.)
	Status	Gets a value indicating the ModuleStatus of this module. (Inherited from BaseModule.)
	SXMLPath	Gets the path to the macro in the current execution stack. (Inherited from BaseModule.)
	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.)
	Trim	Gets a value indicating how the whitespace is trimmed. (Inherited from BaseModule.)
	TypeName	Gets the name of the Module type. (Inherited from BaseModule.)
	UsePostData	Pass posted form data to the embedded page. (Inherited from EmbedBase.)
	UserSetPropertyList	Gets the user-set property list. (Inherited from BaseModule.)
	UseSandbox	Gets or sets a value indicating whether to run the embed in a sandbox. (Inherited from EmbedBase.)
	Whitespace	Gets a value indicating whether to preserve whitespace. (Inherited from BaseModule.)

Protected Properties

	Name	Description
	AIMPassThrough	Gets or sets a value indicating whether to use AIM pass through. (Inherited from EmbedBase.)
	IContext	Gets a reference to the IContext interface. (Inherited from BaseModule.)
	Password	Gets or sets the password. (Inherited from EmbedBase.)
	Settings	Gets the Rendering _settings. (Inherited from EmbedBase.)
	UserName	Gets or sets the user name. (Inherited from EmbedBase.)

Public Events

	Name	Description
	SetProperty	Event fired just before setting a property on the Module instance from the SXML processor. (Inherited from BaseModule.)
	StatusChange	Event raised when the execution status changes. (Inherited from BaseModule.)

Explicit Interface Implementations

	Name	Description
	IAIMModule..::..AIMRelations	(Inherited from BaseModule.)
	IModuleExec..::..Cancel	(Inherited from BaseModule.)
	IModuleExec..::..Context
	IModuleExec..::..FinishExecute	(Inherited from BaseModule.)
	ICacheItemExpiration..::..HasExpired	(Inherited from EmbedBase.)
	ICacheItemExpiration..::..Initialize	(Inherited from EmbedBase.)
	IModuleExec..::..Initialize	(Inherited from BaseModule.)
	IModuleExec..::..InstructionSource	(Inherited from BaseModule.)
	ISXMLInstruction..::..Name	(Inherited from BaseModule.)
	ICacheItemExpiration..::..Notify	(Inherited from EmbedBase.)
	IModuleExec..::..ProcessingContext
	IModuleExec..::..SetChildException	(Inherited from BaseModule.)
	IModuleExec..::..SetInitialized	Triggers the Initialized status in the module. (Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..StartExecute	(Inherited from BaseModule.)
	ICacheItemExpiration..::..ToString

Syntax

Public Constructors

Public Methods

Protected Methods

Protected Fields

Public Properties

Protected Properties

Public Events

Explicit Interface Implementations

See Also