Class IgbDefinitionBase

Base class for various definition types for the grid.

Inheritance

System.Object

BaseRendererElement

IgbDefinitionBase

IgbColumnMovingSeparator

IgbColumnResizingSeparator

IgbDataGridColumn

IgbEditorDefinition

IgbEditRowDefinition

IgbFilterRowDefinition

IgbHeader

IgbHeaderRowSeparator

IgbHeaderSeparator

IgbPinnedAreaSeparator

IgbRowSeparator

IgbSectionFooter

IgbSectionHeader

IgbSummaryRow

Implements

JsonSerializable

Inherited Members

BaseRendererElement._name

BaseRendererElement.eventCallbacksCache

BaseRendererElement._cachedSerializedContent

BaseRendererElement.EnsureModulesLoaded()

BaseRendererElement.BuildRenderTree(RenderTreeBuilder)

BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)

BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])

BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])

BaseRendererElement.IsPropDirty(String)

BaseRendererElement.Serialize(SerializationContext, String)

BaseRendererElement.Serialize()

BaseRendererElement.EnsureValid()

BaseRendererElement.FromEventJson(BaseRendererControl, Dictionary<String, Object>)

BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)

BaseRendererElement.SetResourceStringAsync(String, String, String)

BaseRendererElement.SetResourceStringAsync(String, String)

BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)

BaseRendererElement.IgBlazor

BaseRendererElement.IsComponentRooted

BaseRendererElement.UseDirectRender

BaseRendererElement.ChildContent

BaseRendererElement.SupportsVisualChildren

BaseRendererElement.Name

BaseRendererElement.Parent

BaseRendererElement.MethodTarget

BaseRendererElement.CurrParent

Namespace: IgniteUI.Blazor.Controls

Assembly: IgniteUI.Blazor.dll

Syntax

public class IgbDefinitionBase : BaseRendererElement, JsonSerializable

Constructors

IgbDefinitionBase()

Declaration

public IgbDefinitionBase()

Properties

ActivationBorder

Gets or sets the background color to use.

Declaration

public string ActivationBorder { get; set; }

Property Value

Type	Description
System.String

ActivationBorderBottomWidth

Gets or sets the amount of bottom activation border to use for the cell content of this column.

Declaration

public int ActivationBorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationBorderLeftWidth

Gets or sets the amount of left activation border to use for the cell content for this column.

Declaration

public int ActivationBorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationBorderRightWidth

Gets or sets the amount of right activation border to use for the cell content of this column.

Declaration

public int ActivationBorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

ActivationBorderTopWidth

Gets or sets the amount of top activation border to use for the cell content for this column.

Declaration

public int ActivationBorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

ActualActivationBorder

Gets the actual background color that will be used.

Declaration

public string ActualActivationBorder { get; set; }

Property Value

Type	Description
System.String

ActualBackground

Gets the actual background color that will be used.

Declaration

public string ActualBackground { get; set; }

Property Value

Type	Description
System.String

ActualBarBackground

Declaration

public string ActualBarBackground { get; set; }

Property Value

Type	Description
System.String

ActualBarCornerRadius

Declaration

public int ActualBarCornerRadius { get; set; }

Property Value

Type	Description
System.Int32

ActualBarOutline

Declaration

public string ActualBarOutline { get; set; }

Property Value

Type	Description
System.String

ActualBarStrokeThickness

Declaration

public int ActualBarStrokeThickness { get; set; }

Property Value

Type	Description
System.Int32

ActualBorder

Gets the actual border color that will be used.

Declaration

public string ActualBorder { get; set; }

Property Value

Type	Description
System.String

ActualConditionalStyles

Declaration

public IgbGridConditionalStyleCollection ActualConditionalStyles { get; }

Property Value

Type	Description
IgbGridConditionalStyleCollection

ActualErrorBorder

Gets the actual error border color that will be used.

Declaration

public string ActualErrorBorder { get; set; }

Property Value

Type	Description
System.String

ActualLastStickyRowBackground

Gets the actual color for the last row in the sticky row area.

Declaration

public string ActualLastStickyRowBackground { get; set; }

Property Value

Type	Description
System.String

ActualLineBreakMode

Gets the actual line break mode which will be used if text is present in the cell.

Declaration

public TextCellLineBreakMode ActualLineBreakMode { get; set; }

Property Value

Type	Description
TextCellLineBreakMode

ActualPinnedRowBackground

Gets the actual background color for cells belonging to rows marked as pinned.

Declaration

public string ActualPinnedRowBackground { get; set; }

Property Value

Type	Description
System.String

ActualPinnedRowOpacity

Gets or sets the color to use for displaying text.

Declaration

public double ActualPinnedRowOpacity { get; set; }

Property Value

Type	Description
System.Double

ActualStickyRowBackground

Gets the actual background color for content that sticks to the top of the grid.

Declaration

public string ActualStickyRowBackground { get; set; }

Property Value

Type	Description
System.String

ActualTextColor

Gets the actual color used for displaying text.

Declaration

public string ActualTextColor { get; set; }

Property Value

Type	Description
System.String

Background

Gets or sets the background color to use.

Declaration

public string Background { get; set; }

Property Value

Type	Description
System.String

BarBackground

Declaration

public string BarBackground { get; set; }

Property Value

Type	Description
System.String

BarCornerRadius

Declaration

public int BarCornerRadius { get; set; }

Property Value

Type	Description
System.Int32

BarOutline

Declaration

public string BarOutline { get; set; }

Property Value

Type	Description
System.String

BarStrokeThickness

Declaration

public int BarStrokeThickness { get; set; }

Property Value

Type	Description
System.Int32

Border

Gets or sets the background color to use.

Declaration

public string Border { get; set; }

Property Value

Type	Description
System.String

BorderBottomWidth

Gets or sets the amount of bottom border to use for the cell content of this column.

Declaration

public int BorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

BorderLeftWidth

Gets or sets the amount of left border to use for the cell content for this column.

Declaration

public int BorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

BorderRightWidth

Gets or sets the amount of right border to use for the cell content of this column.

Declaration

public int BorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

BorderTopWidth

Gets or sets the amount of top border to use for the cell content for this column.

Declaration

public int BorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

CellStyleKeyRequested

Declaration

public Action<IgbCellStyleRequestedEventArgs> CellStyleKeyRequested { get; set; }

Property Value

Type	Description
System.Action<IgbCellStyleRequestedEventArgs>

CellStyleKeyRequestedScript

Declaration

public string CellStyleKeyRequestedScript { get; set; }

Property Value

Type	Description
System.String

ConditionalStyles

Declaration

public IgbGridConditionalStyleCollection ConditionalStyles { get; protected set; }

Property Value

Type	Description
IgbGridConditionalStyleCollection

ContentConditionalStyles

Declaration

public IgbGridConditionalStyleCollection ContentConditionalStyles { get; }

Property Value

Type	Description
IgbGridConditionalStyleCollection

ContentOpacity

Gets or sets the opacity of the content.

Declaration

public double ContentOpacity { get; set; }

Property Value

Type	Description
System.Double

DataBinding

Declaration

public Action<IgbDataBindingEventArgs> DataBinding { get; set; }

Property Value

Type	Description
System.Action<IgbDataBindingEventArgs>

DataBindingScript

Declaration

public string DataBindingScript { get; set; }

Property Value

Type	Description
System.String

DataBound

Declaration

public Action<IgbDataBindingEventArgs> DataBound { get; set; }

Property Value

Type	Description
System.Action<IgbDataBindingEventArgs>

DataBoundScript

Declaration

public string DataBoundScript { get; set; }

Property Value

Type	Description
System.String

ErrorBorder

Gets or sets the error border color to use.

Declaration

public string ErrorBorder { get; set; }

Property Value

Type	Description
System.String

ErrorBorderBottomWidth

Declaration

public int ErrorBorderBottomWidth { get; set; }

Property Value

Type	Description
System.Int32

ErrorBorderLeftWidth

Declaration

public int ErrorBorderLeftWidth { get; set; }

Property Value

Type	Description
System.Int32

ErrorBorderRightWidth

Declaration

public int ErrorBorderRightWidth { get; set; }

Property Value

Type	Description
System.Int32

ErrorBorderTopWidth

Declaration

public int ErrorBorderTopWidth { get; set; }

Property Value

Type	Description
System.Int32

FontFamily

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String

FontSize

Declaration

public double FontSize { get; set; }

Property Value

Type	Description
System.Double

FontStyle

Declaration

public string FontStyle { get; set; }

Property Value

Type	Description
System.String

FontWeight

Declaration

public string FontWeight { get; set; }

Property Value

Type	Description
System.String

HorizontalAlignment

Gets or sets the horizontal alignment to use for the cell content.

Declaration

public CellContentHorizontalAlignment HorizontalAlignment { get; set; }

Property Value

Type	Description
CellContentHorizontalAlignment

IsBarSupported

Declaration

public bool IsBarSupported { get; set; }

Property Value

Type	Description
System.Boolean

LastStickyRowBackground

Gets or sets the color for the last row in the sticky row area.

Declaration

public string LastStickyRowBackground { get; set; }

Property Value

Type	Description
System.String

LineBreakMode

Gets or sets the line breaking mode to use if text is present in the cell.

Declaration

public TextCellLineBreakMode LineBreakMode { get; set; }

Property Value

Type	Description
TextCellLineBreakMode

ParentTypeName

Declaration

protected override string ParentTypeName { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.ParentTypeName

PinnedRowBackground

Gets or sets the background color for cells belonging to rows marked as pinned.

Declaration

public string PinnedRowBackground { get; set; }

Property Value

Type	Description
System.String

PinnedRowOpacity

Gets or sets the color to use for displaying text.

Declaration

public double PinnedRowOpacity { get; set; }

Property Value

Type	Description
System.Double

StickyRowBackground

Gets or sets the background color for content that sticks to the top of the grid.

Declaration

public string StickyRowBackground { get; set; }

Property Value

Type	Description
System.String

TextColor

Gets or sets the color to use for displaying text.

Declaration

public string TextColor { get; set; }

Property Value

Type	Description
System.String

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.Type

VerticalAlignment

Gets or sets the vertical alignment to use for the cell content.

Declaration

public CellContentVerticalAlignment VerticalAlignment { get; set; }

Property Value

Type	Description
CellContentVerticalAlignment

Methods

FindByName(String)

Declaration

public override object FindByName(string name)

Parameters

Type	Name	Description
System.String	name

Returns

Type	Description
System.Object

Overrides

BaseRendererElement.FindByName(String)

GetNamedValue(String)

Declaration

public object GetNamedValue(string valueName)

Parameters

Type	Name	Description
System.String	valueName

Returns

Type	Description
System.Object

GetNamedValueAsync(String)

Gets the value for a named value from this definition.

Declaration

public Task<object> GetNamedValueAsync(string valueName)

Parameters

Type	Name	Description
System.String	valueName	The named value name to check for.

Returns

Type	Description
System.Threading.Tasks.Task<System.Object>

HasNamedValue(String)

Declaration

public bool HasNamedValue(string valueName)

Parameters

Type	Name	Description
System.String	valueName

Returns

Type	Description
System.Boolean

HasNamedValueAsync(String)

Returns if this definition has a named value with a given name.

Declaration

public Task<bool> HasNamedValueAsync(string valueName)

Parameters

Type	Name	Description
System.String	valueName	The named value name to check for.

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

HasNamedValues()

Declaration

public bool HasNamedValues()

Returns

Type	Description
System.Boolean

HasNamedValuesAsync()

Returns if this definition has named value.

Declaration

public Task<bool> HasNamedValuesAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

IsStyleTransitioningOut(IgbGridConditionalStyle)

Declaration

public bool IsStyleTransitioningOut(IgbGridConditionalStyle style)

Parameters

Type	Name	Description
IgbGridConditionalStyle	style

Returns

Type	Description
System.Boolean

IsStyleTransitioningOutAsync(IgbGridConditionalStyle)

Declaration

public Task<bool> IsStyleTransitioningOutAsync(IgbGridConditionalStyle style)

Parameters

Type	Name	Description
IgbGridConditionalStyle	style

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

RemoveNamedValue(String)

Declaration

public void RemoveNamedValue(string valueName)

Parameters

Type	Name	Description
System.String	valueName

RemoveNamedValueAsync(String)

Removes the named value from this definition by name.

Declaration

public Task RemoveNamedValueAsync(string valueName)

Parameters

Type	Name	Description
System.String	valueName	The named value name to remove.

Returns

Type	Description
System.Threading.Tasks.Task

SetNamedValue(String, CellPropertyAnimationType, Object)

Declaration

public void SetNamedValue(string valueName, CellPropertyAnimationType animationType, object value)

Parameters

Type	Name	Description
System.String	valueName
CellPropertyAnimationType	animationType
System.Object	value

SetNamedValueAsync(String, CellPropertyAnimationType, Object)

Declaration

public Task SetNamedValueAsync(string valueName, CellPropertyAnimationType animationType, object value)

Parameters

Type	Name	Description
System.String	valueName
CellPropertyAnimationType	animationType
System.Object	value

Returns

Type	Description
System.Threading.Tasks.Task

TransitionStyleIn(IgbGridConditionalStyle)

Declaration

public void TransitionStyleIn(IgbGridConditionalStyle style)

Parameters

Type	Name	Description
IgbGridConditionalStyle	style

TransitionStyleInAsync(IgbGridConditionalStyle)

Declaration

public Task TransitionStyleInAsync(IgbGridConditionalStyle style)

Parameters

Type	Name	Description
IgbGridConditionalStyle	style

Returns

Type	Description
System.Threading.Tasks.Task

TransitionStyleOut(IgbGridConditionalStyle)

Declaration

public void TransitionStyleOut(IgbGridConditionalStyle style)

Parameters

Type	Name	Description
IgbGridConditionalStyle	style

TransitionStyleOutAsync(IgbGridConditionalStyle)

Declaration

public Task TransitionStyleOutAsync(IgbGridConditionalStyle style)

Parameters

Type	Name	Description
IgbGridConditionalStyle	style

Returns

Type	Description
System.Threading.Tasks.Task

Implements

JsonSerializable