@mobilize/winforms-components documentation
  1. Injectables
  2. EditMaskService

File

src/services/editMask/editmask.service.ts

Description

Edit mask service. Injected on the mask components.

Index

Properties
Methods

Methods

addToCommandsOrder
addToCommandsOrder(charObject: EditMaskRule)

Organizes commands int the order that they should be applied

Parameters :
Name Type Optional
charObject EditMaskRule No
Returns : void
applyTransformationRules
applyTransformationRules(maskedValue: string)

Apply transformation rules

Parameters :
Name Type Optional
maskedValue string No
Returns : any
generateValidMask
generateValidMask(char: string)

Each time that a command character appears, this should be removed from the valid mask

Parameters :
Name Type Optional
char string No
Returns : void
initializeMaskTransformation
initializeMaskTransformation(context: any)

Initialize handlers to process mask

Parameters :
Name Type Optional Description
context any No
  • The component ref.
Returns : void
maskHasCommandCharacters
maskHasCommandCharacters(commandCharacters: string[], mask: string)

Evaluates mask to check if a command Character or a place holder identification exist

Parameters :
Name Type Optional
commandCharacters string[] No
mask string No
Returns : boolean

{boolean}
maskHasPlaceHolderSpecification
maskHasPlaceHolderSpecification(mask: string)

Get place holder char and modify validMask

Parameters :
Name Type Optional
mask string No
Returns : void
normalizeTransformationIndex
normalizeTransformationIndex()

Normalize indexes compatible with current valid mask

Returns : void
processCommandCharacters
processCommandCharacters(char: string, mask: string, index: number)

Takes selects chars that applies to be rules

Parameters :
Name Type Optional Description
char string No

char from mask
mask string No

model mask
index number No

apparition index of the char
Returns : void
processCommandRules
processCommandRules(mask: string, index: number, char: string, rule: (start: number,end: number,text: string) => void)

Stores all rules in the order that should be applied

Parameters :
Name Type Optional
mask string No
index number No
char string No
rule function No
Returns : void
processLiterals
processLiterals(start: number, end: number, textAux: string)

Process literals in the portion of text

Parameters :
Name Type Optional Description
start number No

start index
end number No

end index
textAux string No

chunk of string to be evaluated
Returns : string

{*}
processMaskToCommandChar
processMaskToCommandChar()

Iterates over every character of the mask to evaluate them

Returns : void
removePlaceholderFromString
removePlaceholderFromString(valueChanged: string)

Removes placeholder from string and return a valid text

Parameters :
Name Type Optional
valueChanged string No
Returns : string
serviceMaskChanged
serviceMaskChanged()

ServiceMaskChanged

Returns : boolean

{boolean}
toLowerCase
toLowerCase(start: number, end: number, text: string)

Converts to lowerCase chunk of string

Parameters :
Name Type Optional Description
start number No

start index
end number No

end index
text string No

text to be converted
Returns : string

{string}
toScapeLiteral
toScapeLiteral(start: number, end: number, text: string)

Literal rule

Parameters :
Name Type Optional Description
start number No

start index
end number No

end index
text string No

text evaluated
Returns : string

{string}
toUpperCase
toUpperCase(start: number, end: number, text: string)

Converts to uppercase chunk of string

Parameters :
Name Type Optional Description
start number No

start index
end number No

end index
text string No

text to be converted
Returns : string

{string}
validateLiterals
validateLiterals(textAux: string, validMask: any, stringOfLiterals: any[])

Iterates over currentMask and find literals

Parameters :
Name Type Optional Description
textAux string No

portion of text
validMask any No

mask
stringOfLiterals any[] No
Returns : string

{string}
verifyTransformation
verifyTransformation(maskedValue: string)

Verify if mask containsCommandCharacters hasTransformation

Parameters :
Name Type Optional
maskedValue string No
Returns : any

{*}

Properties

commandCharacters
Type : []
Default value : [ EditMaskCharacter.uppercase, EditMaskCharacter.lowercase, EditMaskCharacter.placeHolder ]

Command characters except literal skip
commandsOrderApply
Type : EditMaskRule[]
Default value : []

Array with commands order.
containsCommandCharacters
Default value : false

Whether or not has commandChar
context
Type : any
Default value : {}

Control's context.
currentMask
Type : any

Current mask defined on c1flexGrid
placeHolderSpecification
Type : string
Default value : '_'

Place holder specification
validMask
Type : any

Valid Mask format without commandCharacters or placeHolder

results matching ""

    No results matching ""