Class SerializedComponentData

Base class for serialized component data used in UI elements.

Inheritance

object

SerializedComponentData

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Serenity.Ui.Domain.Entities

Assembly: Serenity.Ui.Domain.dll

Syntax

public abstract class SerializedComponentData

Constructors

SerializedComponentData()

Initializes a new instance of the SerializedComponentData class.

Declaration

protected SerializedComponentData()

SerializedComponentData(string, string, string, int, UiComponentAlignmentType, bool, bool, IEnumerable<EventDispatcherSignal>)

Initializes a new instance of the SerializedComponentData class with the specified parameters.

Declaration

protected SerializedComponentData(string id, string guid, string label, int index, UiComponentAlignmentType alignment, bool isTranslatingLabel, bool isTranslatingValue, IEnumerable<EventDispatcherSignal> onSubmitSignals = null)

Parameters

Type	Name	Description
string	id	The unique identifier of the component.
string	guid	The globally unique identifier of the component.
string	label	The display label of the component.
int	index	The index of the component in a collection.
UiComponentAlignmentType	alignment	The alignment type of the component.
bool	isTranslatingLabel	Whether the label is being translated.
bool	isTranslatingValue	Whether the value is being translated.
IEnumerable<EventDispatcherSignal>	onSubmitSignals	The collection of signals to be dispatched on component submission.

Fields

Alignment

Declaration

public UiComponentAlignmentType Alignment

Field Value

Type	Description
UiComponentAlignmentType	The alignment type of the component.

Guid

Declaration

public string Guid

Field Value

Type	Description
string	The globally unique identifier of the component.

Id

Declaration

public string Id

Field Value

Type	Description
string	The unique identifier of the component.

Index

Declaration

public int Index

Field Value

Type	Description
int	The index of the component in a collection.

IsTranslatingLabel

Declaration

public bool IsTranslatingLabel

Field Value

Type	Description
bool	Whether the label is being translated.

IsTranslatingValue

Declaration

public bool IsTranslatingValue

Field Value

Type	Description
bool	Whether the value is being translated.

Label

Declaration

public string Label

Field Value

Type	Description
string	The display label of the component.

Properties

OnSubmitSignals

Read-only list of signals to be dispatched on component submission.

Declaration

public abstract IReadOnlyList<EventDispatcherSignal> OnSubmitSignals { get; }

Property Value

Type	Description
IReadOnlyList<EventDispatcherSignal>	A read-only list of signals to be dispatched on component submission.

Methods

ReplaceSignals(IEnumerable<EventDispatcherSignal>)

Replaces the current signals with the specified collection of signals.

Declaration

protected abstract void ReplaceSignals(IEnumerable<EventDispatcherSignal> signals)

Parameters

Type	Name	Description
IEnumerable<EventDispatcherSignal>	signals	The new collection of signals to set.