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 Webservice
Visual Basic (Declaration) Copy imageCopy Code
                                  Public Class Webservice

The type exposes the following members.

Public Constructors

  Name Description
Public method Webservice

Public Methods

  Name Description
Public method AddAIMRelation
Adds an item to the AIM relations collection.
(Inherited from Module.)
Public method ApplyProperties
Applies the properties from the SXML processing environment into the current module.
(Inherited from BaseModule.)
Public method BeginExecute
Override this to execute code before Execute() is fired.
Last point to add data to the Cache Signature.
(Inherited from Module.)
Public method Capture
Passes an SXML subtree to the current module.
(Inherited from BaseModule.)
Public method CheckTimeout
Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()().
(Inherited from BaseModule.)
Public method ClearForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method Dispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from BaseModule.)
Public method DoPreparse
Check whether to preparse data in the given property.
(Inherited from BaseModule.)
Public method DoRecurseTag
Determines whether to recurse on a given tag
Public method EndExecute
Override this to execute code after Execute() is fired.
(Inherited from Module.)
Public method Equals (Inherited from Object.)
Public method EvaluatePropertyExpression
Evaluates an expression in a property with Expression Syntax
(Inherited from Module.)
Public method Execute
Executes the webservice request.
(Overrides Module..::Execute()()()().)
Public method ExecuteRawParameter
Executes the data of a raw parameter.
(Inherited from Module.)
Public method ExistsBuffer
Checks whether a local buffer exists.
(Inherited from BaseModule.)
Public method ExistsField
Checks whether the given field exists.
(Inherited from ResultSetModule.)
Public method Find
Finds the specified child module.
(Inherited from BaseModule.)
Public method FindExtension
Finds an extension macro.
(Inherited from BaseModule.)
Public method GetAIMRelations
Gets a list of all outgoing AIM relations created by the macro.
(Inherited from BaseModule.)
Public method GetBuffer
Gets a local buffer.
(Inherited from BaseModule.)
Public method GetChildLevelResult
Gets the result of the child levels.
(Inherited from ResultSetModule.)
Public method GetColumnCount
Gets the number of columns in the datatable.
(Inherited from ResultSetModule.)
Public method GetColumnName
Gets the name of the current column.
(Inherited from ResultSetModule.)
Public method GetColumnName
Gets the name of the given column.
(Inherited from ResultSetModule.)
Public method GetColumnNumber
Gets the number of the current column.
(Inherited from ResultSetModule.)
Public method GetException
Returns the text message of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetExceptionSmartsiteCode
Returns the Smartsite Error code of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetExceptionString
Returns the full information of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.)
Public method GetExceptionType
Returns the full Type name of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetFieldValue
Gets the field value of the current column in the current row, when using colformat.
(Inherited from ResultSetModule.)
Public method GetFieldValue
Gets the field value of the field with the given index in the current row.
(Inherited from ResultSetModule.)
Public method GetFieldValue
Gets the field value of the field with the given name in the current row.
(Inherited from ResultSetModule.)
Public method GetFieldValue
Gets the field value of the field with the given index in the current row.
(Inherited from ResultSetModule.)
Public method GetFieldValue
Gets the field value of the field with the given name in the current row.
(Inherited from ResultSetModule.)
Public method GetForcedResult
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.)
Public method GetGroup
Gets the name of the current group.
(Inherited from ResultSetModule.)
Public method GetGroupCount
Gets the total number of groups displayed.
(Inherited from ResultSetModule.)
Public method GetGroupNumber
Gets the number of the current group.
(Inherited from ResultSetModule.)
Public method GetGroupResult
Gets the result of the current group.
(Inherited from ResultSetModule.)
Public method GetGroupRowNumber
Gets the number of the current row in the current group.
(Inherited from ResultSetModule.)
Public method GetHashCode (Inherited from Object.)
Public method GetInnerException
Returns the text message of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetInnerExceptionSmartsiteCode
Returns Smartsite error code of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetInnerExceptionString
Returns the full information of the inner exception of the exception that has occurred, including the stack trace.
(Inherited from BaseModule.)
Public method GetInnerExceptionType
Returns the full Type name of the inner exception of the exception that has occurred.
(Inherited from BaseModule.)
Public method GetLevel
Gets the current formatting level.
(Inherited from ResultSetModule.)
Public method GetLevelResult
Gets the result of the current level.
(Inherited from ResultSetModule.)
Public method GetLevelRowNumber
Gets the current row of the current level.
(Inherited from ResultSetModule.)
Public method GetLocation
Gets the location the current row points to, in a macro that can build URLs.
(Inherited from ResultSetModule.)
Public method GetParam
Gets the value of a parameter with the given index. Useful when using the viper:exec inside xslt formatting.
(Inherited from ResultSetModule.)
Public method GetParameter
Gets the value of the given parameter/property.
(Inherited from BaseModule.)
Public method GetParameter
Gets the value of the given parameter/property.
(Inherited from BaseModule.)
Public method GetParent
Gets the parent Module of this module.
(Inherited from BaseModule.)
Public method GetParent
Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off).
(Inherited from BaseModule.)
Public method GetRawFieldValue
Gets the raw field value of the current column in the current row, when using colformat.
(Inherited from ResultSetModule.)
Public method GetRawFieldValue
Gets the raw field value of the field with the given index in the current row.
(Inherited from ResultSetModule.)
Public method GetRawFieldValue
Gets the raw field value of the field with the given name in the current row.
(Inherited from ResultSetModule.)
Public method GetRenderTime
Returns the render time of the macro in milliseconds.
(Inherited from Module.)
Public method GetResult
Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
(Inherited from BaseModule.)
Public method GetResult
Returns the result of the macro.
Typically used in the ResultFormat property, to format, convert or encode the result.
(Inherited from BaseModule.)
Public method GetRowCount
Gets the total number of rows in the datatable.
(Inherited from ResultSetModule.)
Public method GetRowName
Gets the title or name represented by the current row.
(Inherited from ResultSetModule.)
Public method GetRowNumber
Gets the current row number.
(Inherited from ResultSetModule.)
Public method GetRowNumber
Gets the row number of the Nth parent level. Only available when using levelformat.
(Inherited from ResultSetModule.)
Public method GetRowResult
Gets the result of the current row.
(Inherited from ResultSetModule.)
Public method GetRowTitle
Gets the title represented by the current row.
(Inherited from ResultSetModule.)
Public method GetType (Inherited from Object.)
Public method GetVisibleRowCount
Gets the total number of rows displayed.
(Inherited from ResultSetModule.)
Public method GetVisibleRowNumber
Gets the current visible row number.
(Inherited from ResultSetModule.)
Public method Initialize
Called to initialize this Module
(Inherited from BaseModule.)
Public method IsChildOf
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.)
Public method ParameterExists
Checks whether the given parameter/property is set.
(Inherited from BaseModule.)
Public method PreInitialize
Called just before initialization of the module
(Inherited from Module.)
Public method ReadyExecuting
Method that is called after the module has executed.
(Inherited from Module.)
Public method ScopeTerminated
Executed when the module is about to get out of scope.
(Inherited from BaseModule.)
Public method SetBuffer
Sets a local buffer.
(Inherited from BaseModule.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method SetForcedResult
Sets the result of the macro.
used to override the normal handling of the result creation.
(Inherited from Module.)
Public method TestCondition
Tests whether execution should take place based on the expression in the condition property
(Inherited from Module.)
Public method TestPropertyExpression
Tests whether an expression in a property with Expression Syntax evaluates to true.
(Inherited from Module.)
Public method ThrowCurrentException
Makes Smartsite throw the current exception.
(Inherited from BaseModule.)
Public method ThrowInnerException
Makes Smartsite throw the inner exception.
(Inherited from BaseModule.)
Public method ToString
Returns a string that represents the current macro.
(Inherited from Module.)
Public method ToString
Returns a String that represents the current Object.
(Inherited from Module.)

Protected Methods

  Name Description
Protected method Finalize (Inherited from Object.)
Protected method IsBufferName
Determines whether the data is a buffer name.
(Inherited from Module.)
Protected method IsSingleSaveBuffername
Determines whether a single save buffername is used.
(Inherited from Module.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method SetCurrentProperty
Sets the current property.
(Inherited from BaseModule.)

Protected Fields

  Name Description
Protected field DoExecute
Specifies whether to execute the module
(Inherited from BaseModule.)
Protected field InternalAIMMode
Cotnains the internal AIM mode.
(Inherited from Module.)
Protected field InternalCopyFormatting
The id of the macro to copy the formatting settings from.
(Inherited from Module.)
Protected field InternalFormatting
Formatting settings.
(Inherited from Module.)
Protected field ResolvingSaveBuffers
True when save buffers are evaluated.
(Inherited from BaseModule.)
Protected field 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
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 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.
Public property BindingType
Gets or sets the type of the binding.
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 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 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.
Public property Format
Gets or sets the formatting Xml.
(Inherited from ResultSetModule.)
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 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 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 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.)
Public property LocalId
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.)
Public property MaxReceivedMessageSize
Gets or sets the max received message size.
If BindingConfigurationName has been specified as well, MaxReceivedMessageSize will be ignored.
Public property MaxRows
Gets or sets a limit for the number of rows that the output may contain.
(Inherited from ResultSetModule.)
Public property MethodArguments
The method arguments.
Public property MethodName
The name of the webservice method that should be invoked.
It is required to either specify the MethodName or the LiteralMethodNode parameter.
Public property MethodNamespace
The namespace to be used on the MethodName.
Public property MethodNamespacePrefix
The prefix to be used for the MethodNamespace.
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 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 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.
Public property OutputRequestEnvelope
Outputs the request SoapEnvelope as string (debug option).
The actual request will not be executed, so there will be no response.
Public property ParametersNamespace
The namespace to be used for the parameters/arguments inside the body element.
Public property Password
Gets or sets the password.
Only needed when the webservice is restricted by means of basic http authentication.
Public property Properties
Gets the full list of properties as set when executing the module.
(Inherited from BaseModule.)
Public property RawSoapHeaders
Gets or sets the raw (literal) SOAP headers.
Public property 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.
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 RowDelimiter
Specifies the delimiter string that separates individual records.
(Inherited from ResultSetModule.)
Public property RowFormat
Gets or sets the formatting string.
(Inherited from ResultSetModule.)
Public property 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.
Public property SkipRows
Specifies which row will be the first row in the output.
(Inherited from ResultSetModule.)
Public property SoapAction
The SoapAction HTTP header.
When not specified, it defaults to MethodNamespace + MethodName.
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 Url
The url of the webservice.
Public property UserName
Gets or sets the name of the user.
Only needed when the webservice is restricted by means of basic http authentication.
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 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
Protected property CurrentlyFormatting
Returns true if currently formatting
(Inherited from ResultSetModule.)
Protected property IContext
Gets a reference to the IContext interface.
(Inherited from BaseModule.)

Public Events

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

Explicit Interface Implementations

See Also

Advanced