|
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 sealed class DateTimeViperMethods
|
|
| Visual Basic (Declaration) |
Copy Code
|
|---|---|
Public NotInheritable Class DateTimeViperMethods
|
|
The type exposes the following members.
Public Methods
| Name | Description | |
|---|---|---|
|
AddAIMRelation |
Adds an item to the AIM relations collection.
(Inherited from Module.) |
|
AddDays |
Adds the specified number of days to the value of the given DateTime.
|
|
|
AddHours |
Adds the specified number of hours to the value of the given DateTime.
|
|
|
AddMilliseconds |
Adds the specified number of milliseconds to the value of the given DateTime.
|
|
|
AddMinutes |
Adds the specified number of minutes to the value of the given DateTime.
|
|
|
AddMonths |
Adds the specified number of months to the value of the given DateTime.
|
|
|
AddSeconds |
Adds the specified number of seconds to the value of the given DateTime.
|
|
|
AddYears |
Adds the specified number of years to the value of the given DateTime.
|
|
|
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. |
|
|
CalculateAge | Overloaded. |
|
|
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. |
|
|
DaysBetween |
Returns the number of whole and fractional days between two given DateTime values.
|
|
|
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 Module.) |
|
|
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.) |
|
|
GetBuffer |
Gets a local buffer.
(Inherited from BaseModule.) |
|
|
GetDate | Overloaded. |
|
|
GetDay | Overloaded. |
|
|
GetDayOfWeek | Overloaded. |
|
|
GetDayOfYear | Overloaded. |
|
|
GetDaysInMonth |
Returns the number of days in the specified month and year.
|
|
|
GetDaysInYear |
Returns the number of days in the specified year.
|
|
|
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.) |
|
|
GetForcedResult |
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.) |
|
|
GetHashCode | (Inherited from Object.) |
|
|
GetHours | Overloaded. |
|
|
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.) |
|
|
GetMilliSeconds | Overloaded. |
|
|
GetMinutes | Overloaded. |
|
|
GetMonth | Overloaded. |
|
|
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.) |
|
|
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. |
|
|
GetSeconds | Overloaded. |
|
|
GetType | (Inherited from Object.) |
|
|
GetUtcOffset | Overloaded. |
|
|
GetYear | Overloaded. |
|
|
HoursBetween |
Returns the number of whole and fractional hours between two given DateTime values.
|
|
|
Initialize |
Called to initialize this Module
(Inherited from BaseModule.) |
|
|
IsChildOf |
Determines whether the module is a descendant of the given parent
(Inherited from BaseModule.) |
|
|
IsDaylightSavingTime |
Indicates whether the given DateTime value is within the Daylight Saving Time range for the current time zone.
|
|
|
IsLeapYear |
Determines whether the specified year is a leap year.
|
|
|
IsLocalTime |
Determines whether the time represented by the given DateTime is based on local time.
|
|
|
IsToday |
Determines whether the specified date is today.
|
|
|
IsUniversalTime |
Determines whether the time represented by the given DateTime is based on universal time.
|
|
|
IsUnspecifiedTimeZone |
Determines whether the time represented by the given DateTime is based on an unspecified time zone.
|
|
|
MillisecondsBetween |
Returns the number of whole and fractional milliseconds between two given DateTime values.
|
|
|
MinutesBetween |
Returns the number of whole and fractional minutes between two given DateTime values.
|
|
|
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.) |
|
|
SecondsBetween |
Returns the number of whole and fractional seconds between two given DateTime values.
|
|
|
SetBuffer |
Sets a local buffer.
(Inherited from BaseModule.) |
|
|
SetDate |
Sets the date components of the given DateTime.
|
|
|
SetDay |
Sets the day component of the given DateTime.
|
|
|
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. |
|
|
SetHours |
Sets the hour component of the given DateTime.
|
|
|
SetMilliSeconds |
Sets the milliseconds component of the given DateTime.
|
|
|
SetMinutes |
Sets the minutes component of the given DateTime.
|
|
|
SetMonth |
Sets the month component of the given DateTime.
|
|
|
SetSeconds |
Sets the seconds component of the given DateTime.
|
|
|
SetTime |
Sets the time components of the given DateTime.
|
|
|
SetYear |
Sets the year component of the given DateTime.
|
|
|
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.) |
|
|
ToIsoString |
Converts the value of the given DateTime to the equivalent string representation specified by the ISO-8601 standard ("yyyy-MM-ddTHH:mm:ss").
|
|
|
ToLocalTime |
Converts the value of the given DateTime object to local time.
|
|
|
ToRfcString |
Converts the value of the given DateTime to the equivalent string representation specified by the RFC1123 standard ("ddd, dd MMM yyyy HH:mm:ss GMT").
|
|
|
ToString |
Returns a string that represents the current macro.
(Inherited from Module.) |
|
|
ToString | (Inherited from Module.) |
|
|
ToUniversalTime |
Converts the value of the given DateTime object to universal time.
|
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.) |
|
|
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.) |
|
|
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.) |
|
|
LocalId |
Gets or sets the local id of the macro in the current buffer scope.
(Inherited from Module.) |
|
|
MaxValue |
Represents the largest possible value of DateTime.
|
|
|
MinimumAccessTypeLevel |
Friendly name of the minimum access type level required by the site visitor to execute this macro.
(Inherited from Module.) |
|
|
MinValue |
Represents the smallest possible value of DateTime.
|
|
|
ModuleInfo |
Gets the module info.
(Inherited from BaseModule.) |
|
|
Now |
Returns the current date and time in short time string representation.
|
|
|
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. |
|
|
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. (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.) |
|
|
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.) |
|
|
Today |
Returns the current date.
|
|
|
Trim |
Gets a value indicating how the whitespace is trimmed.
(Inherited from BaseModule.) |
|
|
TypeName |
Gets the name of the Module type.
(Inherited from BaseModule.) |
|
|
UserSetPropertyList |
Gets the user-set property list.
(Inherited from BaseModule.) |
|
|
UtcNow |
Returns the current date and time expressed as Coordinated Universal Time (UTC) in short time string representation.
|
|
|
Whitespace |
Gets a value indicating whether to preserve whitespace.
(Inherited from BaseModule.) |
Protected Properties
| Name | Description | |
|---|---|---|
|
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.) |