Class GridMenuConfigurationModel

MOdel for storing menu function information of a grid view

Inheritance

System.Object

GridMenuConfigurationModel

Namespace: Simplic.Framework.DBUI

Assembly: Simplic.Framework.DBUI.dll

Syntax

public class GridMenuConfigurationModel : UI.MVC.ViewModelBase

Constructors

GridMenuConfigurationModel()

Create menu model and initialize default values

Declaration

public GridMenuConfigurationModel()

Properties

AddToContextMenu

Defines whether to add the menu entry to the context menu

Declaration

[Display(GroupName = "Allgemein", Name = "Im Ribbonmenü anzeigen")]
public bool AddToContextMenu { get; set; }

Property Value

Type	Description
System.Boolean

ClrClass

name of the class which contains the method to execute

Declaration

[Display(GroupName = "Clr/.Net", Name = "Klasse")]
public string ClrClass { get; set; }

Property Value

Type	Description
System.String

ClrMethod

Name of a static method in the ClrClass to execute

Declaration

[Display(GroupName = "Clr/.Net", Name = "Statische Methode")]
public string ClrMethod { get; set; }

Property Value

Type	Description
System.String

ClrNamespace

Namespace path to the ClrClass which contains a method to execute

Declaration

[Display(GroupName = "Clr/.Net", Name = "Namespace")]
public string ClrNamespace { get; set; }

Property Value

Type	Description
System.String

DisplayIndex

Sort the menu entries ascending by it's order number

Declaration

[Display(GroupName = "Allgemein", Name = "Index/Reihenfolge")]
public int DisplayIndex { get; set; }

Property Value

Type	Description
System.Int32

DisplayName

Display name of the menu entry

Declaration

[Display(GroupName = "Allgemein", Name = "Anzeigename")]
public string DisplayName { get; set; }

Property Value

Type	Description
System.String

ExecuteOnDoubleClick

If set to true, this function will be called after a double click on a row was performed

Declaration

[Display(GroupName = "Maus/Tastatur", Name = "Mit Doppelklick ausführen")]
public bool ExecuteOnDoubleClick { get; set; }

Property Value

Type	Description
System.Boolean

Id

Unique id of the menu function

Declaration

[Browsable(false)]
public Guid Id { get; set; }

Property Value

Type	Description
System.Guid

IsCustomMenuEntry

If set to true, this entry will not be deleted when it does not exists any more

Declaration

[Display(GroupName = "Allgemein", Name = "Kundenindividueller Eintrag", Description = "Wird im Updatefall nicht gelöscht.")]
public bool IsCustomMenuEntry { get; set; }

Property Value

Type	Description
System.Boolean

IsGridColumnBased

Gets or sets whether the menu entry is generated by a specific columns

Declaration

[Display(GroupName = "Allgemein", Name = "Generierter Menüeintrag", Description = "Gibt an, ob der Menüeintrag auf der Basis von vorhandenen Spaltenwerten mehrfach angezeigt werden soll.")]
public bool IsGridColumnBased { get; set; }

Property Value

Type	Description
System.Boolean

IsRowBased

Menu functions with IsRowBased = True can only be used, if a row is selected

Declaration

[Display(GroupName = "Allgemein", Name = "Zeilenbasiert")]
public bool IsRowBased { get; set; }

Property Value

Type	Description
System.Boolean

KeyCode1

First key which must be pressed or hit for executing this menu function

Declaration

[Display(GroupName = "Maus/Tastatur", Name = "Taste 1")]
public Key KeyCode1 { get; set; }

Property Value

Type	Description
System.Windows.Input.Key

KeyCode2

Second key which must be pressed or hit for executing this menu function

Declaration

[Display(GroupName = "Maus/Tastatur", Name = "Taste 2")]
public Key KeyCode2 { get; set; }

Property Value

Type	Description
System.Windows.Input.Key

KeyCode3

Third key which must be pressed or hit for executing this menu function

Declaration

[Display(GroupName = "Maus/Tastatur", Name = "Taste 3")]
public Key KeyCode3 { get; set; }

Property Value

Type	Description
System.Windows.Input.Key

LargeIconGuid

Guid for loading the large icon for the ribbon menu

Declaration

[Display(GroupName = "Design", Name = "Großes Symbol")]
public Guid? LargeIconGuid { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

NamedEvent

Named event for using methhods which must be called in the same instance as the grid is embedded in (class instance)

Declaration

[Display(GroupName = "Clr/.Net", Name = "Benanntes Event")]
public string NamedEvent { get; set; }

Property Value

Type	Description
System.String

NameParameterName

Gets or sets the name of the parameter name

Declaration

[Display(GroupName = "Skript/CLR", Name = "Name-Parameter Name")]
public string NameParameterName { get; set; }

Property Value

Type	Description
System.String

ParentMenuEntry

Declaration

[Display(GroupName = "Allgemein", Name = "Übergeordneter Eintrag", Description = "Gibt einen übergeordneten Menüeintrag an.")]
public GridMenuConfigurationModel ParentMenuEntry { get; set; }

Property Value

Type	Description
GridMenuConfigurationModel

PrintReport

True if a report should be printed directly

Declaration

[Display(GroupName = "Reporting", Name = "Direkt drucken")]
public bool PrintReport { get; set; }

Property Value

Type	Description
System.Boolean

QuickReportName

Name des Quick-Reports der aufgerufen werden soll

Declaration

[Display(GroupName = "Reporting", Name = "Quickreport")]
public string QuickReportName { get; set; }

Property Value

Type	Description
System.String

ReportViewerType

Report viewer type

Declaration

[Display(GroupName = "Reporting", Name = "Report-Aktion")]
public OpenReportViewerType ReportViewerType { get; set; }

Property Value

Type	Description
OpenReportViewerType

RibbonIconSize

Size of the ribbon menu entry

Declaration

[Display(GroupName = "Design", Name = "Ribbonknopfgröße")]
public ButtonSize RibbonIconSize { get; set; }

Property Value

Type	Description
ButtonSize

RightGuid

Guid controlling user access to the function

Declaration

[Browsable(false)]
public Guid RightGuid { get; set; }

Property Value

Type	Description
System.Guid

ScriptClass

Class to use when executing a menu function

Declaration

[Display(GroupName = "Skript", Name = "Skriptklasse")]
public string ScriptClass { get; set; }

Property Value

Type	Description
System.String

ScriptMethod

Method to execute when using a menu function

Declaration

[Display(GroupName = "Skript", Name = "Skriptmethode")]
public string ScriptMethod { get; set; }

Property Value

Type	Description
System.String

ScriptName

Script to execute when using the menu

Declaration

[Display(GroupName = "Skript", Name = "Skriptname")]
public string ScriptName { get; set; }

Property Value

Type	Description
System.String

SmallIconGuid

Guid for loading the small icon for the ribbon menu and the context menu

Declaration

[Display(GroupName = "Design", Name = "Kleines Symbol")]
public Guid? SmallIconGuid { get; set; }

Property Value

Type	Description
System.Nullable<System.Guid>

ValueParameterName

Gets or sets the name of the value parameter

Declaration

[Display(GroupName = "Skript/CLR", Name = "Wert-Parameter Name")]
public string ValueParameterName { get; set; }

Property Value

Type	Description
System.String

VisibilityExpression

Declaration

[Display(GroupName = "Design", Name = "Sichtbarkeit-Expression", Description = "Gibt eine Expression an die festlegt, ob ein Menüeintrag sichtbar ist. <column-name> == \"<value>\"")]
public string VisibilityExpression { get; set; }

Property Value

Type	Description
System.String

Methods

GenerateMenuEntries()

Generate a list of menu entries, if IsGridColumnBased is true

Declaration

public IList<GridMenuConfigurationModel> GenerateMenuEntries()

Returns

Type	Description
System.Collections.Generic.IList<GridMenuConfigurationModel>	List of menu entries

GetDeepCopy()

Create a deep copy of the current model and generate new id's

Declaration

public GridMenuConfigurationModel GetDeepCopy()

Returns

Type	Description
GridMenuConfigurationModel	Copy of the current obejct/instance

GetDeepCopyNewId()

Create a deep copy of the current model and generate new id's

Declaration

public GridMenuConfigurationModel GetDeepCopyNewId()

Returns

Type	Description
GridMenuConfigurationModel	Copy of the current obejct/instance