Index

projects/wms-framework/src/lib/baseframework/dateUtilities.ts

addDate
addDate(date, timeRange)

Adds a specified time interval to a specified date and time, yielding a new date and time.

Parameters :
Name Optional Description
date No

The first object to add.

timeRange No

The second object to add.

Returns : Date

an object that is the sum of the values of date and timeRange.

addDays
addDays(date, days)

Adds the specified number of days to the value of this instance.

Parameters :
Name Optional
date No
days No
addHours
addHours(date, hours)

Adds the specified number of hours to the value of this instance.

Parameters :
Name Optional
date No
hours No
Returns : Date

an object whose value is the sum of the date and time represented by this instance and the number of hours.

addMilliseconds
addMilliseconds(date, milliseconds)

Adds the specified number of milliseconds to the value of this instance.

Parameters :
Name Optional
date No
milliseconds No
Returns : Date

an object whose value is the sum of the date and time represented by this instance and the number of milliseconds.

addMinutes
addMinutes(date, minutes)

Adds the specified number of minutes to the value of this instance.

Parameters :
Name Optional
date No
minutes No
Returns : Date

an object whose value is the sum of the date and time represented by this instance and the number of minutes.

addMonths
addMonths(date, months)

Adds the specified number of months to the value of this instance.

Parameters :
Name Optional
date No
months No
addSeconds
addSeconds(date, seconds)

Adds the specified number of seconds to the value of this instance.

Parameters :
Name Optional
date No
seconds No
Returns : Date

an object whose value is the sum of the date and time represented by this instance and the number of seconds.

addTimeRange
addTimeRange(date, range)

Adds the value of the specified TimeRange to the value of this instance.

Parameters :
Name Optional
date No
range No
Returns : Date

an object whose value is the sum of the date and time represented by this instance and the time interval represented by range.

addYears
addYears(date, years)

Adds the specified number of years to the value of this instance.

Parameters :
Name Optional
date No
years No
Returns : Date

an object whose value is the sum of the date and time represented by this instance and the number of years.

areDatesEquals
areDatesEquals(date1, date2)

Compares two dates values to verify if they are the same

Parameters :
Name Optional Description
date1 No

The first date-argument to compare

date2 No

The second date-argument to compare

Returns : boolean

True if date values are the same otherwise false

compareDates
compareDates(date1, date2)
Parameters :
Name Optional
date1 No
date2 No
dateWithoutTime
dateWithoutTime(date)
Parameters :
Name Optional
date No
generateSeparatorCombinations
generateSeparatorCombinations()

Add new combinations based on changes in the separators: '/' or '-'

Returns : void
generateShortDateAndTimeCombinations
generateShortDateAndTimeCombinations(shortDatePattern, timePatterns)

Generate pattern combinations based on the short date pattern and time(s) pattern

Parameters :
Name Optional
shortDatePattern No
timePatterns No
Returns : void
generateShortDateDayCombinations
generateShortDateDayCombinations(shortDatePattern, timePatterns)

Generate pattern combinations based on the short date pattern and time(s) pattern where day is changed

Parameters :
Name Optional
shortDatePattern No
timePatterns No
Returns : void
generateShortDateMonthCombinations
generateShortDateMonthCombinations(shortDatePattern, timePatterns)

Generate pattern combinations based on the short date pattern and time(s) pattern where month is changed

Parameters :
Name Optional
shortDatePattern No
timePatterns No
Returns : void
generateShortDateYearCombinations
generateShortDateYearCombinations(shortDatePattern, timePatterns)

Generate pattern combinations based on the short date pattern and time(s) pattern where year is changed

Parameters :
Name Optional
shortDatePattern No
timePatterns No
Returns : void
getCurrentDateTimePatterns
getCurrentDateTimePatterns()

Returns the current formats to be used to try to parse date strings

Returns : string[]

{string[]}

getCurrentDayDateObject
getCurrentDayDateObject()
getFormatFromAlias
getFormatFromAlias(dateFormatString, globalizationHelperToUse)
Parameters :
Name Optional
dateFormatString No
globalizationHelperToUse No
Returns : string
isDate
isDate(dateString)

Verify if a given date string is a valid date or not.

Parameters :
Name Optional Description
dateString No

The date string to validate

Returns : boolean

True if the date string valid, otherwise false.

preprocessDateFormatString
preprocessDateFormatString(p2)

Does some formatting replacement needed to match TOKENS used in momentjs

Parameters :
Name Optional
p2 No
Returns : string

{string}

smFormatDate
smFormatDate(dateToFormat)

Converts the value of the current Date object to its equivalent string representation.

Parameters :
Name Optional
dateToFormat No
Returns : string

a string representation of the value of the current Date object.

smFormatDate
smFormatDate(dateToFormat, format)
Parameters :
Name Optional
dateToFormat No
format No
Returns : string
smFormatDate
smFormatDate(dateToFormat, settings)
Parameters :
Name Optional
dateToFormat No
settings No
Returns : string
smFormatDate
smFormatDate(dateToFormat, format, settings)
Parameters :
Name Optional
dateToFormat No
format No
settings No
Returns : string
smFormatDate
smFormatDate(dateToFormat, p2?: any, p3?: any)
Parameters :
Name Type Optional
dateToFormat No
p2 any Yes
p3 any Yes
Returns : string
smParseDate
smParseDate(date)

Converts the string representation of a date to its Dateequivalent by using the conventions of the current thread culture.

Parameters :
Name Optional Description
date No

String representation of a date

Returns : Date
smParseDateWithFormat
smParseDateWithFormat(date, format)
Parameters :
Name Optional
date No
format No
Returns : Date
smToShortDateString
smToShortDateString(date)

Converts the value of the current Date object to its equivalent short date string representation.

Parameters :
Name Optional Description
date No

Date to convert

Returns : string
smTryParseDate
smTryParseDate(date, result)

Converts the specified string representation of a date to its Date equivalent and returns a value that indicates whether the conversion succeeded.

Parameters :
Name Optional Description
date No

Date to parse

result No
Returns : boolean
smTryParseExactDate
smTryParseExactDate(date, format, provider: any, style: any, result)

Converts the specified char span of a date and time to its DateTime equivalent and returns a value that indicates whether the conversion succeeded.

Parameters :
Name Type Optional Description
date No

Date to convert

format No

The required format of date

provider any No

Supplies culture-specific formatting information about date

style any No

Indicate the permitted format of date

result No
Returns : boolean

true if date was converted successfully; otherwise, false.

subtractDate
subtractDate(date, timeRange)

Subtracts a specified time interval from a specified date and time and returns a new date and time.

Parameters :
Name Optional Description
date No

The date and time value to subtract from (the minuend).

timeRange No

The time interval to subtract (the subtrahend).

Returns : Date

An object whose value is the value of date minus the value of timeRange.

subtractDates
subtractDates(date1, date2)

Subtracts a specified date and time from another specified date and time and returns a time interval.

Parameters :
Name Optional Description
date1 No

The date and time value to subtract from (the minuend).

date2 No

The date and time value to subtract (the subtrahend).

Returns : TimeRange

The time interval between date1 and date1; that is, date1 minus date2.

timeOfDay
timeOfDay(date)

Gets the time of day for this instance.

Parameters :
Name Optional
date No
Returns : TimeRange

A time interval that represents the fraction of the day that has elapsed since midnight.

projects/i-components/src/lib/components/xam-grid-column/xam-grid-column.component.ts

addingPixels
addingPixels(value)

Adding pixels to value function

Parameters :
Name Optional
value No
Returns : string
colorToCSSColor
colorToCSSColor(value: any)

Color to css color function

Parameters :
Name Type Optional
value any No
Returns : string
getPropertyName
getPropertyName(setter: any)

Gets the property name from the setter

Parameters :
Name Type Optional
setter any No
Returns : string
runtimeStyleTransform
runtimeStyleTransform(setter: any)

Map silverlight properties to CSS properties

Parameters :
Name Type Optional
setter any No
Returns : Record<string, unknown>

projects/wms-framework/src/lib/utils/FlexibleJsNumberFormatter.ts

AddSeparators
AddSeparators(val)
Parameters :
Name Optional
val No
Returns : string
AddThousandsSeparators
AddThousandsSeparators(thousands: boolean, code)
Parameters :
Name Type Optional
thousands boolean No
code No
CreateTerminalFormat
CreateTerminalFormat(format)
Parameters :
Name Optional
format No
EscapeString
EscapeString(literal)
Parameters :
Name Optional
literal No
Returns : string
InjectIntoFormat
InjectIntoFormat(val, format, stuffExtras: boolean)
Parameters :
Name Type Optional
val No
format No
stuffExtras boolean No
InjectZerosFromFormat
InjectZerosFromFormat(format, i, val, j, result)
Parameters :
Name Optional
format No
i No
val No
j No
result No
LeftPad
LeftPad(val, size, ch)
Parameters :
Name Optional
val No
size No
ch No
ReverseString
ReverseString(literal)
Parameters :
Name Optional
literal No
Returns : string
RoundAwayFromZero
RoundAwayFromZero(format, code, rdigits, ldigits)
Parameters :
Name Optional
format No
code No
rdigits No
ldigits No
RoundNumber
RoundNumber(value, decimals)
Parameters :
Name Optional
value No
decimals No
Returns : number
ToScientific
ToScientific(val, ldigits, rdigits, scidigits, showsign: boolean)
Parameters :
Name Type Optional
val No
ldigits No
rdigits No
scidigits No
showsign boolean No
Returns : any
Trim
Trim(literal, ch)
Parameters :
Name Optional
literal No
ch No
Returns : string

projects/wms-framework/src/lib/regionsframework/ModuleManager.ts

addToQueue
addToQueue(obj, queue)
Parameters :
Name Optional
obj No
queue No
Returns : void

projects/wms-framework/src/lib/models/controls/XamGridColumnModel.ts

applyIgnoreCase
applyIgnoreCase(s, ignoreCase: boolean)
Parameters :
Name Type Optional
s No
ignoreCase boolean No
Returns : string

projects/wms-framework/src/lib/baseframework/datatypesUtilities.ts

applyNumericFormat
applyNumericFormat(value, format)

Applies a numeric format to the given string

Parameters :
Name Optional Description
value No

value to format

format No

format string

Returns : string

{string} the formatted value

convertToDateTime
convertToDateTime(value)

Converts a string or a Obj type DateTime format into Date, on null case it will return default MinDate.

Parameters :
Name Optional
value No
Returns : Date

{Date}

convertToFloat
convertToFloat(value: any)
Parameters :
Name Type Optional
value any No
convertToSingleCharString
convertToSingleCharString(obj, globalizationHelper?)
Parameters :
Name Optional
obj No
globalizationHelper Yes
getBytes32
getBytes32(value)
Parameters :
Name Optional
value No
isDigitCharacter
isDigitCharacter(str)
Parameters :
Name Optional
str No
Returns : boolean
isSingleCharLetterOrDigit
isSingleCharLetterOrDigit(str)
Parameters :
Name Optional
str No
isSingleLowerCaseChar
isSingleLowerCaseChar(str)
Parameters :
Name Optional
str No
Returns : boolean
isSingleUpperCaseChar
isSingleUpperCaseChar(str)
Parameters :
Name Optional
str No
Returns : boolean
parseBoolean
parseBoolean(booleanStr)

Parse an input string into a boolean value.

Parameters :
Name Optional Description
booleanStr No

The input string.

Returns : boolean

{boolean} true if the input string is 'true' (case insensitive), or false if the input string is 'false' (case insensitive).

smCompareNumbers
smCompareNumbers(n1, n2)
Parameters :
Name Optional
n1 No
n2 No
Returns : number
smDecimalGetBits
smDecimalGetBits(value)
Parameters :
Name Optional
value No
Returns : number[]
smTryParseBoolean
smTryParseBoolean(booleanStr, result)

Tries to parse an input string into a boolean value.

Parameters :
Name Optional Description
booleanStr No

The input string.

result No

The output boolean value.

Returns : boolean

{boolean} true if the parsing is successful, false otherwise.

smTryParseFloat
smTryParseFloat(numberStr, result)

Tries to parse an input string into a float value.

Parameters :
Name Optional Description
numberStr No

The input string.

result No

The output float value.

Returns : boolean

{boolean} true if the parsing is successful, false otherwise.

smTryParseInt
smTryParseInt(numberStr, result)

Tries to parse an input string into an integer value. Only decimal digits are allowed, hexadecimal digits are not allowed.

Parameters :
Name Optional Description
numberStr No

The input string.

result No

The output integer value.

Returns : boolean

{boolean} true if the parsing is successful, false otherwise.

smTryParseShort
smTryParseShort(numberStr, result)

Tries to parse an input string into an short integer value. Only decimal digits are allowed, hexadecimal digits are not allowed.

Parameters :
Name Optional Description
numberStr No

The input string.

result No

The output integer value.

Returns : boolean

{boolean} true if the parsing is successful, false otherwise.

toUpperCharacter
toUpperCharacter(str)

Converts the given string parameter to upper case.

Parameters :
Name Optional Description
str No

The string to be converted.

Returns : string

A new string with upper case applied.

projects/wms-framework/src/lib/baseframework/ReflectionSupport.ts

areEqual
areEqual(obj: any, obj2?: any)

Checks if two objects are equal using their equals() or Equals() implementation, or using === if an equality function is not available.

Parameters :
Name Type Optional
obj any No
obj2 any Yes
Returns : boolean

{boolean}

convertToBoolean
convertToBoolean(obj)

Utility function to convert an object to a boolean value

Parameters :
Name Optional
obj No
Returns : boolean

{boolean}

convertTypeTo
convertTypeTo(obj, reifiedType: any)

Function used to convert between types

Parameters :
Name Type Optional
obj No
reifiedType any No
Returns : T

{T}

defineClassCustomAttributeMetadata
defineClassCustomAttributeMetadata(att)

Decorator function to define metadata attributes for classes

Parameters :
Name Optional
att No
defineCustomAttributeMetadata
defineCustomAttributeMetadata(att)

Decorator function to define metadata attributes

Parameters :
Name Optional
att No
getAsExplicitContractForType
getAsExplicitContractForType(interfaceFullName, type: any)
Parameters :
Name Type Optional
interfaceFullName No
type any No
Returns : string
isArrayOfMetadataElements
isArrayOfMetadataElements(md: any)
Parameters :
Name Type Optional
md any No
Returns : boolean
objectHashCodeHelper
objectHashCodeHelper(obj: any)

HashCode helper NOT IMPLEMENTED

Parameters :
Name Type Optional
obj any No
Returns : number

{number}

propertyInfo
propertyInfo(interfaceOrTypeOriginalFullName?, options?)

Decorator for properties to force generating design: metadata

Parameters :
Name Optional Description
interfaceOrTypeOriginalFullName Yes
options Yes

indicates the options associated to the property info

tryToConvertType
tryToConvertType(obj, reifiedType: any)

Function used to convert type

Parameters :
Name Type Optional
obj No
reifiedType any No
Returns : T

{T}

projects/wms-framework/src/lib/utils/supportFunctions.ts

ArrayToBase64
ArrayToBase64(array)

Transform a list of byte numbers with char equivalents to a base64 string

Parameters :
Name Optional
array No
Returns : string

string

BlockCopy
BlockCopy(source, sourceOffset, destination, destinationOffset, count)

Copies the indicated amount of elements from a list starting from a specified index to another list from a specified index

Parameters :
Name Optional
source No
sourceOffset No
destination No
destinationOffset No
count No
Returns : void
clamp
clamp(value, min, max)

Limits the given value between the given minimum and maximum values (inclusive).

Parameters :
Name Optional
value No
min No
max No
Returns : number

{number}

encodeCharactersForHtml
encodeCharactersForHtml(str)
Parameters :
Name Optional
str No
Returns : string
GetBytesFromString
GetBytesFromString(str)

Get a list with the byte equivalent of the chars from the string

Parameters :
Name Optional Description
str No
  • Angular Injector
Returns : number[]

number[]

nameof
nameof(name)
Parameters :
Name Optional
name No
Returns : any
roundTo
roundTo(value, decimals)

Rounds the given value to the specified amount of decimals. Always rounds away from zero, which means that 0.05 will round to 0.1 (using 1 decimal) and -0.05 will round to -0.1.

Parameters :
Name Optional Description
value No

Value to round.

decimals No

Digits after decimal point to round to.

Returns : number

{number}

stringy
stringy(value: any, enumObj?: any)

Always returns a string. If the input is null or undefined, returns an empty string. Othewise returns the input converted to string.

Parameters :
Name Type Optional
value any No
enumObj any Yes
Returns : string

{string}

projects/wms-framework/src/lib/decorators/AsExplicitImplementation.ts

asExplicitImplementation
asExplicitImplementation(explicitInterface)

Explicit interface register decorator, in charge of associated the use of a explicit interface in a class

Parameters :
Name Optional
explicitInterface No

projects/i-components/src/lib/utils/form-data-utils.ts

boolToString
boolToString(value: boolean)

Copyright (C) Mobilize.Net info@mobilize.net - All Rights Reserved

This file is part of the Mobilize Frameworks, which is proprietary and confidential.

NOTICE: All information contained herein is, and remains the property of Mobilize.Net Corporation. The intellectual and technical concepts contained herein are proprietary to Mobilize.Net Corporation and may be covered by U.S. Patents, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Mobilize.Net Corporation.


Parameters :
Name Type Optional
value boolean No
Returns : string

projects/wms-framework/src/lib/regionsframework/directives/RegionManager.directive.ts

changeCallback
changeCallback(sender, args)
Parameters :
Name Optional
sender No
args No
Returns : void

projects/wms-framework/src/lib/basecomponentmodel/automation.ts

changeCb
changeCb()

projects/wms-framework/src/lib/regionsframework/commands/ClickActionSupport.ts

changedSetCommand
changedSetCommand(sender, args)

Callback for the set command property

Parameters :
Name Optional
sender No
args No
changedSetCommandParameter
changedSetCommandParameter(sender, args)

Callback for the command parameter property

Parameters :
Name Optional
sender No
args No
GetCommandBehavior
GetCommandBehavior(buttonBase)

Gets the command behavior associated to a button base.

Parameters :
Name Optional
buttonBase No
setClickAction
setClickAction(buttonInstance, command)

Associates a command with the click action of the given button

Parameters :
Name Optional
buttonInstance No
command No
setClickActionParameter
setClickActionParameter(buttonInstance, parameter)

Sets the click action paraemter

Parameters :
Name Optional
buttonInstance No
parameter No

projects/wms-framework/src/lib/models/events/KeyEventElements.ts

changeKeyEventHandledState
changeKeyEventHandledState(e, handledState: boolean)
Parameters :
Name Type Optional
e No
handledState boolean No
Returns : void
getModifierKeysState
getModifierKeysState()
Returns : number
translateKeyCodeToKeyEnum
translateKeyCodeToKeyEnum(keycode)
Parameters :
Name Optional
keycode No
Returns : SmKeyboardKey

projects/wms-framework/src/lib/decorators/ClassInfo.ts

ClassInfo
ClassInfo(classinfoConfig)

Registrates the ClassInfo identity class.

Parameters :
Name Optional Description
classinfoConfig No

Corresponds to the Class info configuration

Returns : any

projects/wms-framework/src/lib/baseframework/XmlSerializer.ts

collectExpectedTypeInfo
collectExpectedTypeInfo(result, typeInformation)
Parameters :
Name Optional
result No
typeInformation No
extractAllowedTypeInformation
extractAllowedTypeInformation(obj: any, prop)
Parameters :
Name Type Optional
obj any No
prop No

projects/wms-framework/src/lib/infra/Commanding.ts

commandChanged
commandChanged(sender, args)

Callback for command changed

Parameters :
Name Optional
sender No
args No

projects/wms-framework/src/lib/decorators/ComponentId.ts

ComponentId
ComponentId(ids)

Registrates the ComponentId identity of the control.

Parameters :
Name Optional Description
ids No

Corresponds to the Control's type identifiers

Returns : any

projects/wms-framework/src/lib/baseframework/StringBuilder.ts

concatStringsSequence
concatStringsSequence(separator, strings)
Parameters :
Name Optional
separator No
strings No
Returns : string
createStringWithChar
createStringWithChar(baseString, count)
Parameters :
Name Optional
baseString No
count No
endsWithWithKind
endsWithWithKind(str, strToCheck, comparisonKind)

Verifies if the str string ends with the strToCheck string using the StringComparisonKind parameter

Parameters :
Name Optional
str No
strToCheck No
comparisonKind No
escapeRegexChars
escapeRegexChars(str)

Escape regular expression characters from a common string

Parameters :
Name Optional Description
str No

string to process

removeCharsFromString
removeCharsFromString(str, start, length?)
Parameters :
Name Optional
str No
start No
length Yes
Returns : string
startsWithWithKind
startsWithWithKind(str, strToCheck, comparisonKind)
Parameters :
Name Optional
str No
strToCheck No
comparisonKind No
stringArraytoRegex
stringArraytoRegex(array)
Parameters :
Name Optional
array No
Returns : RegExp
stringInsert
stringInsert(str, idx, strToInsert)
Parameters :
Name Optional
str No
idx No
strToInsert No
Returns : string
stringNullOrWhitespace
stringNullOrWhitespace(str)
Parameters :
Name Optional
str No
stringTrimLeftChar
stringTrimLeftChar(str, charToTrim)
Parameters :
Name Optional
str No
charToTrim No
Returns : string
stringTrimRightChar
stringTrimRightChar(str, charToTrim)

Removes the specified caracters from the end of the string. If charToTrim is a string, removes just charToTrim[0] from the end of str. If charToTrim is an array of strings, removes the first character of every string in the array from the end of str.

Parameters :
Name Optional
str No
charToTrim No
Returns : string

{string}

projects/wms-framework/src/lib/decorators/Memoize.ts

configureMemoize
configureMemoize(originalMethod, memoizeArgs?)
Parameters :
Name Optional
originalMethod No
memoizeArgs Yes
Returns : any
Memoize
Memoize(args?)

Decorator to use to do memoize of functions

Parameters :
Name Optional
args Yes

projects/wms-framework/src/lib/media/color.ts

createColorFromArgb
createColorFromArgb(alpha, red, green, blue)
Parameters :
Name Optional
alpha No
red No
green No
blue No
Returns : SmColor
formatColors
formatColors(color1, color2, color3, color4)
Parameters :
Name Optional
color1 No
color2 No
color3 No
color4 No
Returns : string
smColorFromString
smColorFromString(color)
Parameters :
Name Optional
color No
Returns : SmColor
smColorToCssColor
smColorToCssColor(color)
Parameters :
Name Optional
color No
Returns : string

projects/wms-framework/src/lib/regionsframework/SimpleDIContainer.ts

createDIContainer
createDIContainer()
disposeDIContainer
disposeDIContainer(container: any)

Calls Dispose() on all instances within this container.

NOTE: this function should be called in the context of a DependencyContainer.

Parameters :
Name Type Optional
container any No
Returns : void
genericDispose
genericDispose(obj: any)
Parameters :
Name Type Optional
obj any No
initializeDIContainer
initializeDIContainer(container)
Parameters :
Name Optional
container No
injectDecoratedProperties
injectDecoratedProperties(container, obj)

Injects decorated properties to an existing object.

This function inspects an object instance and for all properties having the DIContainerDependency metadata decoration it injects a resolved object to the decorated property

Parameters :
Name Optional Description
container No

to use

obj No

object to process

Returns : T

{T}

registerInstanceWithRuntimeTypeInfo
registerInstanceWithRuntimeTypeInfo(container, typeInfo, obj: any, ltmanager?: any)

Registers a type inside a container using runtime type information

Parameters :
Name Type Optional Description
container No

injectino container

typeInfo No

runtime type information

obj any No

object to register

ltmanager any Yes

registration options

registerInstanceWithRuntimeTypeInfo
registerInstanceWithRuntimeTypeInfo(container, name, obj: any, ltmanager?: any)
Parameters :
Name Type Optional
container No
name No
obj any No
ltmanager any Yes
registerInstanceWithRuntimeTypeInfo
registerInstanceWithRuntimeTypeInfo(container, name, typeInfo, obj: any, ltmanager?: any)
Parameters :
Name Type Optional
container No
name No
typeInfo No
obj any No
ltmanager any Yes
registerInstanceWithRuntimeTypeInfo
registerInstanceWithRuntimeTypeInfo(container, p0, p1?, p2?, p3?)
Parameters :
Name Optional
container No
p0 No
p1 Yes
p2 Yes
p3 Yes
registerTypeExtended
registerTypeExtended(container, type1: any, type2: any, lifetimeManager, injectionToken?)
Parameters :
Name Type Optional
container No
type1 any No
type2 any No
lifetimeManager No
injectionToken Yes
registerTypeWithInterface
registerTypeWithInterface(container, token, typeMapInfo: any, options)

Helper function to register resolution for a type based on a interface, when the interface is registered it also is registered the type with the same RegistrationOptions

Parameters :
Name Type Optional
container No
token No
typeMapInfo any No
options No
registerWithRuntimeTypeInfo
registerWithRuntimeTypeInfo(container, typeInfo, options)
Parameters :
Name Optional
container No
typeInfo No
options No
registerWithRuntimeTypeInfo
registerWithRuntimeTypeInfo(container, typeInfo, name?, options?)
Parameters :
Name Optional
container No
typeInfo No
name Yes
options Yes
registerWithRuntimeTypeInfo
registerWithRuntimeTypeInfo(container, typeInfo, nameOrOptionsArg?, optionsArg?)
Parameters :
Name Optional
container No
typeInfo No
nameOrOptionsArg Yes
optionsArg Yes
resolveWithRuntimeTypeInfo
resolveWithRuntimeTypeInfo(container, typeInfo)
Parameters :
Name Optional
container No
typeInfo No
Returns : T
tryResolveInContainer
tryResolveInContainer(token, container)

Tries to resolve the given element in the specified container

If the class for the given injection token could not be created this funtion return null

Parameters :
Name Optional
token No
container No
Returns : T

A new instance of the object or null if the instance could not be created

projects/wms-framework/src/lib/dataService/dataServices.ts

DataServiceEntitySet
DataServiceEntitySet(entitySetMetadata)

Registrates the EntitySet class decorator.

Parameters :
Name Optional Description
entitySetMetadata No

the {

Returns : any
DataServiceKey
DataServiceKey(dataServiceKeyMetadata)

Registrates the data service key class decorator.

Parameters :
Name Optional
dataServiceKeyMetadata No
Returns : any
resetDataServiceIdCounter
resetDataServiceIdCounter()

projects/wms-framework/src/lib/basecomponentmodel/Dependency.ts

Dependency
Dependency(prop)

Dependency decorator for property which is a dependency property This decorator simplify the definition of a dependency property

Parameters :
Name Optional
prop No
Returns : any

projects/wms-framework/src/lib/baseframework/SerializationHelper.ts

deserialize
deserialize(rawObj: any, targetType: any)

Cast the received object to the targetType

Parameters :
Name Type Optional
rawObj any No
targetType any No
Returns : any

The object with the new type

deserializeErrorDetail
deserializeErrorDetail(rawObj: any, targetType: any)

Cast the received object to the targetType

Parameters :
Name Type Optional
rawObj any No
targetType any No
Returns : any

The object with the new type

deserializeStringWithTargetTypeHint
deserializeStringWithTargetTypeHint(target: any, obj, result: any)

Deserialize string object with target type hint

Parameters :
Name Type Optional
target any No
obj No
result any No
extractGenericParameterIfAvailable
extractGenericParameterIfAvailable(genericTypesInfo)

Extract generic parameter info from metadata decoration

Parameters :
Name Optional
genericTypesInfo No
getPropertyTypeWithName
getPropertyTypeWithName(properties, name)

Gets the property with the looking with the name in the PropertyInfo array

Parameters :
Name Optional
properties No
name No
Returns : any

The object of the new type

getTargetType
getTargetType(typeName)

Gets the targetType information for the corresponding typeName

Parameters :
Name Optional Description
typeName No

The type name

Returns : any

The class type

objectAsJsonObject
objectAsJsonObject(obj: any)

Creates a simple version of an object to be serialized as Json

Parameters :
Name Type Optional
obj any No
Returns : any

{*}

requiresSpecialTypeConversion
requiresSpecialTypeConversion(sourceObj: any, targetObj: any, name)

Checks if an obj is a special type and sets the correct value to be use into a serialize valued by the given name.

Parameters :
Name Type Optional Description
sourceObj any No

The object to review and convert

targetObj any No

The object that will store the processed arguments

name No

The object target json name

Returns : boolean

If the object is serialized to the target with a special serialization

requiresSpecialTypeDeserialization
requiresSpecialTypeDeserialization(rawObj: any, propInfo, result: any, fieldName)

Review if an object requires special deserialization. Knwon cases:

  • Guid
Parameters :
Name Type Optional Description
rawObj any No

Original object to be deserialized

propInfo No

Property to be checked

result any No

target object

fieldName No

Name of the property to be checked

Returns : boolean

The object with the new type

serializeObjectAsJson
serializeObjectAsJson(objectToSerialize: any)

Serializes an object as json an return the string.

Parameters :
Name Type Optional Description
objectToSerialize any No

The object to be serialized as json

Returns : string

The object serialized

tryExplicitDeserialization
tryExplicitDeserialization(obj: any, targetType: any)

Cast the received object to the corresponding type

Parameters :
Name Type Optional
obj any No
targetType any No
Returns : any

The object of the new type

tryImplicitDeserialization
tryImplicitDeserialization(obj: any, target: any, genericTypesInfo?)

Cast the received object to the corresponding type

Parameters :
Name Type Optional Description
obj any No
target any No
genericTypesInfo Yes

generic parameters informatio (if available)

tryToDeserializeArray
tryToDeserializeArray(obj: any, target: any, genericTypesInfo?)

Deserializes an array object using the corresponding target type

Parameters :
Name Type Optional Description
obj any No
target any No
genericTypesInfo Yes

information about generic parameters (if available)

Returns : any

The object with the correponding type

projects/wms-framework/src/lib/models/controls/XamGridModel.ts

findColumn
findColumn(key, data)

Find the column by key

Parameters :
Name Optional Description
key No

The key of the column to find

data No

The data to search in

Returns : XamGridColumnModel

{XamGridColumnModel} The column found

projects/wms-framework/src/lib/utils/StringFormatting.ts

formatValue
formatValue(value: any, formatString)

Apply formatting string to a single value

The formatting string is applied depending on the datatype of the value

Parameters :
Name Type Optional Description
value any No

value to format

formatString No

formatting string to apply

Returns : string

{string} the formatted value

processPlaceholder
processPlaceholder(placeholder, args)

Process a single formatting string placeholder (for example: {0}, {1}, etc)

Parameters :
Name Optional Description
placeholder No

placeholder string

args No

arguments to apply

simpleStringFormat
simpleStringFormat(format, ...args: undefined)

Provides string formatting for the given format string

Parameters :
Name Optional
format No
args No
Returns : any

{*}

projects/wms-framework/src/lib/baseframework/collections.ts

getCompareFunction
getCompareFunction(value)
Parameters :
Name Optional
value No
Returns : boolean
iuAddRange
iuAddRange(collection, newElements)

Adds the contents of an iterable to the given collection

Parameters :
Name Optional Description
collection No

to modified

newElements No

to add

iuAll
iuAll(iterable, predicate)

Verifies if a predicate is true for all the elements of an iterable

Parameters :
Name Optional Description
iterable No

sequence to verify

predicate No

predicate

iuAny
iuAny(iterable, predicate?)
Parameters :
Name Optional
iterable No
predicate Yes
iuAsEnumerable
iuAsEnumerable(iterable)
Parameters :
Name Optional
iterable No
Returns : Iterable<T>
iuCast
iuCast(iterable)
Parameters :
Name Optional
iterable No
Returns : Iterable<T>
iuConcat
iuConcat(first, second)
Parameters :
Name Optional
first No
second No
Returns : Iterable<T>
iuContains
iuContains(iterable, value, comparer?: any)

Returns whether the iterable contains a specified element.

Parameters :
Name Type Optional Description
iterable No
  • The iterable source.
value No
  • The element to find.
comparer any Yes
Returns : boolean
iuCount
iuCount(iterable, predicate?)
Parameters :
Name Optional
iterable No
predicate Yes
Returns : number
iuDistinct
iuDistinct(iterable, comparer?: any)

Returns distinct elements from the iterable.

Parameters :
Name Type Optional Description
iterable No
  • The iterable source.
comparer any Yes
Returns : Iterable<T>
iuElementAt
iuElementAt(iterable, index)
Parameters :
Name Optional
iterable No
index No
Returns : T
iuElementAtOrDefault
iuElementAtOrDefault(iterable, index)
Parameters :
Name Optional
iterable No
index No
Returns : T
iuEmpty
iuEmpty()
Returns : Iterable<T>
iuExcept
iuExcept(first, second)

Returns the set difference of two iterables.

Parameters :
Name Optional Description
first No
  • base iterable.
second No
  • the iterable to substract.
Returns : Iterable<T>
iuFirst
iuFirst(iterable, predicate?)
Parameters :
Name Optional
iterable No
predicate Yes
Returns : T
iuFirstOrDefault
iuFirstOrDefault(iterable, predicate?, defaultValue)

Returns the first element of the iterable for which predicate returns true, or a default value if the predicate returns false for every element. If no predicate is provided, returns the first element of the iterable, or a default value when the iterable is empty.

Parameters :
Name Optional
iterable No
predicate Yes
defaultValue No
Returns : T

{T}

iuForEach
iuForEach(iterable, func)

Apply an operation to each element of an Iterable

Parameters :
Name Optional Description
iterable No

iterable to process

func No

opeartion to apply

Returns : void
iuGetUntypedIterator
iuGetUntypedIterator(iterable)
Parameters :
Name Optional
iterable No
Returns : any
iuGroupBy
iuGroupBy(iterable, keySelector)
Parameters :
Name Optional
iterable No
keySelector No
Returns : Iterable<IGrouping<T, K>>
iuGroupBy
iuGroupBy(iterable, keySelector, valueSelector)
Parameters :
Name Optional
iterable No
keySelector No
valueSelector No
Returns : Iterable<IGrouping<V, K>>
iuGroupBy
iuGroupBy(iterable, keySelector, valueSelector?)
Parameters :
Name Optional
iterable No
keySelector No
valueSelector Yes
Returns : any
iuIntersect
iuIntersect(first, second, comparer?: any)

Returns the set intersection of two iterables.

Parameters :
Name Type Optional
first No
second No
comparer any Yes
Returns : Iterable<T>
iuJoin
iuJoin(iterable, iterable2, innerSelector, outerSelector, resultSelector)
Parameters :
Name Optional
iterable No
iterable2 No
innerSelector No
outerSelector No
resultSelector No
Returns : Iterable<TResult>
iuLast
iuLast(iterable, predicate?)
Parameters :
Name Optional
iterable No
predicate Yes
Returns : T
iuLastOrDefault
iuLastOrDefault(iterable, predicate?)
Parameters :
Name Optional
iterable No
predicate Yes
Returns : T
iuMax
iuMax(iterable)
Parameters :
Name Optional
iterable No
Returns : T
iuMax
iuMax(iterable, valueSelector)
Parameters :
Name Optional
iterable No
valueSelector No
Returns : K
iuMax
iuMax(iterable, valueSelector?)
Parameters :
Name Optional
iterable No
valueSelector Yes
Returns : K
iuMin
iuMin(iterable, valueSelector?)
Parameters :
Name Optional
iterable No
valueSelector Yes
iuOfType
iuOfType(iterable, type: any)
Parameters :
Name Type Optional
iterable No
type any No
Returns : Iterable<K>
iuOrderBy
iuOrderBy(iterable, criteria?)
Parameters :
Name Optional
iterable No
criteria Yes
Returns : IOrderedIterable<T>
iuOrderBy
iuOrderBy(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuOrderBy
iuOrderBy(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuOrderByDescending
iuOrderByDescending(iterable, criteria?)
Parameters :
Name Optional
iterable No
criteria Yes
Returns : IOrderedIterable<T>
iuOrderByDescending
iuOrderByDescending(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuOrderByDescending
iuOrderByDescending(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuRange
iuRange(start, count)
Parameters :
Name Optional
start No
count No
Returns : Iterable<number>
iuSelect
iuSelect(func, iterable)
Parameters :
Name Optional
func No
iterable No
Returns : Iterable<K>
iuSelectMany
iuSelectMany(func, resultSelector, iterable)
Parameters :
Name Optional
func No
resultSelector No
iterable No
Returns : Iterable<V>
iuSelectMany
iuSelectMany(func, iterable)
Parameters :
Name Optional
func No
iterable No
Returns : Iterable<K>
iuSelectMany
iuSelectMany(p1, p2, p3?)
Parameters :
Name Optional
p1 No
p2 No
p3 Yes
Returns : unknown
iuSingle
iuSingle(iterable, predicate?)
Parameters :
Name Optional
iterable No
predicate Yes
iuSingleOrDefault
iuSingleOrDefault(iterable, predicate?)

Gets a single element from the given iterable. If no predicate then the only element in iterable is returned, if more than one element then null is returned. If predicate has value then the only element matching the predicate is returned, if more than one matches or none then null is returned.

Parameters :
Name Optional Description
iterable No

The {

predicate Yes

a the predicate to apply to get the single element. If not predicate then the iterable value must contain exactly one element.

iuSum
iuSum(iterable, valueSelector)
Parameters :
Name Optional
iterable No
valueSelector No
iuTake
iuTake(count, iterable)
Parameters :
Name Optional
count No
iterable No
Returns : Iterable<T>
iuThenBy
iuThenBy(iterable, criteria?)
Parameters :
Name Optional
iterable No
criteria Yes
Returns : IOrderedIterable<T>
iuThenBy
iuThenBy(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuThenBy
iuThenBy(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuThenByDescending
iuThenByDescending(iterable, criteria?)
Parameters :
Name Optional
iterable No
criteria Yes
Returns : IOrderedIterable<T>
iuThenByDescending
iuThenByDescending(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuThenByDescending
iuThenByDescending(iterable, criteria?, comparer?)
Parameters :
Name Optional
iterable No
criteria Yes
comparer Yes
Returns : IOrderedIterable<T>
iuToArray
iuToArray(iterable)
Parameters :
Name Optional
iterable No
Returns : Array<T>
iuToList
iuToList(iterable)
Parameters :
Name Optional
iterable No
Returns : SimpleList<T>
iuUnion
iuUnion(first, second, comparer?: any)

Iterates thru the elements of two iterables by disarding the duplicated ones. Default comparison is done using the standard '===' comparison operator

Parameters :
Name Type Optional Description
first No

the iterable containing the first set of elements

second No

the iterable containing the second set of elements, the ones already in first will be discarded.

comparer any Yes

The function used to compared elements. Currently not supported.

Returns : Iterable<T>

{Iterable}

iuWhere
iuWhere(predicate, iterable)
Parameters :
Name Optional
predicate No
iterable No
Returns : Iterable<T>
joinGenerator
joinGenerator(iterable, iterable2, innerSelector, outerSelector, resultSelector)
Parameters :
Name Optional
iterable No
iterable2 No
innerSelector No
outerSelector No
resultSelector No
wrapArrayWithList
wrapArrayWithList(arr)
Parameters :
Name Optional
arr No
Returns : IList<T>

projects/wms-framework/src/lib/basecomponentmodel/Bindings/BindingUtils.ts

getCustomContext
getCustomContext(bindingInfo, contextModel)

Gets the context to use in the binding

Parameters :
Name Optional Description
bindingInfo No

the binding info object from HTML

contextModel No

the model

Returns : any

{*}

processRelativeSourceIfRequired
processRelativeSourceIfRequired(bindingInfo, newBinding)

Adds relative source element to the new binding if the BindingInfo object has information to create it

Parameters :
Name Optional Description
bindingInfo No

the binding info from HTML

newBinding No

the binding instance being constructed

projects/i-components/src/lib/components/rad-upload/rad-uag.ts

getRadUAGMessage
getRadUAGMessage(response)

Get the 'Message' value from a response.

Parameters :
Name Optional
response No
Returns : string

{string}

getRadUAGSuccess
getRadUAGSuccess(response)

Get the 'Success' value from a response.

Parameters :
Name Optional
response No
Returns : boolean

{boolean}

getRadUAGValue
getRadUAGValue(response, key)

Extract the value corresponding to the given key.

Parameters :
Name Optional
response No
key No
Returns : T

{T}

projects/wms-framework/src/lib/utils/XmlUtils.ts

json2xml
json2xml(data: any)
Parameters :
Name Type Optional
data any No
Returns : string
xml2json
xml2json(data: any)
Parameters :
Name Type Optional
data any No
Returns : any

projects/wms-framework/src/lib/utils/controlModelUtils.ts

observableFromSupportProperty
observableFromSupportProperty(element: any, propertyName)

Create an Rx Subject from a PropertyChanged object subscription

Parameters :
Name Type Optional Description
element any No

model to observe

propertyName No

property to observe

Returns : Subject<any>

{Subject} the new Subject

syncComponentAndModel
syncComponentAndModel(element, model: any)

Subscribe to runtime events for an HTML element

Parameters :
Name Type Optional
element No
model any No
Returns : any

{*}

withName
withName(obj, name)

Sets the name property if it exists

Parameters :
Name Optional
obj No
name No
Returns : T

{T}

projects/wms-framework/src/lib/basecomponentmodel/OnChange.ts

onchange
onchange()

Copyright (C) Mobilize.Net info@mobilize.net - All Rights Reserved

This file is part of the Mobilize Frameworks, which is proprietary and confidential.

NOTICE: All information contained herein is, and remains the property of Mobilize.Net Corporation. The intellectual and technical concepts contained herein are proprietary to Mobilize.Net Corporation and may be covered by U.S. Patents, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Mobilize.Net Corporation.


Returns : any

projects/wms-framework/src/lib/utils/RefOrOut.ts

out
out(setter)

Creates a RefOrOut instance for out arguments.

Parameters :
Name Optional Description
setter No

The function to call to set the value.

Returns : out<T>

{out} A new instance of RefOrOut for out arguments.

ref
ref(value, setter)

Creates a RefOrOut instance for ref arguments.

Parameters :
Name Optional Description
value No

The value to be modified.

setter No

The function to call to set the value.

Returns : ref<T>

{ref} A new instance of RefOrOut for ref arguments.

projects/wms-framework/src/lib/models/controls/ContainerEnums.ts

parse
parse(input)

Parse the input string and returns the equivalent vertical alignment, or undefined if there is no equivalent.

Parameters :
Name Optional
input No
Returns : VerticalAlignment
parse
parse(input)

Parse the input string and returns the equivalent horizontal alignment, or undefined if there is no equivalent.

Parameters :
Name Optional
input No
parse
parse(input)

Parse the input string and returns the equivalent visibility: true for 'Visible' and false for 'Collapsed'.

Parameters :
Name Optional
input No
Returns : boolean
toString
toString(verticalAlignment)

Returns a string representation of the vertical alignment.

Parameters :
Name Optional
verticalAlignment No
Returns : string
toString
toString(horizontalAlignment)

Returns a string representation of the horizontal alignment.

Parameters :
Name Optional
horizontalAlignment No
Returns : string
toString
toString(visibility: boolean)

Returns a string representation of the visibility.

Parameters :
Name Type Optional
visibility boolean No
Returns : string

projects/wms-framework/src/lib/models/enums/OpenMode.ts

parseEnumValue
parseEnumValue(value, typeEnum: any)

Retrieves the value of a given enum by parsing the string

Parameters :
Name Type Optional
value No
typeEnum any No
Returns : number

projects/wms-framework/src/lib/baseframework/Regex/RegexOptions.ts

processFlagToString
processFlagToString(value, inputStr, regexOption, strEquivalent)

Process RegexOptions to generate required flags in RegExp

Parameters :
Name Optional
value No
inputStr No
regexOption No
strEquivalent No
toString
toString(regexOptions)

Returns a string representation of the regex options.

Parameters :
Name Optional
regexOptions No
Returns : string

projects/wms-framework/src/lib/utils/StyleFunctions.ts

setBackgroundColor
setBackgroundColor(styleObject, value: any)

setBackgroundColor

Parameters :
Name Type Optional
styleObject No
value any No
Returns : void
setForeground
setForeground(styleObject, value: any)

SetForeground

Parameters :
Name Type Optional
styleObject No
value any No
Returns : void
setStyleProperty
setStyleProperty(context: any, value: any, property)

SetStyleProperty

Parameters :
Name Type Optional
context any No
value any No
property No
Returns : void
transformStyles
transformStyles(styleObject: any, styleCss: any)

TransFormStyles

Parameters :
Name Type Optional
styleObject any No
styleCss any No
Returns : void

projects/wms-framework/src/lib/baseframework/Exceptions.ts

smGetExceptionInstance
smGetExceptionInstance(e: any)

Tries to generate an Exception object out of the 'e' parameter, parameter might be an Exception so it will be returned or most likely might be an Error type, in such case it will create a new Exception containing e as innerError

Parameters :
Name Type Optional
e any No
Returns : Exception

{Exception}

projects/wms-framework/src/lib/wcfserviceinvocationsupport/SoapMetadata.ts

SoapEntity
SoapEntity(soapMetadata)

Registrates the SoapEntity class decorator.

Parameters :
Name Optional Description
soapMetadata No

the {

Returns : any

projects/i-components/src/lib/decorators/stopEventPropagation.ts

stopEventPropagation
stopEventPropagation()

Copyright (C) Mobilize.Net info@mobilize.net - All Rights Reserved

This file is part of the Mobilize Frameworks, which is proprietary and confidential.

NOTICE: All information contained herein is, and remains the property of Mobilize.Net Corporation. The intellectual and technical concepts contained herein are proprietary to Mobilize.Net Corporation and may be covered by U.S. Patents, and are protected by trade secret or copyright law. Dissemination of this information or reproduction of this material is strictly forbidden unless prior written permission is obtained from Mobilize.Net Corporation.


projects/wms-framework/src/lib/baseframework/typeconversion.ts

toByte
toByte(value, base)

Converts a string to a number with Byte limits.

Parameters :
Name Optional
value No
base No
toInt32
toInt32(value: any, objectType: any)

Converts a string value to a number with built-in support or Int32.

Parameters :
Name Type Optional
value any No
objectType any No
Returns : number

Returns the number value. If the value cannot be converted, an exception is throw.

projects/wms-framework/src/lib/models/controls/ToolTipService.ts

ToolTipCallback
ToolTipCallback(sender, args)

Should trigger the action in the component that will enable the Tooltip to be dinamically displayed

Parameters :
Name Optional
sender No
args No

projects/wms-framework/src/lib/models/controls/ContextMenuService.ts

XamContextCallBack
XamContextCallBack(sender, args)

Should trigger the action in the component that will enable the CtxMenu to be dinamically displayed

Parameters :
Name Optional
sender No
args No

projects/wms-framework/src/lib/xml/xmlclasses.ts

xElementsFromSequence
xElementsFromSequence(sequence, name?)

Gets elements from sequence

Parameters :
Name Optional
sequence No
name Yes
Returns : Iterable<XElement>

{Iterable}

xRemoveElementsFromSequence
xRemoveElementsFromSequence(sequence)

Removes all specified elements from its parent node

Parameters :
Name Optional
sequence No
Returns : void

result-matching ""

    No results matching ""