XuniMaskHandler Class Reference

Inherits from	NSObject
Declared in	XuniMaskHandler.h

`mask`

Gets or sets the mask used to validate input as the user types. The mask must be a string composed of one or more of the masking elements.

@property (nonatomic) NSString *mask

Discussion

Gets or sets the mask used to validate input as the user types. The mask must be a string composed of one or more of the masking elements.

Declared In

XuniMaskHandler.h

`placeholder`

Gets or sets the maskfield’s placeholder.

@property (nonatomic) NSString *placeholder

Discussion

Gets or sets the maskfield’s placeholder.

Declared In

XuniMaskHandler.h

`maskFull`

Gets a boolean value that indicates whether the mask has been completely filled

@property (nonatomic, readonly) BOOL maskFull

Discussion

Gets a boolean value that indicates whether the mask has been completely filled

Declared In

XuniMaskHandler.h

`promptChar`

Gets or sets the symbol used to show input positions in the control.

@property (nonatomic) NSString *promptChar

Discussion

Gets or sets the symbol used to show input positions in the control.

Declared In

XuniMaskHandler.h

`isDelete`

Gets or sets the boolean value that indicates whether delete or not.

@property (nonatomic) BOOL isDelete

Discussion

Gets or sets the boolean value that indicates whether delete or not.

Declared In

XuniMaskHandler.h

`– applyMaskTo:charsNum:`

Applies the mask to the input string, returns the output string.

- (NSString *)applyMaskTo:(NSString *)inputStr charsNum:(NSUInteger *)charsNum

Parameters

`inputStr`	The input string.
`charsNum`	The applied chars number.

Return Value

The output string.

Discussion

Applies the mask to the input string, returns the output string.

Declared In

XuniMaskHandler.h

`– applyMaskTo:`

Applies the mask to the input string, returns the output string.

- (NSString *)applyMaskTo:(NSString *)inputStr

Parameters

`inputStr`	The input string.

Return Value

The output string.

Discussion

Applies the mask to the input string, returns the output string.

Declared In

XuniMaskHandler.h

`– applyMaskTo:maskStartPos:`

Applies the mask to the input string, returns the output string.

- (NSString *)applyMaskTo:(NSString *)inputStr maskStartPos:(NSUInteger)maskStartPos

Parameters

`inputStr`	The input string.
`maskStartPos`	The start position of mask.

Return Value

The output string.

Discussion

Applies the mask to the input string, returns the output string.

Declared In

XuniMaskHandler.h

`– getRawValue:`

Gets the raw value of the string, excluding prompts and literals.

- (NSString *)getRawValue:(NSString *)str

Parameters

`str`	The string.

Return Value

The raw value string.

Discussion

Gets the raw value of the string, excluding prompts and literals.

Declared In

XuniMaskHandler.h

`– getValidPosition:isForward:`

Get valid position.

- (NSUInteger)getValidPosition:(NSUInteger)start isForward:(BOOL)isForward

Parameters

`start`	The start position.
`isForward`	Is forward or not.

Return Value

The valid position.

Discussion

Get valid position.

Declared In

XuniMaskHandler.h

`– getAppliedCharsNum:maskStartPos:`

Applies the mask to the input string, returns the applied Chars number.

- (NSUInteger)getAppliedCharsNum:(NSString *)inputStr maskStartPos:(NSUInteger)maskStartPos

Parameters

`inputStr`	The input string.
`maskStartPos`	The start position of mask.

Return Value

The applied Chars number.

Discussion

Applies the mask to the input string, returns the applied Chars number.

Declared In

XuniMaskHandler.h

`– isStringValid:oldMaskPos:newMaskPos:`

Check if string is valid to mask.

- (BOOL)isStringValid:(NSString *)str oldMaskPos:(NSUInteger)oldMaskPos newMaskPos:(NSUInteger)newMaskPos

Parameters

`str`	The string.
`oldMaskPos`	The old position of mask.
`newMaskPos`	The new position of mask.

Return Value

The boolean value.

Discussion

Check if string is valid to mask.

Declared In

XuniMaskHandler.h