Class ButtonViewParams

The parameters for the IButtonView/ButtonController which determine which command the view should provide access to and its associated parameters

The ButtonSerializedParamController is responsible for the UI param popup for editing these parameters

Inheritance
object
SerializedParam
ViewSerializedParam
ButtonViewParams
Implements
Inherited Members
Namespace: LemonEdge.Client.Core.Views
Assembly: LemonEdge.ClientCore.dll
Syntax
[DataContract]
public class ButtonViewParams : ViewSerializedParam, ICloneable, ICloneable<ViewSerializedParam>, ICloneable<ButtonViewParams>, INotifyPropertyChanged

Constructors

ButtonViewParams()

Declaration
public ButtonViewParams()

Properties

ButtonID

The actual globally unique id for this button.

Standard ones come from the Command enum

Custom ones have their own unique id provided from the CommandDescriptorOptionsAttribute
Declaration
public Guid ButtonID { get; set; }
Property Value
Type Description
Guid

ButtonIconID

The globally unique id of the icon to use for this button

Standard ones come from ImageType enum

Custom ones come from ImageID
Declaration
public Guid ButtonIconID { get; set; }
Property Value
Type Description
Guid

ButtonName

The user friendly name for this button

Declaration
public string ButtonName { get; set; }
Property Value
Type Description
string

ButtonParams

The custom parameters for this command button

Must inherit from CommandSerializedParam

Declaration
public string ButtonParams { get; set; }
Property Value
Type Description
string

ButtonTooltip

The tool tip for this button

Declaration
public string ButtonTooltip { get; set; }
Property Value
Type Description
string

Methods

Clone()

Creates a new instance of this class (of type ButtonViewParams) with all the same property values as this instance

Declaration
public ButtonViewParams Clone()
Returns
Type Description
ButtonViewParams

A new instance of this class with all the same property values as this instance

CopyFromParam(SerializedParam)

Should be overridden by inheriting implementations to ensure all parameters values are copied from the specified source

Declaration
protected override void CopyFromParam(SerializedParam source)
Parameters
Type Name Description
SerializedParam source

The source instance of a SerializedParam that is of the same type as this one to copy parameter values from
Overrides
Remarks

Used by the generic implementation of Clone()

CopyFromSource(ButtonViewParams)

Updates all properties in this item to have the same properties as the source object.

Declaration
public void CopyFromSource(ButtonViewParams source)
Parameters
Type Name Description
ButtonViewParams source

The source object to copy all values from.

CreateNewParam()

Must be implemented by inheriting classes to provide a new instance of the current class type.

Used when cloning this SerializedParam to create a new instance of the same type

Declaration
protected override SerializedParam CreateNewParam()
Returns
Type Description
SerializedParam

A new instance of the current SerializedParam type
Overrides

Implements

Extension Methods