@mobilize/wms-components documentation
  1. Miscellaneous
  2. Variables

Index

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

applyStringFormat
Default value : (binding: Binding, value: any) => { if (binding.StringFormat) { try { if (binding.StringFormat.indexOf('{') == -1) { value = simpleStringFormat('{0:' + binding.StringFormat + '}', value); } else { value = simpleStringFormat(binding.StringFormat, value); } } catch {} } return value; }

If a StringFormat is defined then it tries to apply it, this should be done before conversion to a target type
calculateBindingValue
Default value : ( binding: Binding, outerContext: any, dependencyProperty: DependencyProperty ) => { let value = binding.Path.getValueFromContextObject(outerContext); if (typeof value === 'undefined') { return; } if (binding.Converter?.Convert) { value = binding.Converter.Convert(value, null, binding.ConverterParameter); value = applyStringFormat(binding, value); } else if (dependencyProperty.propertyType) { try { value = applyStringFormat(binding, value); value = Convert.ChangeType(value, dependencyProperty.propertyType); } catch (e) { console.log('Error adapting type to dependency property: ' + e); } } else { value = applyStringFormat(binding, value); } return value; }

Calculates the binding value using the given outerContext
createBindingFromBindingInfo
Default value : ( bindingInfo: BindingInfo, contextModel: FrameworkElement ) => { const newBinding = new Binding(bindingInfo.bindingPath); let resourceParent: any = null; if ( typeof bindingInfo.resourceParent !== 'undefined' && bindingInfo.resourceParent.getApplicationResource ) { resourceParent = bindingInfo.resourceParent; } else { resourceParent = contextModel; } newBinding.Mode = bindingInfo.twoWay === true ? BindingMode.TwoWay : BindingMode.OneWay; newBinding.Converter = typeof bindingInfo.converterKey == 'string' ? resourceParent.getApplicationResource(bindingInfo.converterKey) : null; newBinding.ConverterParameter = (typeof bindingInfo.converterParameterKey == 'string' ? resourceParent.getApplicationResource(bindingInfo.converterParameterKey) : bindingInfo.converterParameter) ?? null; newBinding.CustomContext = getCustomContext(bindingInfo, contextModel); newBinding.Source = typeof bindingInfo.resourceKey == 'string' ? resourceParent.getApplicationResource(bindingInfo.resourceKey) : null; newBinding.ElementInstance = bindingInfo.elementInstance; newBinding.ValidatesOnDataErrors = bindingInfo.validatesOnDataErrors === true; newBinding.ValidatesOnExceptions = bindingInfo.validatesOnExceptions === true; if (typeof bindingInfo.validatesOnNotifyDataErrors !== 'undefined') { newBinding.ValidatesOnNotifyDataErrors = bindingInfo.validatesOnNotifyDataErrors === true; } newBinding.NotifyOnValidationError = bindingInfo.notifyOnValidationError === true; newBinding.StringFormat = bindingInfo.stringFormat ?? null; processRelativeSourceIfRequired(bindingInfo, newBinding); return newBinding; }

Creates a Binding instance from a BindingInfo object
getResourceKeyValue
Default value : ( value: any, contextModel: FrameworkElement ) => { const resourceContext = value?.resourceParent?.getApplicationResource ? value.resourceParent : contextModel; return resourceContext.getResourceByKey(value.resourceKey); }

Gets the value identified by the given resource key.
isResourceKeyValue
Default value : (value: any) => { if (!value) { return false; } return typeof value.resourceKey === 'string'; }

Checks if the given value is a resource key one. Resource key values are of the form { resourceKey: myResource}
registerPendingMappingsForComponent
Default value : ( bindingsToRegister: [DependencyProperty, BindingInfo][], contextModel: FrameworkElement ) => { try { contextModel.IsInitializingBindings = true; for (const [prop, bindingInfo] of bindingsToRegister) { const newBinding = createBindingFromBindingInfo( bindingInfo, contextModel ); contextModel.SetBinding(prop, newBinding); } } finally { contextModel.IsInitializingBindings = false; } }

Registeres a collection of property vs. bindings

This function creates instances of Binding from BindingInfo instance
registerPendingSetValues
Default value : ( pendingSetValues: [DependencyProperty, any][], contextModel: FrameworkElement ) => { for (const [prop, value] of pendingSetValues) { setDependencyPropertyValue(prop, value, contextModel); } }

Registeres a collection of property vs. values

This function is in charge of process pending values to assign to a given contextModel
resolveBindingContext
Default value : ( binding: Binding, model: DependencyObject ) => { return ( binding.CalculateRelativeSource(model) ?? binding.Source ?? binding.ElementInstance ?? (<any>model).DataContext ?? binding.CustomContext ); }

Resolves the binding context to be used to resolve the binding
setDependencyPropertyValue
Default value : ( property: DependencyProperty, value: any, contextModel: FrameworkElement ) => { const oldInitializationFlagValue = contextModel.IsInitializingBindings; try { contextModel.IsInitializingBindings = true; let processValue: any = null; if (typeof value === 'object' && value.bindingPath) { processValue = createBindingFromBindingInfo(value, contextModel); contextModel.SetBinding(property, processValue); return; } else if (isResourceKeyValue(value)) { processValue = getResourceKeyValue(value, contextModel); } else { processValue = value; } contextModel.setValue(property, processValue); } finally { contextModel.IsInitializingBindings = oldInitializationFlagValue; } }

Set dependency property value

This function is in charge of process a value to assign from a given contextModel

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

automationIdProperty
Default value : new DependencyProperty( 'AutomationId', '', changeCb )

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

changeWeakReferenceConfiguration
Default value : (weakRefType: any) => { weakReferencesSupported = typeof weakRefType !== 'undefined'; WeakRefActualType = weakRefType; }

Exported function to customize the weak reference configuration (exported for testing)
WeakRefActualType
Default value : (window as any).WeakRef as new ( obj: any ) => WeakRef<any>

Internal constant to access weak references
weakReferencesSupported
Default value : typeof WeakRefActualType !== 'undefined'

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

clickActionParameterProperty
Type : DependencyProperty
Default value : new DependencyProperty( 'clickActionParameter', null, changedSetCommandParameter )

Click action parameter property object
clickActionProperty
Type : DependencyProperty
Default value : new DependencyProperty( 'clickAction', null, changedSetCommand )

Click action property object
clickCommandBehaviorProperty
Type : DependencyProperty
Default value : new DependencyProperty('clickCommandBehavior', null, null)

Click command behavior property object

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

containerInjectionToken
Type : string
Default value : 'Microsoft.Practices.Unity.IUnityContainer'

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.
eventAggregatorInjectionToken
Type : string
Default value : 'Microsoft.Practices.Prism.Events.IEventAggregator'
moduleCatalogInjectionToken
Type : string
Default value : 'Microsoft.Practices.Prism.Modularity.IModuleCatalog'
moduleManagerInjectionToken
Type : string
Default value : 'Microsoft.Practices.Prism.Modularity.IModuleManager'
regionBehaviorFactoryInjectionToken
Type : string
Default value : 'Microsoft.Practices.Prism.Regions.IRegionBehaviorFactory'
regionManagerInjectionToken
Type : string
Default value : 'Microsoft.Practices.Prism.Regions.IRegionManager'
regionViewRegistryInjectionToken
Type : string
Default value : 'Microsoft.Practices.Prism.Regions.IRegionViewRegistry'
serviceLocatorInjectionToken
Type : string
Default value : 'Microsoft.Practices.ServiceLocation.IServiceLocator'

projects/k-components/src/test.ts

context
Default value : require.context('./', true, /\.spec\.ts$/)
require
Type : literal type

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

convertReifiedType
Default value : <T>( obj: unknown, reifiedType: ReifiedInterfaceInfo ) => { const explicitContractForType = getAsExplicitContractForType( reifiedType.interfaceName, obj ); if (explicitContractForType !== null && obj[explicitContractForType]) { return obj[explicitContractForType](); } else { if ( ReflectionHelper.isInterfaceIsSupported(obj, reifiedType.interfaceName) ) { return obj as T; } else { if ( obj instanceof Object && typeof obj[Symbol.iterator] === 'function' && (reifiedType.interfaceName === 'System.Collections.IEnumerable' || reifiedType.interfaceName === 'System.Collections.IEnumerable`1') ) { return obj as T; } return null; } } }

Conversion case for reified interface type (not to be exported)

projects/i-components/create-spy.ts

createSpy
Default value : (baseName?) => jest.fn()
createSpyObj
Default value : ( baseName, methodNames? ): { [key: string]: jest.Mock<any> } => { const obj: any = {}; // eslint-disable-next-line @typescript-eslint/prefer-for-of for (let i = 0; i < methodNames.length; i++) { obj[methodNames[i]] = jest.fn(); } return obj; }

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

currentDataServiceId
Type : number
Default value : 1

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

currentDateTimeFormatInfoCache
Type : object
Default value : { globalizationFormats: [], formats: [], }

Cache to reduce re-calculation of current date time formats

projects/i-components/src/lib/directives/ribbonGroupItemsDirective.directive.ts

D_COMPATIBLE_COMPONENT
Default value : new InjectionToken<RibbonComponentData>( 'D_COMPATIBLE_COMPONENT' )

Injection token used to access to components

projects/i-components/src/lib/components/xam-grid/test/data.ts

DATA
Type : []
Default value : [ { ProductID: 1, ProductName: 'Chai', SupplierID: 'dsa-sdzxc-cxzxxz', Specifications: [ { Detail: 'Detail 1', }, { Detail: 'Detail 2', }, { Detail: 'Detail 3', }, ], }, { ProductID: 2, ProductName: 'Chang', SupplierID: 'xdewesd-sdacxzwser', Specifications: [ { Detail: 'Detail 4', }, { Detail: 'Detail 5', }, ], }, { ProductID: 3, ProductName: 'Aniseed Syrup', SupplierID: '34dfs-dsf4587j', Specifications: [ { Detail: 'Detail 7', }, ], }, { ProductID: 4, ProductName: 'Chef Antons Cajun Seasoning', SupplierID: 'asdasduhjk-dsadju7', Specifications: [ { Detail: 'Detail 8', }, ], }, { ProductID: 5, ProductName: 'Chef Antons Gumbo Mix', SupplierID: 'weqsadsy-dasyjk', Specifications: [ { Detail: 'Detail 9', }, ], }, { ProductID: 6, ProductName: 'Grandmas Boysenberry Spread', SupplierID: 'gfdhhkj-asdnjkujk', Specifications: [ { Detail: 'Detail 10', }, ], }, ]

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

DefaultNumberFormatter
Default value : new FlexibleJsNumberFormatter()

Formatter to use in the library

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

defaultSettings
Type : object
Default value : { Indent: false }

Default writer settings

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

DISABLED_EVENTS
Type : []
Default value : [ 'pointerdown', 'mousedown', 'pointerenter', 'mouseenter', 'pointerup', 'mouseup', 'focusin', 'click', 'dblclick', 'contextmenu', 'keydown', ]

The collection of events the xam grid will handle in order to emulate the disabled state.

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

downloadFileWithContents
Default value : ( fileName: string, contents: any, mimeType?: string ) => { const blob = new Blob([contents], { type: mimeType ?? 'text/plain' }); const link = document.createElement('a'); link.download = fileName; link.rel = 'noopener'; link.href = window.URL.createObjectURL(blob); link.click(); }

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.
handleFileSelection
Default value : (ev: Event) => {}
openFileDialog
Default value : ( completionHandler?: (result: any, filesSelected: any) => void, filter?: string, readFileAsText: boolean = true, errorHandler?: () => void, file: HTMLInputElement = undefined ) => { const fileInput = file ?? document.createElement('input'); fileInput.setAttribute('type', 'file'); if (filter && filter.indexOf('.') !== -1) { const actualFilter = [...filter.matchAll(/(\.[a-z0-9_]+)/gi)] .map((x) => x[0]) .join(','); fileInput.setAttribute('accept', actualFilter); } fileInput.addEventListener('change', function (e) { if (fileInput.files.length > 0) { const reader = new FileReader(); reader.onerror = errorHandler; if (completionHandler) { reader.onloadend = (ev) => { completionHandler(reader.result, fileInput.files); }; } if (readFileAsText) { reader.readAsText(fileInput.files[0]); } else { reader.readAsArrayBuffer(fileInput.files[0]); } } }); fileInput.click(); }

Opens a file selection dialog for choosing a local file

The result completionHandler is called with the result of opening the file

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

emptyIterable
Type : object
Default value : { [Symbol.iterator]() { return { next: () => ({ done: true, value: undefined }) }; }, }

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

explicitInterfaceCompatibilityMetadataKey
Default value : Symbol( 'wm_compatibility_explicit_interface' )

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/decorators/ClassInfo.ts

fullClassNameCompatibilityMetadataKey
Default value : Symbol( 'wm_compatibility_full_class_name' )

Metadata key for storing the full class name in the original platform
supportedInterfacesCompatibilityMetadataKey
Default value : Symbol( 'wm_compatibility_supported_interfaces' )

Metadata key for storing supported interfaces

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

getSpecialJsonMappedValueIfExists
Default value : (value: any): any => { const typeInfo = ReflectionHelper.getTypeInfo(value); const serializer = serializerFactory.getSerializer(typeInfo.Name); if (serializer != null) { return serializer.Serialize(value); } else { return undefined; } }

Gets the special mapped value if it exists
serializeObjectWithProperties
Default value : (obj: any, jsonObj: any) => { const proto = Object.getPrototypeOf(obj); for (const key of Object.getOwnPropertyNames(proto)) { const desc = Object.getOwnPropertyDescriptor(proto, key); const hasGetter = desc && typeof desc.get === 'function'; if (hasGetter) { jsonObj[key] = obj[key]; } } return jsonObj; }

Internal function for serializing an object using its properties
serializerFactory
Default value : new SerializerFactory()

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

handlers
Type : []
Default value : []
setSingleTimeoutForCurrentEventHandler
Default value : ( func: TimeoutHandler ): any => { if (handlers.length === 0) { timeoutId = setTimeout(setTimeoutHandler); } handlers.push(func); return timeoutId; }

Timeout helper to schedule a single timeout call at the end of the current event handler or task
setTimeoutHandler
Default value : () => { const handlersClone = [...handlers]; handlers = []; for (const handler of handlersClone) { try { handler(); } catch (e) { console.error(e); } } }
timeoutId
Type : any
Default value : null

projects/i-components/src/lib/components/xam-grid/operatorsIconsString.ts

iconDoesNotEndWith
Type : string
Default value : "<svg id='Layer_1' data-name='Layer 1' xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M1.5,19.15V16.54H3.27v2.61Z'/><path d='M5.12,19.15V16.54H6.88v2.61Z'/><path d='M8.73,19.15V16.54H10.5v2.61Z'/><path d='M13.5,22,20.38,2H22.5L15.63,22Z'/><path d='M21.12,16.74a18.22,18.22,0,0,0,.15,2.41h-2a5.71,5.71,0,0,1-.16-1.33c-.38.69-1.21,1.58-3.24,1.58a3.24,3.24,0,0,1-3.6-3.28c0-2.39,1.88-3.48,5.05-3.48h1.76v-.86c0-.9-.3-2-2.17-2-1.68,0-2,.81-2.16,1.63h-2C13,9.89,13.91,8.22,17,8.23c2.65,0,4.11,1.09,4.11,3.53Zm-2-2.72H17.49c-2,0-3.1.57-3.1,2a1.78,1.78,0,0,0,2,1.82c2.43,0,2.76-1.65,2.76-3.48Z'/></svg>'"

iconDoesNotEndWith operator
iconDoesNotStartWith
Type : string
Default value : "<svg id='Layer_1' data-name='Layer 1'xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M15,19.15V16.54h1.77v2.61Z'/><path d='M18.62,19.15V16.54h1.76v2.61Z'/><path d='M22.23,19.15V16.54H24v2.61Z'/><path d='M3.85,15,2.37,19.15H.23L5.36,4.6H8l5.35,14.55H11.1L9.57,15ZM9,13.15C7.72,9.47,7,7.45,6.65,6.3h0C6.28,7.57,5.45,10,4.38,13.15Z'/><path d='M2,22,8.88,2H11L4.13,22Z'/><rect y='20' width='14' height='1'/></svg>"

iconDoesNotStartWith operator

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

mkenum
Default value : <T extends { [index: string]: U }, U extends string>( x: T ) => x
XamSelectionMode
Default value : mkenum({ None: 'None', Single: 'Single', Multiple: 'Multiple', })

projects/i-components/setupJest.ts

nodeCrypto
Default value : require('crypto')

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

originalDataErrorInfoInterface
Type : string
Default value : 'System.ComponentModel.IDataErrorInfo'

Name of the original contract for data error info
originalErrorNotificationInterfaceName
Type : string
Default value : 'System.ComponentModel.INotifyDataErrorInfo'

Original name of error notification interfaces

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

PredefinedTypeDeserializationInfo
Type : PredefinedTypeDeserializationInfos
Default value : { Number: { wrapperElementName: 'int', deserializationFunction: (data: string) => Number.parseFloat(data), }, String: { wrapperElementName: 'string', deserializationFunction: (data: string) => data, }, Date: { wrapperElementName: 'dateTime', deserializationFunction: (data: string) => new Date(data), }, Boolean: { wrapperElementName: 'boolean', deserializationFunction: (data: string) => data.toLowerCase() === 'true', }, }

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

processParthPartString
Default value : (stringPart: string) => { const match = stringPart.match(/^([^[]+)\[([^\]]+)\]$/); if (match && match.length > 2) { return new IndexerPathPart(match[1], match[2]); } else { return new PropertyPathPart(stringPart); } }

Creates an instance of the required PathPart object for the given string

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

RadUAGPrefix
Type : string
Default value : 'RadUAG_'

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/regionsframework/directives/RegionManager.directive.ts

regionCreationBehaviorProperty
Default value : new DependencyProperty( 'RegionCreationBehavior', null, null )
regionManagerProperty
Default value : new DependencyProperty( 'RegionManager', null, null )
regionNameProperty
Default value : new DependencyProperty( 'RegionName', '', changeCallback )

projects/wms-framework/src/lib/baseframework/TypeSerializers/DateSerializer.ts

reISO
Default value : /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2}(?:\.\d*)?)Z$/
reMsAjax
Default value : /^\/Date\(([+-]?\d*)\)[\/|\\]$/
reMsAjaxWithTimezone
Default value : /^\/Date\((-?[0-9]+)([+-])([0-9][0-9])([0-9][0-9])\)\//

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

reIsStream
Default value : /;System\.IO\..*Stream, mscorlib, Version=.*, Culture=.*, PublicKeyToken=.*;AssemblyName=/

Regex used to check if a resource is a stream.

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

serializeXNodeToString
Default value : (node: XNode) => { const buffer = new StringWriter(); const writer = XmlWriter.Create(buffer); serializingXNodeToString(node, writer); return buffer.toString(); }

Entry point for XML serialization
serializingXNodeToString
Default value : (node: XNode, writer: XmlWriter) => { if (node instanceof XElement) { writer.WriteStartElement(node.localName); for (const att of node.Attributes()) { writer.WriteAttributeString(att.Name, att.Value); } for (const child of node.nodes()) { serializingXNodeToString(child, writer); } writer.WriteEndElement(); } else if (node instanceof XText) { writer.WriteValue(node.value); } }

Serialization XML step function

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

SmColors
Type : object
Default value : { Red: createColorFromArgb(255, 255, 0, 0), Green: createColorFromArgb(255, 0, 128, 0), Blue: createColorFromArgb(255, 0, 0, 255), Black: createColorFromArgb(255, 0, 0, 0), White: createColorFromArgb(255, 255, 255, 255), LightGray: createColorFromArgb(255, 0xd3, 0xd3, 0xd3), LightYellow: createColorFromArgb(255, 255, 255, 224), Brown: createColorFromArgb(255, 165, 42, 42), Cyan: createColorFromArgb(255, 0, 255, 255), DarkGray: createColorFromArgb(255, 169, 169, 169), Gray: createColorFromArgb(255, 128, 128, 128), Magenta: createColorFromArgb(255, 255, 0, 255), Orange: createColorFromArgb(255, 255, 165, 0), Purple: createColorFromArgb(255, 128, 0, 128), Yellow: createColorFromArgb(255, 255, 255, 0), Transparent: createColorFromArgb(0, 0, 0, 0), }

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

TEMPLATE_COMPONENT_CONTEXT
Default value : new InjectionToken<string>( 'injection_token_for_template_component_context' )

Injection token for the context of template components
TEMPLATE_DECLARING_CONTEXT
Default value : new InjectionToken<string>( 'injection_token_for_template_declaring_context' )

Injection token for the declaring context of template components

result-matching ""

    No results matching ""