PromptPlus API:IControlMaskEditList
IControlMaskEditList
Namespace: PPlus.Controls
Represents the interface with all Methods of the AddtoMaskEditList control
public interface IControlMaskEditList : IPromptControls<IEnumerable<ResultMasked>>
Implements IPromptControls<IEnumerable<ResultMasked>>
Methods
AcceptEmptyValue()
Accept empty value
Valid only for type not equal MaskedType.Generic, otherwise this set will be ignored.
IControlMaskEditList AcceptEmptyValue()
Returns
AddItem(String, Boolean)
Add item to initial list
IControlMaskEditList AddItem(string value, bool immutable)
Parameters
value String
Text item to add
immutable Boolean
true the item cannot be removed; otherwise yes.
Returns
AddItems(IEnumerable<String>, Boolean)
Add items colletion to initial list
IControlMaskEditList AddItems(IEnumerable<String> values, bool immutable)
Parameters
values IEnumerable<String>
items colletion to add
immutable Boolean
true the item cannot be removed; otherwise yes.
Returns
AddValidators(params Func<Object, ValidationResult>[])
Add a validator to accept sucessfull finish of control.
Tip: see to validators embedding
IControlMaskEditList AddValidators(params Func<Object, ValidationResult>[] validators)
Parameters
validators Func<Object, ValidationResult>[]
the function validator.
Returns
AllowDuplicate()
Allow duplicate items.Default value for this control is false.
IControlMaskEditList AllowDuplicate()
Returns
AmmoutPositions(Int32, Int32, Boolean)
Defines integer length, decimal length and accept signl.
Valid only for type MaskedType.Number or Currency, otherwise this set will be ignored.
This set is Requeried for these types.
IControlMaskEditList AmmoutPositions(int intvalue, int decimalvalue, bool acceptSignal)
Parameters
intvalue Int32
integer length
decimalvalue Int32
decimal length
acceptSignal Boolean
True accept signal; otherwise, no.
Returns
ChangeDescription(Func<String, String>)
Dynamically change the description using a user role
IControlMaskEditList ChangeDescription(Func<String, String> value)
Parameters
value Func<String, String>
function to apply change
Returns
Config(Action<IPromptConfig>)
Custom config the control.
IControlMaskEditList Config(Action<IPromptConfig> context)
Parameters
context Action<IPromptConfig>
action to apply changes. IPromptConfig
Returns
Culture(CultureInfo)
CultureInfo to validate input when the type is not generic.
Default value is global Promptplus Cultureinfo
IControlMaskEditList Culture(CultureInfo value)
Parameters
value CultureInfo
CultureInfo to use on validate
Returns
Culture(String)
CultureInfo to validate input when the type is not generic.
Default value is global Promptplus Cultureinfo
IControlMaskEditList Culture(string value)
Parameters
value String
Name of CultureInfo to use on validate
Returns
Default(String)
Default initial value when when stated.
IControlMaskEditList Default(string value)
Parameters
value String
initial value
Returns
FillZeros()
Fill zeros mask.
Not valid for type MaskedType.Generic (this set will be ignored).
When used this feature the AcceptEmptyValue feature will be ignored.
When MaskedType.Number or MaskedType.Currency this feature is always on.
IControlMaskEditList FillZeros()
Returns
FormatTime(FormatTime)
Defines time parts input.
Valid only for type MaskedType.TimeOnly or DateTime, otherwise this set will be ignored.
IControlMaskEditList FormatTime(FormatTime value)
Parameters
value FormatTime
FormatTime
Returns
FormatYear(FormatYear)
Defines if year is long or short.
Valid only for type MaskedType.DateOnly or DateTime, otherwise this set will be ignored.
IControlMaskEditList FormatYear(FormatYear value)
Parameters
value FormatYear
FormatYear
Returns
HotKeyEditItem(HotKey)
Overwrite a HotKey to edit item. Default value is ‘F2’
IControlMaskEditList HotKeyEditItem(HotKey value)
Parameters
value HotKey
The HotKey to edit item
Returns
HotKeyRemoveItem(HotKey)
Overwrite a HotKey to remove item. Default value is ‘F3’
IControlMaskEditList HotKeyRemoveItem(HotKey value)
Parameters
value HotKey
The HotKey to remove item
Returns
InputToCase(CaseOptions)
Transform char input using CaseOptions.
IControlMaskEditList InputToCase(CaseOptions value)
Parameters
value CaseOptions
Transform option
Returns
Interaction<T>(IEnumerable<T>, Action<IControlMaskEditList, T>)
Execute a action foreach item of colletion passed as a parameter
IControlMaskEditList Interaction<T>(IEnumerable<T> values, Action<IControlMaskEditList, T> action)
Type Parameters
T
Typeof item
Parameters
values IEnumerable<T>
Colletion for interaction
action Action<IControlMaskEditList, T>
Action to execute
Returns
Mask(String, Nullable<Char>)
Defines mask input. Rules for Generic type:
9 - Only a numeric character
L - Only a letter
C - OnlyCustom character
A - Any character
N - OnlyCustom character + Only a numeric character
X - OnlyCustom character + Only a letter
\ - Escape character
{ - Initial delimiter for repetition of masks
} - Final delimiter for repetition of masks
[-Initial delimiter for list of Custom character
] - Final delimiter for list of Custom character
IControlMaskEditList Mask(string value, Nullable<Char> promptmask)
Parameters
value String
text of masked when type is Generic. otherwise must be null.
promptmask Nullable<Char>
Prompt mask overwriter. Default value is ‘■’/’_’
Returns
Mask(MaskedType, Nullable<Char>)
Defines type of mask control.
IControlMaskEditList Mask(MaskedType maskedType, Nullable<Char> promptmask)
Parameters
maskedType MaskedType
MaskedType
promptmask Nullable<Char>
Prompt mask overwriter. Default value is ‘■’/’_’
Returns
PageSize(Int32)
Set max.item view per page.Default value for this control is 10.
IControlMaskEditList PageSize(int value)
Parameters
value Int32
Number of Max.items
Returns
Range(Int32, Nullable<Int32>)
Defines a minimum and maximum (optional) range of items in the list
IControlMaskEditList Range(int minvalue, Nullable<Int32> maxvalue)
Parameters
minvalue Int32
Minimum number of items
maxvalue Nullable<Int32>
Maximum number of items
Returns
ShowTipInputType(FormatWeek)
Append to desription the tip of type input.
IControlMaskEditList ShowTipInputType(FormatWeek week)
Parameters
week FormatWeek
show name of week for type date. FormatWeek
Returns
Styles(MaskEditListStyles, Style)
Overwrite Styles
IControlMaskEditList Styles(MaskEditListStyles content, Style value)
Parameters
content MaskEditListStyles
The MaskEditListStyles content
value Style
The Style to apply
Returns
SuggestionHandler(Func<SuggestionInput, SuggestionOutput>)
Add Suggestion Handler feature
IControlMaskEditList SuggestionHandler(Func<SuggestionInput, SuggestionOutput> value)
Parameters
value Func<SuggestionInput, SuggestionOutput>
function to apply suggestions. SuggestionInput and SuggestionOutput