Smartsite Documentatie > Advanced > Developer > Class Library Reference > Smartsite.Runtime.Modules Namespace > LocaleModule Class > LocaleModule Methods
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 sealed class LocaleModule
Visual Basic (Declaration) Copy imageCopy Code 
                                  Public NotInheritable Class LocaleModule

The type exposes the following methods.

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 Static member CalculateAge
Formats the time difference between two dates as a userfriendly string in the given locale.
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
Sets the render culture to the original culture;
(Overrides Module..::EndExecute()()()().)
Public method Equals (Inherited from Object.)
Public method EvaluatePropertyExpression
Evaluates an expression in a property with Expression Syntax
(Inherited from Module.)
Public method Execute
Sets the render culture to the given culture and continues rendering.
(Overrides ContainerModule..::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 Find
Finds the specified child module.
(Inherited from BaseModule.)
Public method FindExtension
Finds an extension macro.
(Inherited from BaseModule.)
Public method Static member Flush
Flushes the cached string resources.
Public method Static member FormatAge Overloaded.
Public method Static member FormatCurrency Overloaded.
Public method Static member FormatDateTime Overloaded.
Public method Static member FormatDateTimeCustom Overloaded.
Public method Static member FormatLongDate Overloaded.
Public method Static member FormatLongDateLongTime Overloaded.
Public method Static member FormatLongDateShortTime Overloaded.
Public method Static member FormatLongTime Overloaded.
Public method Static member FormatNumber Overloaded.
Public method Static member FormatNumberCustom Overloaded.
Public method Static member FormatShortDate Overloaded.
Public method Static member FormatShortDateTime Overloaded.
Public method Static member FormatShortTime Overloaded.
Public method Static member FormatString
Formats the specified string/number into the specified format in the current culture.
Public method Static member FormatStringForCulture
Formats the specified string/number into the specified format.
Public method Static member FormatTimeSpan Overloaded.
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 Static member GetCulture Overloaded.
Public method Static member GetCultureFromChannel
Gets the culture from the current channel.
Public method Static member GetCultureFromUser
Gets the culture from the user's profile.
Public method Static member GetCultureFromUserAgent
Gets the culture from the user agent's headers
Public method Static member GetDisplayName Overloaded.
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 GetForcedResult
Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult().
(Inherited from Module.)
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 Static member GetKey
Returns the resource key associated with the given resource value in the default culture. Returns null if no match was found.
Public method Static member GetLCID Overloaded.
Public method Static member GetName Overloaded.
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 Static member GetParent Overloaded.
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 Static member GetSetupFromDatabase
Returns the localization string resources for the specified application, as present in the CMS database.
Public method Static member GetSetupFromItem
Returns the localization string resources found in the XML of the specified item.
Public method Static member GetString Overloaded.
Public method Static member GetStringForCulture Overloaded.
Public method GetType (Inherited from Object.)
Public method Static member GetWeekOfYear Overloaded.
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 Static member IsResourceIdentifier
Tests if the supplied string is a resource identifier.
Public method Static member Localize Overloaded.
Public method Static member LocalizeForCulture Overloaded.
Public method Static member MonthName Overloaded.
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 Static member SetLocale Overloaded.
Public method Static member Setup
Performs a setup of the localization by synchronizing resource strings from an XML source to the database.
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.)
Public method Static member Translate Overloaded.
Public method Static member TranslateForCulture Overloaded.
Public method Static member WeekdayName Overloaded.

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.)

Explicit Interface Implementations

  Name Description
Explicit interface implemetation Private method IModuleExec..::..Cancel (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..FinishExecute (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..Initialize (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetChildException (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetInitialized
Triggers the Initialized status in the module.
(Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetProperty (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..SetProperty (Inherited from BaseModule.)
Explicit interface implemetation Private method IModuleExec..::..StartExecute (Inherited from BaseModule.)

See Also

Advanced