Class PropertyEditor
A property to be added to a PanelEditor.
Namespace: Evergine.Editor.Extension
Assembly: Evergine.Editor.Extension.dll
Syntax
public abstract class PropertyEditor
Fields
propertyPanelContainer
The properties container for this property instance.
Declaration
protected IPanelPropertyContainer propertyPanelContainer
Field Value
Type | Description |
---|---|
IPanelPropertyContainer |
Properties
Converter
Gets or sets the property value converter.
Declaration
public IConverter Converter { get; set; }
Property Value
Type | Description |
---|---|
IConverter |
DefaultValue
Gets or sets the default value.
Declaration
public object DefaultValue { get; set; }
Property Value
Type | Description |
---|---|
object |
Id
Gets or sets the property ID.
Declaration
public string Id { get; set; }
Property Value
Type | Description |
---|---|
string |
Instance
Gets the instance associated with this property.
Declaration
public object Instance { get; }
Property Value
Type | Description |
---|---|
object |
Member
Gets the member of this property.
Declaration
public MemberInfo Member { get; }
Property Value
Type | Description |
---|---|
MemberInfo |
Name
Gets or sets the property name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
Tooltip
Gets or sets the property's tooltip.
Declaration
public string Tooltip { get; set; }
Property Value
Type | Description |
---|---|
string |
Methods
GenerateUI()
Generates the UI for this panel.
Declaration
public abstract void GenerateUI()
InnerLoad()
Internal method to be overridden by the framework.
Declaration
protected virtual void InnerLoad()
IsVisible()
Calculates if this instance will be shown in the panel.
Declaration
public virtual bool IsVisible()
Returns
Type | Description |
---|---|
bool | A value indicating whether this property will not be shown. |
Load(IPanelPropertyContainer, object, MemberInfo)
Initializes this instance with the parameter.
Declaration
public void Load(IPanelPropertyContainer propertyPanelContainer, object instance, MemberInfo member)
Parameters
Type | Name | Description |
---|---|---|
IPanelPropertyContainer | propertyPanelContainer | The property panel container of this property editor. |
object | instance | The instance associated with this panel. |
MemberInfo | member | The member of this property editor. |
Loaded()
Occurs when this instance is ready to be generated.
Declaration
protected virtual void Loaded()
TryGetAttribute<TAttribute>(out TAttribute)
Try to get the member attribute.
Declaration
protected bool TryGetAttribute<TAttribute>(out TAttribute attribute) where TAttribute : Attribute
Parameters
Type | Name | Description |
---|---|---|
TAttribute | attribute | The member attribute. |
Returns
Type | Description |
---|---|
bool |
|
Type Parameters
Name | Description |
---|---|
TAttribute | The type of the member attribute. |