Inheritance
object
ComponentBase
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
- IDisposable
Constructors
Section titled "Constructors"constructor
public IgbInput()Returns IgbInput
Properties
Section titled "Properties"DefaultEventBehavior
Section titled "DefaultEventBehavior"Inherited from: IgbInputBase
Gets the components default event behavior.
protected override ControlEventBehavior DefaultEventBehavior { get; }Outlined
Section titled "Outlined"Inherited from: IgbInputBase
Whether the control will have outlined appearance. false
[Parameter]
public bool Outlined { get; set; }Placeholder
Section titled "Placeholder"Inherited from: IgbInputBase
The placeholder attribute of the control.
[Parameter]
public string Placeholder { get; set; }Label
Section titled "Label"Inherited from: IgbInputBase
The label for the control.
[Parameter]
public string Label { get; set; }Disabled
Section titled "Disabled"Inherited from: IgbInputBase
The disabled state of the component
[Parameter]
public bool Disabled { get; set; }Required
Section titled "Required"Inherited from: IgbInputBase
Makes the control a required field in a form context.
[Parameter]
public bool Required { get; set; }Invalid
Section titled "Invalid"Inherited from: IgbInputBase
Control the validity of the control.
[Parameter]
public bool Invalid { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererControl
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }Height
Section titled "Height"Inherited from: BaseRendererControl
[Parameter]
public string Height { get; set; }Width
Section titled "Width"Inherited from: BaseRendererControl
[Parameter]
public string Width { get; set; }Class
Section titled "Class"Inherited from: BaseRendererControl
[Parameter]
public string Class { get; set; }AdditionalAttributes
Section titled "AdditionalAttributes"Inherited from: BaseRendererControl
[Parameter(CaptureUnmatchedValues = true)]
public Dictionary<string, object> AdditionalAttributes { get; set; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererControl
protected virtual string ParentTypeName { get; }EventBehavior
Section titled "EventBehavior"Inherited from: BaseRendererControl
Gets or sets how events are bubbled up from JavaScript to Blazor.
[Parameter]
public ControlEventBehavior EventBehavior { get; set; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererControl
[Parameter]
public RenderFragment ChildContent { get; set; }RoundTripDateConversion
Section titled "RoundTripDateConversion"Inherited from: BaseRendererControl
Gets or sets what type of date conversion to make when round tripping dates.
[Parameter]
public RoundTripDateConversion RoundTripDateConversion { get; set; }NeedsDynamicContent
Section titled "NeedsDynamicContent"Inherited from: BaseRendererControl
protected virtual bool NeedsDynamicContent { get; }UseCamelEnumValues
Section titled "UseCamelEnumValues"Inherited from: BaseRendererControl
protected virtual bool UseCamelEnumValues { get; }Autocomplete
Section titled "Autocomplete"The autocomplete attribute of the control.
[Parameter]
public string Autocomplete { get; set; }Autofocus
Section titled "Autofocus"The autofocus attribute of the control.
[Parameter]
public bool Autofocus { get; set; }DirectRenderElementName
Section titled "DirectRenderElementName"protected override string DirectRenderElementName { get; }DisplayType
Section titled "DisplayType"The type attribute of the control.
[Parameter]
[WCWidgetMemberName("Type")]
public InputType DisplayType { get; set; }InputMode
Section titled "InputMode"The input mode attribute of the control. See relevant MDN article
[Parameter]
[WCAttributeName("inputmode")]
public string InputMode { get; set; }The max attribute of the control.
[Parameter]
public double? Max { get; set; }MaxLength
Section titled "MaxLength"The maximum string length of the control.
[Parameter]
[WCAttributeName("maxlength")]
public double? MaxLength { get; set; }The min attribute of the control.
[Parameter]
public double? Min { get; set; }MinLength
Section titled "MinLength"The minimum string length required by the control.
[Parameter]
[WCAttributeName("minlength")]
public double? MinLength { get; set; }Pattern
Section titled "Pattern"The pattern attribute of the control.
[Parameter]
public string? Pattern { get; set; }ReadOnly
Section titled "ReadOnly"Makes the control a readonly field. false
[Parameter]
[WCAttributeName("readonly")]
public bool ReadOnly { get; set; }The step attribute of the control.
[Parameter]
public double? Step { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"protected override bool SupportsVisualChildren { get; }public override string Type { get; }UseDirectRender
Section titled "UseDirectRender"protected override bool UseDirectRender { get; }ValidateOnly
Section titled "ValidateOnly"Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property for string-type inputs or allows spin buttons to exceed the predefined min/max limits for number-type inputs. false
[Parameter]
public bool ValidateOnly { get; set; }Value
Section titled "Value"The value of the control.
[Parameter]
public string Value { get; set; }Accessors
Section titled "Accessors"eventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererControl
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererControl
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbInputBase
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbInputBase
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
SelectAsync()
Section titled "SelectAsync()"Inherited from: IgbInputBase
Selects all the text inside the input.
public Task SelectAsync()Returns any
Select()
Section titled "Select()"Inherited from: IgbInputBase
public void Select()Returns any
FocusComponentAsync(IgbFocusOptions)
Section titled "FocusComponentAsync(IgbFocusOptions)"Inherited from: IgbInputBase
Sets focus on the control.
[WCWidgetMemberName("Focus")]
public Task FocusComponentAsync(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
FocusComponent(IgbFocusOptions)
Section titled "FocusComponent(IgbFocusOptions)"Inherited from: IgbInputBase
[WCWidgetMemberName("Focus")]
public void FocusComponent(IgbFocusOptions options)Parameters
- options:
IgbFocusOptions
Returns any
BlurComponentAsync()
Section titled "BlurComponentAsync()"Inherited from: IgbInputBase
Removes focus from the control.
[WCWidgetMemberName("Blur")]
public Task BlurComponentAsync()Returns any
BlurComponent()
Section titled "BlurComponent()"Inherited from: IgbInputBase
[WCWidgetMemberName("Blur")]
public void BlurComponent()Returns any
ReportValidityAsync()
Section titled "ReportValidityAsync()"Inherited from: IgbInputBase
Checks for validity of the control and shows the browser message if it invalid.
public Task ReportValidityAsync()Returns any
ReportValidity()
Section titled "ReportValidity()"Inherited from: IgbInputBase
public void ReportValidity()Returns any
CheckValidityAsync()
Section titled "CheckValidityAsync()"Inherited from: IgbInputBase
Checks for validity of the control and emits the invalid event if it invalid.
public Task CheckValidityAsync()Returns any
CheckValidity()
Section titled "CheckValidity()"Inherited from: IgbInputBase
public void CheckValidity()Returns any
SetCustomValidityAsync(string)
Section titled "SetCustomValidityAsync(string)"Inherited from: IgbInputBase
Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid.
public Task SetCustomValidityAsync(string message)Parameters
- message:
string
Returns any
SetCustomValidity(string)
Section titled "SetCustomValidity(string)"Inherited from: IgbInputBase
public void SetCustomValidity(string message)Parameters
- message:
string
Returns any
ResolveEventBehavior()
Section titled "ResolveEventBehavior()"Inherited from: BaseRendererControl
Resolves the components event behavior if Auto is selected.
protected ControlEventBehavior ResolveEventBehavior()Returns any
ToSpinal(string)
Section titled "ToSpinal(string)"Inherited from: BaseRendererControl
protected string ToSpinal(string value)Parameters
- value:
string
Returns any
TransformSimpleKey(string)
Section titled "TransformSimpleKey(string)"Inherited from: BaseRendererControl
protected virtual string TransformSimpleKey(string key)Parameters
- key:
string
Returns any
IsTransformedEnumValue(string)
Section titled "IsTransformedEnumValue(string)"Inherited from: BaseRendererControl
protected virtual bool IsTransformedEnumValue(string key)Parameters
- key:
string
Returns any
TransformPotentialEnumValue(string, object)
Section titled "TransformPotentialEnumValue(string, object)"Inherited from: BaseRendererControl
protected virtual object TransformPotentialEnumValue(string key, object value)Parameters
- key:
string - value:
object
Returns any
BuildSequenceInfo(int)
Section titled "BuildSequenceInfo(int)"Inherited from: BaseRendererControl
protected virtual SequenceInfo BuildSequenceInfo(int startSequence)Parameters
- startSequence:
int
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererControl
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
TemplateContentType(string)
Section titled "TemplateContentType(string)"Inherited from: BaseRendererControl
protected Type TemplateContentType(string templateId)Parameters
- templateId:
string
Returns any
OnAfterRenderAsync(bool)
Section titled "OnAfterRenderAsync(bool)"Inherited from: BaseRendererControl
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
- firstRender:
bool
Returns any
EnsureReady()
Section titled "EnsureReady()"Inherited from: BaseRendererControl
public Task EnsureReady()Returns any
MarkPropDirty(string)
Section titled "MarkPropDirty(string)"Inherited from: BaseRendererControl
protected void MarkPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererControl
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererControl
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererControl
public string Serialize()Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodSync(string, object[], string[], ElementReference[])
Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"Inherited from: BaseRendererControl
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
SuspendNotifications(object)
Section titled "SuspendNotifications(object)"Inherited from: BaseRendererControl
Prevents data change notifications from be propagated to the component.
public void SuspendNotifications(object dataSource)Parameters
- dataSource:
object
Returns any
ResumeNotifications(object, bool)
Section titled "ResumeNotifications(object, bool)"Inherited from: BaseRendererControl
Resumes data change notifications.
public void ResumeNotifications(object dataSource, bool notify = true)Parameters
- dataSource:
object - notify:
bool
Returns any
NotifyInsertItem(object, int, object)
Section titled "NotifyInsertItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyInsertItem(object dataSource, int index, object refItem)Parameters
- dataSource:
object - index:
int - refItem:
object
Returns any
NotifyRemoveItem(object, int, object)
Section titled "NotifyRemoveItem(object, int, object)"Inherited from: BaseRendererControl
public void NotifyRemoveItem(object dataSource, int index, object oldItem)Parameters
- dataSource:
object - index:
int - oldItem:
object
Returns any
NotifyClearItems(object)
Section titled "NotifyClearItems(object)"Inherited from: BaseRendererControl
public void NotifyClearItems(object dataSource)Parameters
- dataSource:
object
Returns any
NotifySetItem(object, int, object, object)
Section titled "NotifySetItem(object, int, object, object)"Inherited from: BaseRendererControl
public void NotifySetItem(object dataSource, int index, object oldItem, object newItem)Parameters
- dataSource:
object - index:
int - oldItem:
object - newItem:
object
Returns any
NotifyUpdateItem(object, int, object, bool)
Section titled "NotifyUpdateItem(object, int, object, bool)"Inherited from: BaseRendererControl
public void NotifyUpdateItem(object dataSource, int index, object refItem, bool syncDataOnly = false)Parameters
- dataSource:
object - index:
int - refItem:
object - syncDataOnly:
bool
Returns any
OnRefChanged(string, object)
Section titled "OnRefChanged(string, object)"Inherited from: BaseRendererControl
public void OnRefChanged(string refName, object refValue)Parameters
- refName:
string - refValue:
object
Returns any
OnInvokeReturn(long, object)
Section titled "OnInvokeReturn(long, object)"Inherited from: BaseRendererControl
public void OnInvokeReturn(long invokeId, object returnValue)Parameters
- invokeId:
long - returnValue:
object
Returns any
Camelize(string)
Section titled "Camelize(string)"Inherited from: BaseRendererControl
protected string Camelize(string value)Parameters
- value:
string
Returns any
ToPascal(string)
Section titled "ToPascal(string)"Inherited from: BaseRendererControl
protected string ToPascal(string value)Parameters
- value:
string
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererControl
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
Dispose(bool)
Section titled "Dispose(bool)"Inherited from: BaseRendererControl
protected virtual void Dispose(bool disposing)Parameters
- disposing:
bool
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string id, string value)Parameters
- grouping:
string - id:
string - value:
string
Returns any
SetResourceStringAsync(string, string)
Section titled "SetResourceStringAsync(string, string)"Inherited from: BaseRendererControl
public Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
SetPropertyValue(object, PropertyInfo, JsonElement)
Section titled "SetPropertyValue(object, PropertyInfo, JsonElement)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, JsonElement jsonElement)Parameters
- item:
object - property:
PropertyInfo - jsonElement:
JsonElement
Returns any
SetPropertyValue(object, PropertyInfo, object)
Section titled "SetPropertyValue(object, PropertyInfo, object)"Inherited from: BaseRendererControl
protected void SetPropertyValue(object item, PropertyInfo property, object value)Parameters
- item:
object - property:
PropertyInfo - value:
object
Returns any
Dispose()
Section titled "Dispose()"Inherited from: BaseRendererControl
public void Dispose()Returns any
EnsureModulesLoaded()
Section titled "EnsureModulesLoaded()"protected override void EnsureModulesLoaded()Returns any
FindByName(string)
Section titled "FindByName(string)"public override object FindByName(string name)Parameters
- name:
string
Returns any
GetCurrentValue()
Section titled "GetCurrentValue()"public string GetCurrentValue()Returns any
GetCurrentValueAsync()
Section titled "GetCurrentValueAsync()"public Task<string> GetCurrentValueAsync()Returns any
ResolveDisplay()
Section titled "ResolveDisplay()"protected override string ResolveDisplay()Returns any
SetParametersAsync(ParameterView)
Section titled "SetParametersAsync(ParameterView)"public override Task SetParametersAsync(ParameterView parameters)Parameters
- parameters:
ParameterView
Returns any
StepDown(double)
Section titled "StepDown(double)"public void StepDown(double n = -1)Parameters
- n:
double
Returns any
StepDownAsync(double)
Section titled "StepDownAsync(double)"Decrements the numeric value of the input by one or more steps.
public Task StepDownAsync(double n = -1)Parameters
- n:
double
Returns any
StepUp(double)
Section titled "StepUp(double)"public void StepUp(double n = -1)Parameters
- n:
double
Returns any
StepUpAsync(double)
Section titled "StepUpAsync(double)"Increments the numeric value of the input by one or more steps.
public Task StepUpAsync(double n = -1)Parameters
- n:
double
Returns any
Events
Section titled "Events"ValueChanging
Section titled "ValueChanging"[Parameter]
public EventCallback<string> ValueChanging { get; set; }InputOcurred
Section titled "InputOcurred"[Parameter]
public EventCallback<IgbComponentValueChangedEventArgs> InputOcurred { get; set; }Focus
Section titled "Focus"[Parameter]
public EventCallback<IgbVoidEventArgs> Focus { get; set; }[Parameter]
public EventCallback<IgbVoidEventArgs> Blur { get; set; }Change
Section titled "Change"[Parameter]
public EventCallback<IgbComponentValueChangedEventArgs> Change { get; set; }ValueChanged
Section titled "ValueChanged"[Parameter]
public EventCallback<string> ValueChanged { get; set; }InputOcurredScript
Section titled "InputOcurredScript"[Parameter]
public string InputOcurredScript { get; set; }FocusScript
Section titled "FocusScript"[Parameter]
public string FocusScript { get; set; }BlurScript
Section titled "BlurScript"[Parameter]
public string BlurScript { get; set; }ChangeScript
Section titled "ChangeScript"[Parameter]
public string ChangeScript { get; set; }