State component allows saving and restoring the state of the grid features.
Inheritance
object
ComponentBase
Implements
- IComponent
- IHandleEvent
- IHandleAfterRender
- JsonSerializable
Constructors
Section titled "Constructors"constructor
public IgbGridState()Returns IgbGridState
Properties
Section titled "Properties"Options
Section titled "Options"Inherited from: IgbGridStateBaseDirective
An object with options determining if a certain feature state should be saved.
[Parameter]
public IgbGridStateOptions Options { get; set; }IgBlazor
Section titled "IgBlazor"Inherited from: BaseRendererElement
[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }IsComponentRooted
Section titled "IsComponentRooted"Inherited from: BaseRendererElement
public bool IsComponentRooted { get; }ParentTypeName
Section titled "ParentTypeName"Inherited from: BaseRendererElement
protected virtual string ParentTypeName { get; }UseDirectRender
Section titled "UseDirectRender"Inherited from: BaseRendererElement
protected virtual bool UseDirectRender { get; }ChildContent
Section titled "ChildContent"Inherited from: BaseRendererElement
[Parameter]
public RenderFragment ChildContent { get; set; }SupportsVisualChildren
Section titled "SupportsVisualChildren"Inherited from: BaseRendererElement
protected virtual bool SupportsVisualChildren { get; }Inherited from: BaseRendererElement
[Parameter]
public string Name { get; set; }Parent
Section titled "Parent"Inherited from: BaseRendererElement
public object Parent { get; }MethodTarget
Section titled "MethodTarget"Inherited from: BaseRendererElement
protected virtual string MethodTarget { get; }CurrParent
Section titled "CurrParent"Inherited from: BaseRendererElement
protected object CurrParent { get; }GridBaseDirectiveParent
Section titled "GridBaseDirectiveParent"[CascadingParameter(Name = "GridBaseDirectiveParent")]
protected BaseRendererControl GridBaseDirectiveParent { get; set; }HierarchicalGridParent
Section titled "HierarchicalGridParent"[CascadingParameter(Name = "HierarchicalGridParent")]
protected BaseRendererControl HierarchicalGridParent { get; set; }public override string Type { get; }Accessors
Section titled "Accessors"_name
Section titled "_name"Inherited from: BaseRendererElement
protected string _nameeventCallbacksCache
Section titled "eventCallbacksCache"Inherited from: BaseRendererElement
protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache_cachedSerializedContent
Section titled "_cachedSerializedContent"Inherited from: BaseRendererElement
protected string _cachedSerializedContentMethods
Section titled "Methods"SetNativeElementAsync(object)
Section titled "SetNativeElementAsync(object)"Inherited from: IgbGridStateBaseDirective
public Task SetNativeElementAsync(object element)Parameters
- element:
object
Returns any
SetNativeElement(object)
Section titled "SetNativeElement(object)"Inherited from: IgbGridStateBaseDirective
public void SetNativeElement(object element)Parameters
- element:
object
Returns any
BuildRenderTree(RenderTreeBuilder)
Section titled "BuildRenderTree(RenderTreeBuilder)"Inherited from: BaseRendererElement
protected override void BuildRenderTree(RenderTreeBuilder builder)Parameters
- builder:
RenderTreeBuilder
Returns any
OnElementNameChanged(BaseRendererElement, string, string)
Section titled "OnElementNameChanged(BaseRendererElement, string, string)"Inherited from: BaseRendererElement
protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)Parameters
- element:
BaseRendererElement - oldName:
string - newName:
string
Returns any
InvokeMethod(string, object[], string[], ElementReference[])
Section titled "InvokeMethod(string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
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: BaseRendererElement
protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)Parameters
- methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelper(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])
Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"Inherited from: BaseRendererElement
protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)Parameters
- target:
string - methodName:
string - arguments:
object[] - types:
string[] - nativeElements:
ElementReference[]
Returns any
IsPropDirty(string)
Section titled "IsPropDirty(string)"Inherited from: BaseRendererElement
protected bool IsPropDirty(string propertyName)Parameters
- propertyName:
string
Returns any
Serialize(SerializationContext, string)
Section titled "Serialize(SerializationContext, string)"Inherited from: BaseRendererElement
public void Serialize(SerializationContext context, string propertyName = null)Parameters
- context:
SerializationContext - propertyName:
string
Returns any
Serialize()
Section titled "Serialize()"Inherited from: BaseRendererElement
public string Serialize()Returns any
EnsureValid()
Section titled "EnsureValid()"Inherited from: BaseRendererElement
protected void EnsureValid()Returns any
FromEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
ToEventJson(BaseRendererControl, Dictionary<string, object>)
Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"Inherited from: BaseRendererElement
protected virtual void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)Parameters
- control:
BaseRendererControl - args:
Dictionary
Returns any
SetResourceStringAsync(string, string, string)
Section titled "SetResourceStringAsync(string, string, string)"Inherited from: BaseRendererElement
protected 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: BaseRendererElement
protected Task<object> SetResourceStringAsync(string grouping, string json)Parameters
- grouping:
string - json:
string
Returns any
ApplyState(IgbGridStateInfo, string[])
Section titled "ApplyState(IgbGridStateInfo, string[])"public void ApplyState(IgbGridStateInfo state, string[] features = null)Parameters
- state:
IgbGridStateInfo - features:
string[]
Returns any
ApplyStateAsync(IgbGridStateInfo, string[])
Section titled "ApplyStateAsync(IgbGridStateInfo, string[])"public Task ApplyStateAsync(IgbGridStateInfo state, string[] features = null)Parameters
- state:
IgbGridStateInfo - features:
string[]
Returns any
ApplyStateFromString(string, string[])
Section titled "ApplyStateFromString(string, string[])"public void ApplyStateFromString(string state, string[] features = null)Parameters
- state:
string - features:
string[]
Returns any
ApplyStateFromStringAsync(string, string[])
Section titled "ApplyStateFromStringAsync(string, string[])"public Task ApplyStateFromStringAsync(string state, string[] features = null)Parameters
- state:
string - features:
string[]
Returns any
Dispose()
Section titled "Dispose()"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
GetState(string[])
Section titled "GetState(string[])"public IgbGridStateInfo GetState(string[] features = null)Parameters
- features:
string[]
Returns any
GetStateAsString(string[])
Section titled "GetStateAsString(string[])"public string GetStateAsString(string[] features = null)Parameters
- features:
string[]
Returns any
GetStateAsStringAsync(string[])
Section titled "GetStateAsStringAsync(string[])"public Task<string> GetStateAsStringAsync(string[] features = null)Parameters
- features:
string[]
Returns any
GetStateAsync(string[])
Section titled "GetStateAsync(string[])"public Task<IgbGridStateInfo> GetStateAsync(string[] features = null)Parameters
- features:
string[]
Returns any
OnInitializedAsync()
Section titled "OnInitializedAsync()"protected override Task OnInitializedAsync()Returns any
Events
Section titled "Events"StateParsed
Section titled "StateParsed"[Parameter]
public EventCallback<IgbGridStateInfoEventArgs> StateParsed { get; set; }StateParsedScript
Section titled "StateParsedScript"[Parameter]
public string StateParsedScript { get; set; }