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 Webservice |
Visual Basic (Declaration) | Copy Code |
---|---|
Public Class Webservice |
The type exposes the following members.
Public Constructors
Name | Description | |
---|---|---|
Webservice |
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. (Inherited from Module.)Last point to add data to the Cache Signature. |
|
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. (Inherited from Module.)used to override the normal handling of the result creation. |
|
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 |
Executes the webservice request.
(Overrides Module..::Execute()()()().) |
|
ExecuteRawParameter |
Executes the data of a raw parameter.
(Inherited from Module.) |
|
ExistsBuffer |
Checks whether a local buffer exists.
(Inherited from BaseModule.) |
|
ExistsField |
Checks whether the given field exists.
(Inherited from ResultSetModule.) |
|
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.) |
|
GetBuffer |
Gets a local buffer.
(Inherited from BaseModule.) |
|
GetChildLevelResult |
Gets the result of the child levels.
(Inherited from ResultSetModule.) |
|
GetColumnCount |
Gets the number of columns in the datatable.
(Inherited from ResultSetModule.) |
|
GetColumnName |
Gets the name of the current column.
(Inherited from ResultSetModule.) |
|
GetColumnName |
Gets the name of the given column.
(Inherited from ResultSetModule.) |
|
GetColumnNumber |
Gets the number of the current column.
(Inherited from ResultSetModule.) |
|
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.) |
|
GetFieldValue |
Gets the field value of the current column in the current row, when using colformat.
(Inherited from ResultSetModule.) |
|
GetFieldValue |
Gets the field value of the field with the given index in the current row.
(Inherited from ResultSetModule.) |
|
GetFieldValue |
Gets the field value of the field with the given name in the current row.
(Inherited from ResultSetModule.) |
|
GetFieldValue |
Gets the field value of the field with the given index in the current row.
(Inherited from ResultSetModule.) |
|
GetFieldValue |
Gets the field value of the field with the given name in the current row.
(Inherited from ResultSetModule.) |
|
GetForcedResult |
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.) |
|
GetGroup |
Gets the name of the current group.
(Inherited from ResultSetModule.) |
|
GetGroupCount |
Gets the total number of groups displayed.
(Inherited from ResultSetModule.) |
|
GetGroupNumber |
Gets the number of the current group.
(Inherited from ResultSetModule.) |
|
GetGroupResult |
Gets the result of the current group.
(Inherited from ResultSetModule.) |
|
GetGroupRowNumber |
Gets the number of the current row in the current group.
(Inherited from ResultSetModule.) |
|
GetHashCode | (Inherited from Object.) | |
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.) |
|
GetLevel |
Gets the current formatting level.
(Inherited from ResultSetModule.) |
|
GetLevelResult |
Gets the result of the current level.
(Inherited from ResultSetModule.) |
|
GetLevelRowNumber |
Gets the current row of the current level.
(Inherited from ResultSetModule.) |
|
GetLocation |
Gets the location the current row points to, in a macro that can build URLs.
(Inherited from ResultSetModule.) |
|
GetParam |
Gets the value of a parameter with the given index. Useful when using the viper:exec inside xslt formatting.
(Inherited from ResultSetModule.) |
|
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.) |
|
GetRawFieldValue |
Gets the raw field value of the current column in the current row, when using colformat.
(Inherited from ResultSetModule.) |
|
GetRawFieldValue |
Gets the raw field value of the field with the given index in the current row.
(Inherited from ResultSetModule.) |
|
GetRawFieldValue |
Gets the raw field value of the field with the given name in the current row.
(Inherited from ResultSetModule.) |
|
GetRenderTime |
Returns the render time of the macro in milliseconds.
(Inherited from Module.) |
|
GetResult |
Returns the result of the macro. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
GetResult |
Returns the result of the macro. (Inherited from BaseModule.)Typically used in the ResultFormat property, to format, convert or encode the result. |
|
GetRowCount |
Gets the total number of rows in the datatable.
(Inherited from ResultSetModule.) |
|
GetRowName |
Gets the title or name represented by the current row.
(Inherited from ResultSetModule.) |
|
GetRowNumber |
Gets the current row number.
(Inherited from ResultSetModule.) |
|
GetRowNumber |
Gets the row number of the Nth parent level. Only available when using levelformat.
(Inherited from ResultSetModule.) |
|
GetRowResult |
Gets the result of the current row.
(Inherited from ResultSetModule.) |
|
GetRowTitle |
Gets the title represented by the current row.
(Inherited from ResultSetModule.) |
|
GetType | (Inherited from Object.) | |
GetVisibleRowCount |
Gets the total number of rows displayed.
(Inherited from ResultSetModule.) |
|
GetVisibleRowNumber |
Gets the current visible row number.
(Inherited from ResultSetModule.) |
|
Initialize |
Called to initialize this Module
(Inherited from BaseModule.) |
|
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. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
SetForcedResult |
Sets the result of the macro. (Inherited from Module.)used to override the normal handling of the result creation. |
|
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 macro.
(Inherited from Module.) |
|
ToString | (Inherited from Module.) |
Protected Methods
Name | Description | |
---|---|---|
Finalize | (Inherited from Object.) | |
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.) | |
SetCurrentProperty |
Sets the current property.
(Inherited from BaseModule.) |
Protected Fields
Name | Description | |
---|---|---|
DoExecute |
Specifies whether to execute the module
(Inherited from BaseModule.) |
|
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.) |
|
ResolvingSaveBuffers |
True when save buffers are evaluated.
(Inherited from BaseModule.) |
|
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.) |
|
BindingConfigurationName |
Gets or sets the name of the binding configuration.
When you specify a BindingConfigurationName, the web.config must contain a binding configuration section with that name. |
|
BindingType |
Gets or sets the type of the binding.
|
|
BufferNames |
Gets or sets the buffer names.
(Inherited from Module.) |
|
Condition |
Gets or sets the Viper expression to evaluate before actually executing the macro. (Inherited from Module.)If the expression returns false, the execution of the module and its child modules is skipped. |
|
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.) |
|
DefaultValue |
Gets or sets the default value that will be returned when the execution would otherwise return an empty string.
(Inherited from Module.) |
|
EndpointConfigurationName |
Gets or sets the name of the endpoint configuration.
When you specify an EndpointConfigurationName, the web.config must contain an (client) endpoint configuration with that name. |
|
Format |
Gets or sets the formatting Xml.
(Inherited from ResultSetModule.) |
|
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. (Inherited from BaseModule.)Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method. |
|
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.) |
|
LiteralMethodNode |
Literal body element, which will be appended to the method-node of the SoapEnvelope.
Use either this property or the MethodArguments property to specify the method arguments/parameters.
(When both properties are specified, LiteralMethodeNode will be ignored.)
|
|
LocalId |
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.) |
|
MaxReceivedMessageSize |
Gets or sets the max received message size.
If BindingConfigurationName has been specified as well, MaxReceivedMessageSize will be ignored. |
|
MaxRows |
Gets or sets a limit for the number of rows that the output may contain. (Inherited from ResultSetModule.) |
|
MethodArguments |
The method arguments.
|
|
MethodName |
The name of the webservice method that should be invoked.
It is required to either specify the MethodName or the LiteralMethodNode parameter. |
|
MethodNamespace |
The namespace to be used on the MethodName.
|
|
MethodNamespacePrefix |
The prefix to be used for the MethodNamespace.
|
|
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. (Inherited from Module.)The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context. |
|
OutputInnerText |
If true, the "innerText" of the SoapEnvelope response will be returned as result.
If false, the result should be formatted using the format-parameter.
|
|
OutputRequestEnvelope |
Outputs the request SoapEnvelope as string (debug option).
The actual request will not be executed, so there will be no response. |
|
ParametersNamespace |
The namespace to be used for the parameters/arguments inside the body element.
|
|
Password |
Gets or sets the password.
Only needed when the webservice is restricted by means of basic http authentication. |
|
Properties |
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.) |
|
RawSoapHeaders |
Gets or sets the raw (literal) SOAP headers.
|
|
ReadSchema |
Gets or sets a value indicating whether to use the option XmlReadMode.ReadSchema when reading the response into a DataSet.
This setting is only applicable when resulttype has been set to DataTable.
|
|
Remarks |
Gets or sets the remarks. Remarks have no effect on the actual execution of the module. (Inherited from BaseModule.)They only improve the readability of the code. |
|
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.) |
|
RowDelimiter |
Specifies the delimiter string that separates individual records. (Inherited from ResultSetModule.) |
|
RowFormat |
Gets or sets the formatting string. (Inherited from ResultSetModule.) |
|
SendTimeout |
Gets or sets the send timeout (in seconds).
When you need to set one of the other timeout values, use a binding configuration section and specify its name using the parameter BindingConfigurationName. |
|
SkipRows |
Specifies which row will be the first row in the output. (Inherited from ResultSetModule.) |
|
SoapAction |
The SoapAction HTTP header.
When not specified, it defaults to MethodNamespace + MethodName. |
|
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.) |
|
Url |
The url of the webservice.
|
|
UserName |
Gets or sets the name of the user.
Only needed when the webservice is restricted by means of basic http authentication. |
|
UserSetPropertyList |
Gets the user-set property list.
(Inherited from BaseModule.) |
|
Whitespace |
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.) |
|
WriteTypeAttributes |
Determines if type-information (e.g. xsi:type= 'xsd:int') should be included on the argument(s).
Defaults to true.
|
Protected Properties
Name | Description | |
---|---|---|
CurrentlyFormatting |
Returns true if currently formatting
(Inherited from ResultSetModule.) |
|
IContext |
Gets a reference to the IContext interface.
(Inherited from BaseModule.) |
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.) | |
IModuleExec..::..Initialize | (Inherited from BaseModule.) | |
IModuleExec..::..InstructionSource | (Inherited from BaseModule.) | |
ISXMLInstruction..::..Name | (Inherited from BaseModule.) | |
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.) |
See Also
Smartsite.Runtime.Modules Namespace